Player::getNearbyObjects

From RAGE Multiplayer Wiki

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