getVariable
Jump to navigation
Jump to search
Description
- Description:
- Returns the value of variable in the variable space assigned to various data types.
All available data types combinations:
Primary syntax (String) Alternative syntax (Array) Code Since Code Since Namespace getVariable String - Namespace getVariable Array Arma 2: Operation Arrowhead v1.60 Object getVariable String - Object getVariable Array - Group getVariable String - Group getVariable Array - Team Member getVariable String - Team Member getVariable Array - Task getVariable String - Task getVariable Array Arma 3 v1.68 Location getVariable String - Location getVariable Array Arma 3 v1.68 Control getVariable String - Control getVariable Array Arma 3 v1.56 Display getVariable String Arma 3 v1.56 Display getVariable Array Arma 3 v1.56 - Groups:
- VariablesNamespacesMultiplayer
Syntax
- Syntax:
- varspace getVariable name
- Parameters:
- varspace: Namespace, Object, Display, Control, Group, Location, Task, Team Member, Display, Control
- name: String - variable name in given namespace
- Return Value:
- Anything or Nothing if the variable doesn't exist
Alternative Syntax
- Syntax:
- varspace getVariable [name, defaultValue]
- Parameters:
- varspace: Namespace, Object, Display, Control, Group, Location, Task, Team Member, Display, Control
- name: String - variable name in given namespace
- defaultValue: Anything - value to return if variable doesn't exist
- Return Value:
- Anything - current value of the variable or defaultValue if the variable doesn't exist.
Examples
- Example 1:
- Example 2:
- Example 3:
- Example 4:
- Example 5:
- 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:
- setVariable allVariables getFSMVariable
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 13, 2016 - 17:13 (UTC)
-
NOTE: Arma 2 only! In Arma 3 this will return default value:
Warning: the alternative syntax returns undefined when the namespace is an object and that object is null. Example:
Errors because _test is undefined. Tested in Arma 2: Operation Arrowhead 1.63.131129
Categories:
- Scripting Commands
- Introduced with Armed Assault version 1.00
- ArmA: Armed Assault: New Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Variables
- Command Group: Namespaces
- Command Group: Multiplayer