Difference between revisions of "getVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (global args)
(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)
* [[Control]] getVariable [[String]]
 
 
* [[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
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| object '''getVariable''' name |= Syntax
+
| varspace '''getVariable''' name |= Syntax
  
|p1= object: [[Control]], [[Group]], [[Location]], [[Namespace]], [[Object]], [[Task]] or [[Team Member]] |= Parameter 1
+
|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
  
| [[Any Value]]<br> Returns [[Nothing]] if the variable doesn't exist.<br> Returns [[Anything]] if the object is undefined.<br> |= Return value
+
| [[Anything]] or [[Nothing]] if the variable doesn't exist |= Return value
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
|s2= object '''getVariable''' [name, defaultValue] |= Syntax
+
|s2= varspace '''getVariable''' [name, defaultValue] |= Syntax
  
|p21= object: [[Group]], [[Namespace]], [[Object]] or [[Team Member]] |= Parameter 1
+
|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: [[Any Value]] - Value to return if variable doesn't exist |= Parameter 3
+
|p23= defaultValue: [[Anything]] - Value to return if variable doesn't exist |= Parameter 3
  
|r2= [[Any Value]]<br> Returns ''defaultValue'' if the variable doesn't exist.<br> Returns [[Anything]] if the object is undefined.<br> |= Return value 2
+
|r2= [[Anything]] or ''defaultValue'' if the variable doesn't exist |= Return value 2
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  

Revision as of 16:15, 27 November 2015

Introduced with Armed Assault version 1.00
  Arguments of this scripting command don't have to be local to the client the command is executed on

Click on the images for descriptions

Introduced in

Game:
Armed Assault
Version:
1.00

Description

Description:
Return the value of variable in the variable space of given object or location.

All available data types combinations:

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

Multiplayer:
-
See also:
setVariableallVariables

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section