Pool::at: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
Line 6: Line 6:
</syntaxhighlight>  
</syntaxhighlight>  
===Returns===
===Returns===
Return a entity with selected ID, from a pool. Or false, if entity with this ID not exists.
An entity with the selected ID from a pool, or false if entity with this ID does not exists.
 
===Required Arguments===
===Required Arguments===
*'''ID:''' Element ID, what you need get from the pool.
*'''ID:''' Element ID, what you need get from the pool.

Revision as of 03:32, 5 December 2017

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 false 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