Player::getNearvyObjects: Difference between revisions

From RAGE Multiplayer Wiki
(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...")
 
(Replaced content with "{{delete}}")
Tag: Replaced
 
Line 1: Line 1:
{{ClientsideJsFunction}}
{{delete}}
{{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|number}}
*'''position''' — {{RageType|Vector3}}
*'''distance''' — {{RageType|number}}
 
==Syntax==
<syntaxhighlight lang="javascript">
player.getNearbyObjects(number numObjects, number maxDistance, boolean ignoreDamaged)
</syntaxhighlight>
 
==Example==
<syntaxhighlight lang="javascript">
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}`);
    });
}
</syntaxhighlight>
}}
 
==See also==
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:Player]]

Latest revision as of 22:16, 26 December 2025