setVariable
From Bohemia Interactive Community


Click on the images for descriptions
Introduced in
- Game:
- Armed Assault
- Version:
- 1.00
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.
All supported variable types:- Namespace
- Object
- Group
- Team Member
- Task
- Location
- Control (since Arma 3 v1.55.133553)
- Display (since Arma 3 v1.55.133553)
In Arma 3 it is possible to broadcast nil value
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
- [name, value]: Array
- 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, value, public]: Array
- 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
- Boolean - when true, the variable broadcast is global and persistent
- 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
- Array of Numbers - array of owner (clientOwner) ids
- 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
- 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. - See also:
- getVariableallVariablessetFSMVariableMultiplayer Scripting
Notes
Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To
Add New Note | How To
Notes
Bottom Section
- Posted on December 9, 2015 - 20:18 (UTC)
- Commy2
- This command does not work with CfgAmmo or CfgNonAIVehicles objects, like bullets, mines or butterflies (probably because they are local objects Killzone Kid (talk) 11:25, 9 July 2017 (CEST)).
Categories:
- Armed Assault: New Scripting Commands List
- Scripting Commands
- Introduced with Armed Assault version 1.00
- Commands utilizing global arguments
- Commands with local effects
- Scripting Commands OFP Elite
- Scripting Commands ArmA
- Command Group: Locations
- Command Group: Object Information
- Command Group: Variables
- Scripting Commands ArmA2
- Scripting Commands Take On Helicopters
- Scripting Commands Arma 3