Pool::at

From RAGE Multiplayer Wiki
Revision as of 11:31, 10 November 2024 by Shr0x (talk | contribs)

Server-Side
Function

 JavaScript



JavaScript Syntax


Available Entity Pools

In RAGEMP serverside JavaScript, the following entity pools are used to manage different in-game elements:

  • mp.players — Manages all player entities.
  • mp.vehicles — Manages all vehicle entities.
  • mp.objects — Manages all world object entities.
  • mp.colshapes — Manages all collision shapes.
  • mp.markers — Manages all map markers.
  • mp.checkpoints — Manages all checkpoints.
  • mp.labels — Manages all text labels.
  • mp.blips — Manages all map blips.
  • mp.pickups — Manages item pickups in the world.

Summary

The `pool.at` function returns an entity from a specified pool by its ID. It is useful for accessing specific entities such as players, vehicles, or objects by their unique server-side ID.

Syntax

pool.at(id)

Return value

An entity with the selected ID from a pool, or `undefined` if no entity exists with that ID.

Required Arguments

  • id: Number — The ID of the element to retrieve from the pool.

Example

This example retrieves a player by ID and outputs their name to the console if they exist.

let player = mp.players.at(1488);
if (player) {
    console.log(`Player with ID 1488 has nickname ${player.name}`);
} else {
    console.log(`Player with ID 1488 does not exist...`);
}



See Also