setVariable

From Bohemia Interactive Community
Jump to navigation Jump to search
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];).
  • When variable is set on Task, it is not actually set on task itself, but on FSM attached to the task. So if there is no FSM setVariable will not work.
  • When variable is set on Location, it works only with locations created with createLocation.
Arma 3
In Arma 3 it is possible to broadcast nil value!
Multiplayer:
The variable space of the object is local to each client and by default changes are not broadcast.
Since Arma 2: If the public parameter for supported types is true, the value will be synchronized also for a JIP player.
Problems:
missionNamespace, uiNamespace, parsingNamespace and profileNamespace variable names could be any string, except for the reserved names, which are normally script command names. 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 script command. Other varspaces do not have such limitation. You can always check for all available script commands by running utility number 5

Syntax

Syntax:
varspace setVariable [name, value]
Parameters:
varspace: Namespace, Object, Group, Team Member, Task, Location, Control, Display - Variable space in which variable can be set
Arma 3
Since Arma 3 also Control and Display are supported types.
name: String - Variable name
value: Anything - Variable value
Return Value:
Nothing

Alternative Syntax

Syntax:
varspace setVariable [name, value, public]
Parameters:
varspace: missionNamespace, Object or Group - Variable space in which variable can be set
name: String - Variable name
value: Anything - Variable value (if public is true, check publicVariable for what types are supported for broadcast)
public: Boolean, Number or Array of Numbers
  • Number - The variable is set only on the client of given owner (clientOwner) id, or if id is negative, the variable is set on every client except the given one
Return Value:
Nothing

Examples

Example 1:
_myTruck setVariable ["myPublicVariable", 123, true];
Example 2:
_myTruck setVariable ["myLocalVariable", ["321", _var], false];
Example 3:
missionNamespace setVariable ["myName", "KK"]; hint myName; // KK
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 { missionNamespace setVariable ["varName", 123]; _var = 123; }; // _var here will contain current value of the variable varName

Additional Information

See also:
getVariableallVariablessetFSMVariableMultiplayer Scripting
Groups:
MultiplayerVariables

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.