Entity::getVariable: Difference between revisions
MrPancakers (talk | contribs) (Cleaned up page) |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
Retrieves a server side custom data from the entity. | |||
{{ServersideJsFunction}} | |||
{{JSContainer| | |||
==Syntax== | ==Syntax== | ||
<pre> | <pre> | ||
entity.getVariable('variableName'); | entity.getVariable('variableName'); | ||
</pre> | </pre> | ||
=== Required Arguments === | |||
*{{Required}}'''entity''': {{RageType|Object}} | |||
*{{Required}}'''name''': {{RageType|String}} | |||
==Example== | ==Example== | ||
This example will retrieve the data from the variable 'veh' that is assigned to the player | This example will retrieve the data from the variable 'veh' that is assigned to the player | ||
{{ServersideCode| | |||
<pre> | <pre> | ||
mp.events.addCommand('setNick', (player, nickname) => { | |||
player.setVariable('oldNick', player.name); | |||
player.name = nickname; | |||
player.setVariable('newNick', nickname); | |||
console.log(`Player[${player.id}] Changed nick from ${player.getVariable('oldNick')} to ${player.name}`); | |||
}); | |||
</pre> | </pre> | ||
}} | |||
}} | |||
== See More == | == See More == | ||
{{Entity_functions}} | {{Entity_functions}} | ||
[[Category:Entity API]] | |||
[[Category:Server-side Function]] | |||
Latest revision as of 17:17, 12 September 2024
Retrieves a server side custom data from the entity.
Server-Side Function
 JavaScript
|
|---|
JavaScript Syntax
Syntax
entity.getVariable('variableName');
Required Arguments
- *entity: Object
- *name: String
Example
This example will retrieve the data from the variable 'veh' that is assigned to the player
Server-Side
mp.events.addCommand('setNick', (player, nickname) => {
player.setVariable('oldNick', player.name);
player.name = nickname;
player.setVariable('newNick', nickname);
console.log(`Player[${player.id}] Changed nick from ${player.getVariable('oldNick')} to ${player.name}`);
});