Add proper description for IsEntityOnScreen #964
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
You need to add the ## Return value and specify what information is returning this native |
PsychoShock
reviewed
Dec 26, 2023
| @@ -8,13 +8,9 @@ ns: ENTITY | |||
| BOOL IS_ENTITY_ON_SCREEN(Entity entity); | |||
| ``` | |||
|
|
|||
| ``` | |||
| Returns true if the entity is in between the minimum and maximum values for the 2d screen coords. | |||
There was a problem hiding this comment.
This should be on the return value instead of deleting.
PsychoShock
suggested changes
Dec 27, 2023
ENTITY/IsEntityOnScreen.md
Outdated
|
|
||
| ## Return value | ||
|
|
||
| Returns `true` if the the entity is in between the minimum and maximum values for the 2d screen coord; otherwise, `false`. |
There was a problem hiding this comment.
Return value need to be after param. Please refer to https://github.com/citizenfx/natives/blob/master/.github/CONTRIBUTING.md
PsychoShock
approved these changes
Dec 27, 2023
There was a problem hiding this comment.
Look's good. Please squash it like this to make it cleaner..
Slight nitpick.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a properly formatted description for
IsEntityOnScreen.I do not consider an example would be needed for this native considering how simple is the native is, and the new description means about the same thing as of the old imported description.
Feel free to edit this PR if you think something is wrong.