Pool::atHandle

Function to get the entity with the given handle from his entity pool.

Syntax

Entity pool.atHandle(Number handle)

Required Arguments

• handle: Handle of the entity

Returns

• Entity Entity with specified handle, undefined if none exists.

Example

This example will get a player by handle and output his name on the chat.

Client-Side

function outputPlayerNameWithHandle(handle) {
    const player = mp.players.atHandle(handle);
    if (player) {
	mp.gui.chat.push(`Player with handle ${handle} is named ${player.name}.`);
    } else {
	mp.gui.chat.push(`Player with handle ${handle} 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