From cc7c030e533318cf510611f45c2d17633bc7a1c0 Mon Sep 17 00:00:00 2001 From: WithLithum Date: Thu, 28 Dec 2023 21:01:06 +0800 Subject: [PATCH] Add proper description for IsEntityOnScreen (#964) * 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 <38232208+4mmonium@users.noreply.github.com> --- ENTITY/IsEntityOnScreen.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/ENTITY/IsEntityOnScreen.md b/ENTITY/IsEntityOnScreen.md index bddda3b3f..717d5ca0d 100644 --- a/ENTITY/IsEntityOnScreen.md +++ b/ENTITY/IsEntityOnScreen.md @@ -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`.