Skip to content

Add documentation to ExecuteCommand native#3291

Merged
prikolium-cfx merged 1 commit intocitizenfx:masterfrom
NotLazy:patch-1
Apr 7, 2025
Merged

Add documentation to ExecuteCommand native#3291
prikolium-cfx merged 1 commit intocitizenfx:masterfrom
NotLazy:patch-1

Conversation

@NotLazy
Copy link
Contributor

@NotLazy NotLazy commented Mar 26, 2025

Goal of this PR

The goal of this PR is to help anyone else that experiences the same issue I did, with being unable to use ExecuteCommand in my resource, without first adding an acl for the resource, and attempting to google the issue only told me how to add ACLs for players.

How is this PR achieving the goal

This PR is achieving that goal by adding documentation to the ExecuteCommand native, to include a simple pointer towards how to add an acl for a resource.

This PR applies to the following area(s)

Natives

Successfully tested on

Game builds: N/A

Platforms: N/A

Checklist

  • Code compiles and has been tested successfully. (N/A)
  • Code explains itself well and/or is documented. (N/A)
  • My commit message explains what the changes do and what they are for.
  • No extra compilation warnings are added by these changes.

Fixes issues

N/A

@github-actions github-actions bot added the invalid Requires changes before it's considered valid and can be (re)triaged label Mar 26, 2025
@github-actions github-actions bot added triage Needs a preliminary assessment to determine the urgency and required action and removed invalid Requires changes before it's considered valid and can be (re)triaged labels Mar 26, 2025
@Yum1x
Copy link
Contributor

Yum1x commented Mar 26, 2025

I checked the Register Command docs and they already cover that stuff. I think your PR might just be an oversight

@NotLazy
Copy link
Contributor Author

NotLazy commented Mar 26, 2025

I checked the Register Command docs and they already cover that stuff. I think your PR might just be an oversight

I disagree. Register Command does not mention ACLs for resources specifically. It only mentions players, and doesn't mention how to do it. It mentions that ExecuteCommand can be used to execute registered commands but again does not mention ACLs for resources.

If anything, what would be better than this PR would be having resources mentioned in the add_ace example section

Copy link
Collaborator

@prikolium-cfx prikolium-cfx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution

@prikolium-cfx prikolium-cfx added ready-to-merge This PR is enqueued for merging and removed triage Needs a preliminary assessment to determine the urgency and required action labels Apr 4, 2025
@prikolium-cfx prikolium-cfx merged commit 0361b8f into citizenfx:master Apr 7, 2025
6 checks passed
@NotLazy NotLazy deleted the patch-1 branch April 12, 2025 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready-to-merge This PR is enqueued for merging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants