Pool::at: Difference between revisions

From RAGE Multiplayer Wiki
m (Replaced HTML with template)
mNo edit summary
Line 2: Line 2:


==Syntax==
==Syntax==
<syntaxhighlight lang="javascript">
<pre>
Entity pool.at(Number ID)
Entity pool.at(Number ID)
</syntaxhighlight>  
</pre>  
===Returns===
===Returns===
An entity with the selected ID from a pool, or undefined if entity with this ID does not exists.
An entity with the selected ID from a pool, or undefined if entity with this ID does not exists.

Revision as of 11:16, 26 October 2018

This function is used to return an element from a pool at an ID.

Syntax

Entity pool.at(Number ID)

Returns

An entity with the selected ID from a pool, or undefined if entity with this ID does not exists.

Required Arguments

  • ID: Element ID, what you need get from the pool.

Example

This example will return a player by ID and output his name in the console.

Server-Side
let player = mp.players.at(1488);
if (player) {
	console.log(`Player with id 1488 have nickname ${player.name}`);
} else {
	console.log(`Player by id 1488 does not exists...`);
};

See Also