Player::getNearvyObjects

From RAGE Multiplayer Wiki
Revision as of 22:16, 26 December 2025 by Shr0x (talk | contribs) (Created page with "{{ClientsideJsFunction}} {{JSContainer| ===Required Params=== *'''numObjects:''' {{RageType|number}} — Maximum number of objects to return. *'''maxDistance:''' {{RageType|number}} — Maximum search distance. *'''ignoreDamaged:''' {{RageType|boolean}} — Whether to ignore damaged objects. ===Return value=== *'''{{RageType|Array<NearbyObjectInfo>|null}}''' — Array of nearby objects or null if none found. ''NearbyObjectInfo contains:'' *'''model''' — {{RageType|n...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Client-Side
Function

 JavaScript



JavaScript Syntax


Required Params

  • numObjects: number — Maximum number of objects to return.
  • maxDistance: number — Maximum search distance.
  • ignoreDamaged: boolean — Whether to ignore damaged objects.

Return value

  • 'Array<NearbyObjectInfo>' — Array of nearby objects or null if none found.

NearbyObjectInfo contains:

  • modelnumber
  • positionVector3
  • distancenumber

Syntax

player.getNearbyObjects(number numObjects, number maxDistance, boolean ignoreDamaged)

Example

const objects = mp.players.local.getNearbyObjects(10, 20.0, true);

if (objects) {
    objects.forEach(obj => {
        mp.gui.chat.push(`Model: ${obj.model}, Distance: ${obj.distance}`);
    });
}


See also