Pool::atHandle: Difference between revisions
(Created page with "This function is used to return an element from a pool at an entity handle. ==Syntax== <pre> Entity pool.atHandle(Number handle) </pre> ===Required Arguments=== *'''handle:'...") |
(Improve a bit) |
||
| Line 1: | Line 1: | ||
Function to get the entity with the given handle from his entity pool. | |||
==Syntax== | ==Syntax== | ||
| Line 6: | Line 6: | ||
</pre> | </pre> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''handle:''' | *'''handle:''' Handle of the entity | ||
===Returns=== | ===Returns=== | ||
*{{RageType|Entity}} | *{{RageType|Entity}} Entity with specified handler, null if none exists. | ||
*'''Note:''' If entity with selected handle does not exist, it will return '''undefined'''. | *'''Note:''' If entity with selected handle does not exist, it will return '''undefined'''. | ||
==Example== | ==Example== | ||
This example will return a player by '''handle''' and output his name on the chat. | This example will return get a player by '''handle''' and output his name on the chat. | ||
{{ClientsideCode| | {{ClientsideCode| | ||
<pre> | <pre> | ||
const player = mp.players.atHandle( | function outputPlayerNameWithHandle(handle) { | ||
if (player) { | const player = mp.players.atHandle(handle); | ||
mp.gui.chat.push(`Player with handle | if (player) { | ||
} else { | mp.gui.chat.push(`Player with handle ${handle} is named ${player.name}.`); | ||
mp.gui.chat.push(`Player with handle | } else { | ||
mp.gui.chat.push(`Player with handle ${handle} does not exist.`); | |||
} | |||
} | } | ||
</pre> | </pre> | ||
Revision as of 12:46, 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 handler, null if none exists.
- Note: If entity with selected handle does not exist, it will return undefined.
Example
This example will return 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
- Properties
- Arrays