Difference between revisions of "setVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. ArmA2 classification)
(MP public param, new types supported)
Line 11: Line 11:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| Set variable to given value in the variable space of given object or location.
+
| Set variable to given value in the variable space of given element.  
  
In MP, the variable space of the object is local to each client. Changes are not broadcast. |= Description
+
To remove a variable, set it to [[nil]] (e.g. player setVariable ["varname",nil]). |= Description
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| objectName '''setVariable''' [name, value] |= Syntax
+
| objectName '''setVariable''' [name, value, (public)] |= Syntax
  
|p1= objectName: [[Object]] or [[Location]] |= Parameter 1
+
|p1= objectName: [[Object]] or [[Location]]. Arma 2 also supports: [[Namespace]], [[group]], [[Control|map control]], [[Task]] |= Parameter 1
 
|p2= [name, value]: [[Array]] |= Parameter 2
 
|p2= [name, value]: [[Array]] |= Parameter 2
 
|p3= name: [[String]] |= Parameter 3
 
|p3= name: [[String]] |= Parameter 3
 
|p4= value: [[Any_Value]] |= Parameter 4
 
|p4= value: [[Any_Value]] |= Parameter 4
 +
|p5= public: [[Boolean]] - Only available for [[Object]] types. If public is true then the value is broadcast to all computers. |= Parameter 5
  
 
| [[Nothing]] |= Return value
 
| [[Nothing]] |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
|x1= <code>_myTruck setVariable ["myVariable",123];</code> |= Example 1
+
|x1= <code>_myTruck setVariable ["myVariable", 123, true];</code> |= Example 1
 +
 
 +
|mp= In MP, the variable space of the object is local to each client. Changes are not broadcast, except in Arma 2 via public parameter for supported types. |= Multiplayer
  
 
| [[getVariable]], [[setVariable (VBS2)]] |= See also
 
| [[getVariable]], [[setVariable (VBS2)]] |= See also

Revision as of 07:34, 19 July 2009

Introduced with Armed Assault version 1.001.00Arguments of this scripting command have to be local to the client the command is executed onEffects of this scripting command are not broadcasted over the network and remain local to the client the command is executed on
Hover & click on the images for descriptions

Description

Description:
Set variable to given value in the variable space of given element. To remove a variable, set it to nil (e.g. player setVariable ["varname",nil]).
Multiplayer:
In MP, the variable space of the object is local to each client. Changes are not broadcast, except in Arma 2 via public parameter for supported types.

Syntax

Syntax:
objectName setVariable [name, value, (public)]
Parameters:
objectName: Object or Location. Arma 2 also supports: Namespace, group, map control, Task
[name, value]: Array
name: String
value: Any_Value
public: Boolean - Only available for Object types. If public is true then the value is broadcast to all computers.
Return Value:
Nothing

Examples

Example 1:
_myTruck setVariable ["myVariable", 123, true];

Additional Information

See also:
getVariablesetVariable (VBS2)

Notes

i
Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.

Notes

According to Suma, beginning with ArmA version 1.08, "setVariable now should work on any entity which can be targeted by AI, including soldier and game logic units. This includes most buildings, but not other static objects. Using it with buildings one should be aware the building may be discarded because of streaming. In such case the variable space is lost. When used for buildings, the storage should therefore be considered non-reliable." Reference: Make setVariable work on other things than just vehicles

Bottom Section