getVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(syntax with defaultValue)
(Added all available data types combinations)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Return the value of variable in the variable space of given object or location. |= 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]]
* [[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]]|= Description
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 09:12, 12 June 2011

-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:
_aVariable = _myTruck getVariable "myVariable";

Additional Information

See also:
setVariablegetVariable (VBS2)

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