getVariable

From Bohemia Interactive Community
Revision as of 01:36, 11 April 2014 by fred gandt (talk | contribs) (Added example)
Jump to navigation Jump to search
-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:
Groups:
Uncategorised

Syntax

Syntax:
object getVariable name
Parameters:
object: Object or Location
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: Object or Location
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;

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

Notes

Bottom Section