setVariable

From Bohemia Interactive Community
Revision as of 11:57, 23 March 2022 by Lou Montana (talk | contribs) (Some wiki formatting)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Set variable to given value in the variable space of given element. Can be used to broadcast variables over the network. To remove a variable, set it to nil (see Example 5).
missionNamespace, uiNamespace, parsingNamespace and profileNamespace variables cannot be named as commands - e.g missionNamespace setVariable ["west", 123]; will result in a Reserved variable in expression error, west being a scripting command (other namespaces do not have such limitation). See also all available script commands.
Multiplayer:
The variable space of the object is local to each client and by default changes are not broadcast - see the public parameter below.
Groups:
VariablesNamespacesMultiplayer

Syntax

Syntax:
varspace setVariable [name, value, public]
Parameters:
varspace: variable space in which variable can be set. Can be one of:
name: String - variable name (Identifier)
value: Anything - variable value
since 25.2px1.00
public - (Optional, default: false) can be one of: This parameter is only available if the varspace parameter is a Namespace, Object or Group. Furthermore, only the following Data Types can be broadcast:
Type Number Boolean Object Group String Text Array Code Nothing (nil) HashMap
Since Logo A0.png1.34 Logo A0.png1.34 Logo A0.png1.34 Logo A0.png1.34 Logo A1 black.png1.00 Logo A1 black.png1.00 Logo A1 black.png1.09 Logo A1 black.png1.09 Arma 3 logo black.png1.26 Arma 3 logo black.png2.02
Return Value:
Nothing

Examples

Example 1:
_myTruck setVariable ["TAG_myPublicVariable", 123, true];
Example 2:
_myTruck setVariable ["TAG_myLocalVariable", ["321", _var], owner driver _myTruck];
Example 3:
missionNamespace setVariable ["TAG_myName", "Brian"]; hint TAG_myName; // hints "Brian"
Example 4:
Get the current value of a variable or, if it is undefined, define it and then get the value:
private _var = missionNamespace getVariable "VarName"; if (isNil "_var") then { _var = 123; missionNamespace setVariable ["VarName", _var]; }; // _var now contains the current value of the missionNamespace's variable varName
Example 5:
Remove TAG_myPublicVariable from _myTruck (globally):
_myTruck setVariable ["TAG_myPublicVariable", nil, true];

Additional Information

See also:
getVariable allVariables setFSMVariable

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
Posted on Aug 18, 2007 - 09:51 (UTC)
Killswitch
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. » – Suma
Posted on Dec 09, 2015 - 20:18 (UTC)
Commy2
This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies.
Posted on Mar 23, 2022 - 08:59 (UTC)
Leopard20
Since Arma 3 logo black.png2.10 setVariable works on CfgAmmo objects (such as bullets, missiles, grenades, mines, etc) as well.