setVariable

From Bohemia Interactive Community
Revision as of 10:28, 19 July 2009 by Planck (talk | contribs) (should be Control)
Jump to navigation Jump to search
-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

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.
Groups:
Uncategorised

Syntax

Syntax:
objectName setVariable [name, value, (public)]
Parameters:
objectName: Object or Location. Arma 2 also supports: Namespace, Group, 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

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

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