Pool::atHandle: Difference between revisions

Latest revision as of 12:53, 4 January 2021

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.`);
    }
}

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 to return an element from a pool at an entity handle.
+Function to get the entity with the given handle from his entity pool.
 ==Syntax==
@@ Line 6: / Line 6: @@
 </pre>
 ===Required Arguments===
-*'''handle:''' You can get that for example using entity.handle function.
+*'''handle:''' Handle of the entity
 ===Returns===
-*{{RageType|Entity}}
+*{{RageType|Entity}} Entity with specified handle, '''undefined''' if none exists.
-*'''Note:''' If entity with selected handle does not exist, it will return '''undefined'''.
 ==Example==
-This example will return a player by '''handle''' and output his name on the chat.
+This example will get a player by '''handle''' and output his name on the chat.
 {{ClientsideCode|
 <pre>
-const player = mp.players.atHandle(mp.players.at(0).handle); // get handle of player with id 0
+function outputPlayerNameWithHandle(handle) {
-if (player) {
+    const player = mp.players.atHandle(handle);
-	mp.gui.chat.push(`Player with handle: ${localPlayerHandle} is named ${player.name}.`);
+    if (player) {
-} else {
+	mp.gui.chat.push(`Player with handle ${handle} is named ${player.name}.`);
-	mp.gui.chat.push(`Player with handle: ${localPlayerHandle} does not exist.`);
+    } else {
+	mp.gui.chat.push(`Player with handle ${handle} does not exist.`);
+    }
 }
 </pre>

Latest revision as of 12:53, 4 January 2021

Syntax

Required Arguments

Returns

Example

See Also