getVariable: Difference between revisions
Jump to navigation
Jump to search
Fred Gandt (talk | contribs) (Added example) |
(syntax parameters, added example) |
||
Line 26: | Line 26: | ||
| object '''getVariable''' name |= Syntax | | object '''getVariable''' name |= Syntax | ||
|p1= object: [[Object]] or [[ | |p1= object: [[Control]], [[Group]], [[Location]], [[Namespace]], [[Object]], [[Task]] or [[Team Member]] |= Parameter 1 | ||
|p2= name: [[String]] - Variable name that was defined in [[setVariable]] ('''Case sensitive''') |= Parameter 2 | |p2= name: [[String]] - Variable name that was defined in [[setVariable]] ('''Case sensitive''') |= Parameter 2 | ||
Line 35: | Line 35: | ||
|s2= object '''getVariable''' [name, defaultValue] |= Syntax | |s2= object '''getVariable''' [name, defaultValue] |= Syntax | ||
|p21= object: [[Object]] or [[ | |p21= object: [[Group]], [[Namespace]], [[Object]] or [[Team Member]] |= Parameter 1 | ||
|p22= name: [[String]] - Variable name that was defined in [[setVariable]] ('''Case sensitive''') |= Parameter 2 | |p22= name: [[String]] - Variable name that was defined in [[setVariable]] ('''Case sensitive''') |= Parameter 2 | ||
Line 47: | Line 47: | ||
|x2= <code>_aLocalVariable = _myTruck [[getVariable]] ["myLocalVariable", ["Not set", _var]<nowiki>]</nowiki> [[select]] 1;</code> |= Example 2 | |x2= <code>_aLocalVariable = _myTruck [[getVariable]] ["myLocalVariable", ["Not set", _var]<nowiki>]</nowiki> [[select]] 1;</code> |= Example 2 | ||
|x3= <code>[[for]] "_i" [[from]] 0 [[to]] 5 [[do]] { | |||
_car = [[missionNamespace]] [[getVariable]] ("car" [[valuea_plus_valueb|+]] [[str]] _i); | |||
_car [[setDamage]] 0; | |||
};</code> | |||
Sets damage of car0, car1, ..., car5 to 0. |= Example 3 | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 11:04, 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: 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.
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