Pool::exists

Server-Side

Function

JavaScript

JavaScript Syntax

Available Entity Pools

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

• mp.players — Manages all connected players.
• mp.vehicles — Manages all spawned vehicles.
• mp.objects — Manages all created objects.
• 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.

Summary

The `mp.pool.exists` function checks if an entity with a specific ID exists within a pool. It returns `true` if the entity exists and `false` if it does not. This is helpful for ensuring an entity is valid before performing further operations.

Syntax

mp.pool.exists(id)

Return value

Returns `true` if the entity exists, `false` if it does not.

Required Arguments

• id/entity: Number — The entity ID or the entity itself to check in the pool.

Example

This example checks if a specific player with ID 1500 exists in the players pool, and if so, sends them a welcome message. If not, it logs that the player is not found.

const playerID = 1500;

if (mp.players.exists(playerID)) {
    const player = mp.players.at(playerID);
    player.outputChatBox(`Welcome back, ${player.name}!`);
} else {
    console.log(`Player with ID ${playerID} does not exist.`);
}

See Also

• 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