Pool::at: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
m (Replaced HTML with template)
Line 12: Line 12:
==Example==  
==Example==  
This example will return a player by ID and output his name in the console.
This example will return a player by ID and output his name in the console.
<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
{{ServersideCode|
<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
<pre>
<syntaxhighlight lang="javascript" highlight="1">
let player = mp.players.at(1488);
let player = mp.players.at(1488);
if (player) {
if (player) {
Line 21: Line 20:
console.log(`Player by id 1488 does not exists...`);
console.log(`Player by id 1488 does not exists...`);
};
};
</syntaxhighlight>
</pre>
</div>
}}


==See Also==
==See Also==
{{EntityPool_function}}
{{EntityPool_function}}

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