getVariable

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

Hover & click on the images for description

Description

Description:

Return the value of variable in the variable space of given object or location.

All available data types combinations:

• Namespace getVariable String
• Namespace getVariable Array (since a2 1.60)
• Control getVariable String
• 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

Groups:

Uncategorised

Syntax

Syntax:

object getVariable name

Parameters:

object: Control, Group, Location, Namespace, Object, Task or Team Member

name: String - Variable name that was defined in setVariable (Case sensitive)

Return Value:

Any Value
Returns Nothing if the variable doesn't exist.
Returns Anything if the object is undefined.

Alternative Syntax

Syntax:

object getVariable [name, defaultValue]

Parameters:

object: Group, Namespace, Object or Team Member

name: String - Variable name that was defined in setVariable (Case sensitive)

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

Return Value:

Any Value
Returns defaultValue if the variable doesn't exist.
Returns Anything if the object is undefined.

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

Additional Information

See also:

setVariable

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