Skip to content

Commit

Permalink
Add proper description for IsEntityOnScreen (#964)
Browse files Browse the repository at this point in the history
* Add proper description for IsEntityOnScreen

* Add return value description for IsEntityOnScreen

* Update IsEntityOnScreen.md - style changes

* Update IsEntityOnScreen.md

Slight nitpick.

---------

Co-authored-by: ammonia-cfx <[email protected]>
  • Loading branch information
WithLithum and 4mmonium authored Dec 28, 2023
1 parent c30300e commit cc7c030
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions ENTITY/IsEntityOnScreen.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,12 @@ 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.
This means that it will return true even if the entity is behind a wall for example, as long as you're looking at their location.
Chipping
```
Determines whether the screen position of the specified entity is within the 2D bounds of the screen.
This native will not check if the entity is not visible due to being occluded (for example, behind a wall). To check if a entity is on screen and is not occluded, use [IS_ENTITY_OCCLUDED](#_0xE31C2C72B8692B64).
## Parameters
* **entity**:
* **entity**: The entity to check.
## Return value
Returns `true` if the the entity is in between the minimum and maximum values for the 2D screen bound coords; otherwise, `false`.

0 comments on commit cc7c030

Please sign in to comment.