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:

support public parameter	local usage only (no public parameter)
Namespace Object Group	Location (only the scripted ones) Team Member Template:Since Task Template:Since value will actually be set on Task's FSM. If none exist, the data will not be set Control Template:Since Display Template:Since

name: String - variable name

value: Anything - variable value

public: Boolean, Number or Array of Numbers - (Optional, default false): Template:Since

• Boolean - when set to true, the variable broadcast is global and persistent (JIP compatible) GEGlobal
• Number - the variable is set only on the client of given ownerId, or if id is negative, the variable is set on every client except the given one (see Multiplayer Scripting - Machine network ID)
• Array of Numbers - array of ownerIds

Broadcast of the following Data Types is supported:

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 current value of a variable and if it is undefined, define it and get the defined value: private _var = missionNamespace getVariable "varName"; if (isNil "_var") then { _var = 123; missionNamespace setVariable ["varName", _var]; }; // _var here will contain current value of the variable varName

Example 5:

Unset _myTruck's TAG_myPublicVariable variable globally: _myTruck setVariable ["TAG_myPublicVariable", nil, true];

Additional Information

See also:

getVariableallVariablessetFSMVariableMultiplayer Scripting

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.