Difference between revisions of "Entity::setVariable"

From RAGE Multiplayer Wiki
Jump to navigation Jump to search
 
Line 16: Line 16:
  
 
=== Required Arguments ===
 
=== Required Arguments ===
*'''entity''': {{RageType|Object}}
+
*{{Required}}'''entity''': {{RageType|Object}}
*'''name''': {{RageType|String}}
+
*{{Required}}'''name''': {{RageType|String}}
*'''value''': {{RageType|Any}}
+
*{{Required}}'''value''': {{RageType|Any}}
  
 
==Example==
 
==Example==

Latest revision as of 12:40, 2 December 2019

Server-Side
Function

Js.png JavaScript



Set custom data to an entity.

JavaScript Syntax
Jslogo.png

Syntax

// To set one variable at a time
entity.setVariable(name, value);

// To set multiple variables at a time.
entity.setVariable({name1: value1, name2: value2});

Required Arguments

  • *entity: Object
  • *name: String
  • *value: Any

Example

This binds the vehicle to the player

Server-Side
let veh = mp.vehicles.new(vehName, player.position);
player.setVariable('veh', veh);


This is an example of setting multiple variables to a player which is not implemented and does not work (yet)

Server-Side
player.setVariable({
  name: 'Player',
  age: 20
});


See More