Pool::forEachInRange: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
m (Replaced HTML with template)
Line 2: Line 2:


==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">
<pre>
pool.forEachInRange(Vector3 position, int range [, int dimension], function callingFunction);
pool.forEachInRange(Vector3 position, int range [, int dimension], function callingFunction);
</syntaxhighlight>
</pre>


===Required Arguments===
===Required Arguments===
Line 12: Line 12:
This example will generate an array of vehicles within 100 units of the player (game distance, meters).
This example will generate an array of vehicles within 100 units of the player (game distance, meters).


<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
{{ServersideCode|
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<pre>
<syntaxhighlight lang="javascript" highlight="4-8">
let getVehiclesNearbyMe = (player) => {
let getVehiclesNearbyMe = (player) => {
const returnVehicles = [];
const returnVehicles = [];
Line 29: Line 28:
let vehiclesNearbyMe = getVehiclesNearbyMe(mp.players.at(0));
let vehiclesNearbyMe = getVehiclesNearbyMe(mp.players.at(0));
console.log(`Vehicles nearby me: x${vehiclesNearbyMe.length}`);
console.log(`Vehicles nearby me: x${vehiclesNearbyMe.length}`);
</syntaxhighlight>
</pre>
</div>
}}


==See Also==
==See Also==
{{EntityPool_function}}
{{EntityPool_function}}

Revision as of 11:23, 26 October 2018

This function is used for calling a function for each element in a pool, but only if it in range of position.

Syntax

pool.forEachInRange(Vector3 position, int range [, int dimension], function callingFunction);

Required Arguments

  • callingFunction: Function, what will be called.

Example

This example will generate an array of vehicles within 100 units of the player (game distance, meters).

Server-Side
let getVehiclesNearbyMe = (player) => {
	const returnVehicles = [];
	
	mp.vehicles.forEachInRange(player.position, 100,
		(vehicle) => {
			returnVehicles.push(vehicle);
		}
	);
	
	return returnVehicles;
};

let vehiclesNearbyMe = getVehiclesNearbyMe(mp.players.at(0));
console.log(`Vehicles nearby me: x${vehiclesNearbyMe.length}`);

See Also