getVariable: Difference between revisions
Jump to navigation
Jump to search
Waffle SS. (talk | contribs) m (global args) |
Killzone Kid (talk | contribs) (support for control and display) |
||
Line 13: | Line 13: | ||
* [[Namespace]] getVariable [[String]] | * [[Namespace]] getVariable [[String]] | ||
* [[Namespace]] getVariable [[Array]] (since {{Name|a2}} 1.60) | * [[Namespace]] getVariable [[Array]] (since {{Name|a2}} 1.60) | ||
* [[Object]] getVariable [[String]] | * [[Object]] getVariable [[String]] | ||
* [[Object]] getVariable [[Array]] | * [[Object]] getVariable [[Array]] | ||
Line 21: | Line 20: | ||
* [[Team_Member]] getVariable [[Array]] | * [[Team_Member]] getVariable [[Array]] | ||
* [[Task]] getVariable [[String]] | * [[Task]] getVariable [[String]] | ||
* [[Location]] getVariable [[String]]|= Description | * [[Location]] getVariable [[String]] | ||
* [[Control]] getVariable [[String]] (since Arma 3 v1.55.133553) | |||
* [[Control]] getVariable [[Array]] (since Arma 3 v1.55.133553) | |||
* [[Display]] getVariable [[String]] (since Arma 3 v1.55.133553) | |||
* [[Display]] getVariable [[Array]] (since Arma 3 v1.55.133553)|= Description | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | varspace '''getVariable''' name |= Syntax | ||
|p1= | |p1= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[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 | ||
| [[ | | [[Anything]] or [[Nothing]] if the variable doesn't exist |= Return value | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|s2= | |s2= varspace '''getVariable''' [name, defaultValue] |= Syntax | ||
|p21= | |p21= varspace: [Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]] 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 | ||
|p23= defaultValue: [[ | |p23= defaultValue: [[Anything]] - Value to return if variable doesn't exist |= Parameter 3 | ||
|r2= [[ | |r2= [[Anything]] or ''defaultValue'' if the variable doesn't exist |= Return value 2 | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 15:15, 27 November 2015
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)
- 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
- Control getVariable String (since Arma 3 v1.55.133553)
- Control getVariable Array (since Arma 3 v1.55.133553)
- Display getVariable String (since Arma 3 v1.55.133553)
- Display getVariable Array (since Arma 3 v1.55.133553)
- Groups:
- Uncategorised
Syntax
- Syntax:
- varspace getVariable name
- Parameters:
- varspace: Namespace, Object, Display, Control, Group, Location, Task or Team Member
- name: String - Variable name that was defined in setVariable (Case sensitive)
- Return Value:
- Anything or Nothing if the variable doesn't exist
Alternative Syntax
- Syntax:
- varspace getVariable [name, defaultValue]
- Parameters:
- varspace: [Namespace]], Object, Display, Control, Group, Location, Task or Team Member
- name: String - Variable name that was defined in setVariable (Case sensitive)
- defaultValue: Anything - Value to return if variable doesn't exist
- Return Value:
- Anything or defaultValue if the variable doesn't exist
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:
- setVariableallVariables
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
Categories:
- Name template usage error
- Scripting Commands
- Introduced with Arma version 1.00
- Arma: New Scripting Commands
- Arma: Scripting Commands
- Command Group: Uncategorised
- Scripting Commands ArmA
- Command Group: Variables
- Command Group: Locations
- Scripting Commands ArmA2
- Scripting Commands Arma 3
- Scripting Commands Take On Helicopters