Player::getNearbyVehicles: Difference between revisions

From RAGE Multiplayer Wiki
(yay)
 
No edit summary
 
Line 1: Line 1:
Returns size of array, passed into the second variable.<br><br>See below for usage information.<br><br>This function actually requires a struct, where the first value is the maximum number of elements to return. Here is a sample of how I was able to get it to work correctly, without yet knowing the struct format.<br><br>//Setup the array<br> const int numElements = 10;<br> const int arrSize = numElements * 2 + 2;<br> Any veh[arrSize];<br> //0 index is the size of the array<br> veh[0] = numElements;<br><br> int count = Player::GET_Player_NEARBY_VEHICLES(PLAYER::PLAYER_Player_ID(), veh);<br><br> if (veh != NULL)<br> {<br> //Simple loop to go through results<br> for (int i = 0; i &lt; count; i++)<br> {<br> int offsettedID = i * 2 + 2;<br> //Make sure it exists<br> if (veh[offsettedID] != NULL &amp;&amp; ENTITY::DOES_ENTITY_EXIST(veh[offsettedID]))<br> {<br> //Do something<br> }<br> }<br> }
{{ClientsideJsFunction}}
{{JSContainer|
 
===Required Params===
*'''numVehicles:''' {{RageType|number}} — Maximum number of vehicles to return.
 
===Return value===
*'''{{RageType|Array<number>|null}}''' — Array of vehicle handles or null if none found.
 
==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">player.getNearbyVehicles(sizeAndVehs);</syntaxhighlight>
<syntaxhighlight lang="javascript">
=== Required Arguments ===
player.getNearbyVehicles(number numVehicles)
*'''sizeAndVehs:''' int
</syntaxhighlight>
===Return value===
 
*'''int'''
==Example==
==Example==
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
// todo
const vehicles = mp.players.local.getNearbyVehicles(10);
 
if (vehicles) {
    vehicles.forEach(handle => {
        mp.gui.chat.push(`Nearby vehicle handle: ${handle}`);
    });
}
</syntaxhighlight>
</syntaxhighlight>
}}
==See also==
==See also==
{{Player_function_c}}
{{Player_function_c}}
[[Category:Clientside API]]
[[Category:Clientside API]]
[[Category:TODO: Example]]
[[Category:Player]]

Latest revision as of 22:21, 26 December 2025

Client-Side
Function

 JavaScript



JavaScript Syntax


Required Params

  • numVehicles: number — Maximum number of vehicles to return.

Return value

  • 'Array<number>' — Array of vehicle handles or null if none found.

Syntax

player.getNearbyVehicles(number numVehicles)

Example

const vehicles = mp.players.local.getNearbyVehicles(10);

if (vehicles) {
    vehicles.forEach(handle => {
        mp.gui.chat.push(`Nearby vehicle handle: ${handle}`);
    });
}


See also

Retrieved from "https://wiki.rage.mp/w/index.php?title=Player::getNearbyVehicles&oldid=27509"