getVariable: Difference between revisions
Jump to navigation
Jump to search
m (Text replace - "{{uc:{{PAGENAME}}}}" to "{{uc:{{PAGENAME}}}} {{uc:{{PAGENAME}}}}") |
Fred Gandt (talk | contribs) (Added example) |
||
| Line 7: | Line 7: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Return the value of variable in the variable space of given object or location. | | Return the value of variable in the variable space of given object or location. | ||
<br> | |||
<br> | |||
All available data types combinations: | All available data types combinations: | ||
* [[Namespace]] getVariable [[String]] | * [[Namespace]] getVariable [[String]] | ||
| Line 31: | Line 32: | ||
| [[Any Value]]<br> Returns [[Nothing]] if the variable doesn't exist.<br> Returns [[Anything]] if the object is undefined.<br> |= Return value | | [[Any Value]]<br> Returns [[Nothing]] if the variable doesn't exist.<br> Returns [[Anything]] if the object is undefined.<br> |= Return value | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|s2= object '''getVariable''' [name, defaultValue] |= Syntax | |s2= object '''getVariable''' [name, defaultValue] |= Syntax | ||
| Line 42: | Line 44: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code> | |x1= <code>_thePublicVariable = _myTruck [[getVariable]] "myPublicVariable";</code> |= Example 1 | ||
|x2= <code>_aLocalVariable = _myTruck [[getVariable]] ["myLocalVariable", ["Not set", _var]<nowiki>]</nowiki> [[select]] 1;</code> |= Example 2 | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 01:36, 11 April 2014
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 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: 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