Latest revision as of 12:12, 10 November 2024

Server-Side
Function

JavaScript

JavaScript Syntax

Available Entity Pools

The following are the main entity pools available on the RAGEMP, used for managing various game entities:

Entity Pool	Description
mp.players	Manages all connected players
mp.vehicles	Manages all spawned vehicles
mp.objects	Manages all created objects
mp.peds	Manages all non-player characters (peds)
mp.markers	Manages all markers in the game
mp.labels	Manages all 3D text labels
mp.checkpoints	Manages checkpoints
mp.blips	Manages map blips
mp.colshapes	Manages collision shapes

Syntax

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

Required Arguments

callingFunction: Function to be executed for each entity within range.

Example

This example collects all vehicles within 100 units of the player and stores them in an array.

Server-Side

let getVehiclesNearby = (player) => {
    const nearbyVehicles = [];
    mp.vehicles.forEachInRange(player.position, 100, (vehicle) => {
        nearbyVehicles.push(vehicle);
    });
    return nearbyVehicles;
};

let nearbyVehicles = getVehiclesNearby(mp.players.at(0));
console.log(`Vehicles nearby: ${nearbyVehicles.length}`);

Functions
- Pool::at
- Pool::exists
- Pool::forEach
- Pool::forEachFast
- Pool::forEachInRange
- Pool::forEachInDimension
- Pool::forEachInStreamRange // Clientside only
- Pool::toArray
- Pool::toArrayFast
- Pool::toArrayInRange
- Pool::toArrayInDimension
- Pool::apply
- Pool::getClosest
- Pool::getClosestInDimension
Properties
- Pool::length
- Pool::size
Arrays
- Pool::streamed

@@ Line 1: / Line 1: @@
-This function is used for calling a function for each element in a pool, but only if it in range of position.
+{{ServersideJsFunction}}
+{{JSContainer|
+{{Pool_list}}
 ==Syntax==
-<syntaxhighlight lang="javascript">
+<pre>
-void pool.forEachInRange(Vector3 position, int range [, int dimension], function callingFunction);
+pool.forEachInRange(Vector3 position, int range [, int dimension], function callingFunction);
-</syntaxhighlight>
+</pre>
 ===Required Arguments===
-*'''callingFunction:''' Function, what will be called.
+*'''callingFunction:''' Function to be executed for each entity within range.
-==Example #1==
+==Example==
-That's example will generate an array with vehicles within 100 units of the player (game distance, meters).
+This example collects all vehicles within 100 units of the player and stores them in an array.
-<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">
+let getVehiclesNearby = (player) => {
-let getVehiclesNearbyMe = (player) => {
+    const nearbyVehicles = [];
-	const returnVehicles = [];
+    mp.vehicles.forEachInRange(player.position, 100, (vehicle) => {
+        nearbyVehicles.push(vehicle);
-	mp.vehicles.forEachInRange(player.position, 100,
+    });
-		(vehicle) => {
+    return nearbyVehicles;
-			returnVehicles.push(vehicle);
-		}
-	);
-	return returnVehicles;
 };
-let vehiclesNearbyMe = getVehiclesNearbyMe(mp.players.at(0));
+let nearbyVehicles = getVehiclesNearby(mp.players.at(0));
-console.log(`Vehicles nearby me: x${vehiclesNearbyMe.length}`);
+console.log(`Vehicles nearby: ${nearbyVehicles.length}`);
-</syntaxhighlight>
+</pre>
-</div>
+}}
 ==See Also==
 {{EntityPool_function}}
+}}