setVariable

1.001.001.501.000.50

GAGlobalLELocal

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 variable names can be any string but reserved names such as script commands. For example: missionNamespace setVariable ["west", 123]; will result in error:

Error in expression <missionNamespace setVariable ["west", 123];>
	Error position: <setVariable ["west", 123];>
	Error Reserved variable in expression

as west is a scripting command. Other varspaces 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.

Groups:

MultiplayerVariables

Syntax

Syntax:

varspace setVariable [name, value, public]

Parameters:

varspace: variable space in which variable can be set. Can be one of:

• Namespace
• Object
• Group
• Location (only scripted ones)
• Team Member (since Arma 2)
• Task (since Arma 2) - value will actually be set on the Task's FSM. If none exist, the data will not be set.
• Control (since Arma 3)
• Display (since Arma 3)

name: String - variable name (Identifier)

value: Anything - variable value

public (Optional, default: false): Since Arma 2

• Boolean - if set to true, the variable is broadcast globally and is persistent (JIP compatible) GEGlobal
• Number - the variable is only set on the client with the given Machine network ID. If the number is negative, the variable is set on every client except for the one with the given ID.
• Array of Numbers - array of Machine network IDs

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	1.34	1.34	1.34	1.34	1.00	1.00	1.09	1.09	1.26	2.02

Return Value:

Nothing

Examples

Example 1:

_myTruck setVariable ["TAG_myPublicVariable", 123, true];

Example 2:

_myTruck setVariable ["TAG_myLocalVariable", ["321", _var], 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 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 December 9, 2015 - 20:18 (UTC)

Commy2

This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies.