getVariable

-wrong parameter ("Arma") defined!-1.00

GAGlobal

Hover & click on the images for description

Description

Description:

Return the value of variable in the variable space of given object or location. In case of Alt Syntax usage in Arma 3, the default value will be returned if:

• Requested variable is either undefined or nil
• Variable namespace is null (objNull, grpNull, etc.)

All available data types combinations:

• Namespace getVariable String
• Namespace getVariable Array (since a2 1.60)
• Object getVariable String
• Object getVariable Array
• Group getVariable String
• Group getVariable Array
• Team_Member getVariable String
• Team_Member getVariable Array
• Task getVariable String
• Location getVariable String
• Control getVariable String (since Arma 3 v1.55.133553)
• Control getVariable Array (since Arma 3 v1.55.133553)
• Display getVariable String (since Arma 3 v1.55.133553)
• Display getVariable Array (since Arma 3 v1.55.133553)

Groups:

Uncategorised

Syntax

Syntax:

varspace getVariable name

Parameters:

varspace: Namespace, Object, Display, Control, Group, Location, Task or Team Member

name: String - Variable name that was defined in setVariable

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 or Team Member

name: String - Variable name that was defined in setVariable

defaultValue: Anything - Value to return if variable doesn't exist

Return Value:

Anything or defaultValue if the variable doesn't exist.
Note: If the varspace is nonexistent (objNull, grpNull, controlNull ..etc), return is nil

Examples

Example 1:

_thePublicVariable = _myTruck getVariable "myPublicVariable";

Example 2:

_aLocalVariable = _myTruck getVariable ["myLocalVariable", ["Not set", _var]] select 1;

Example 3:

for "_i" from 0 to 5 do { _car = missionNamespace getVariable ("car" + str _i); _car setDamage 0; }; Sets damage of car0, car1, ..., car5 to 0.

Example 4:

myMissionVar = 2015; missionNamespace getVariable "myMissionVar";//Returns 2015

Example 5:

WARNING when using dynamic default value: missionNamespace getVariable ["var", 123 call fnc_abc]; /// fnc_abc is always called even when var is defined

Example 6:

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:

setVariableallVariables

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

Bottom Section

Posted on August 13, 2016 - 17:13 (UTC)

Ebay

NOTE: Arma 2 ONLY! In Arma 3 this will return default value. Warning: the alternative syntax returns undefined when the varspace is an object and that object is null. Example:
_test = objNull getVariable ["test","0"]; systemChat _test; Errors because _test is undefined. Tested in A2OA 1.63.131129