Difference between revisions of "getVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
(removed case-sensitive mention, because it is NOT)
Line 31: Line 31:
 
|p1= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[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]] |= Parameter 2
  
 
| [[Anything]] or [[Nothing]]  if the variable doesn't exist |= Return value
 
| [[Anything]] or [[Nothing]]  if the variable doesn't exist |= Return value
Line 40: Line 40:
 
|p21= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]] or [[Team Member]] |= Parameter 1
 
|p21= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]] 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]] |= Parameter 2
  
 
|p23= defaultValue: [[Anything]] - Value to return if variable doesn't exist |= Parameter 3
 
|p23= defaultValue: [[Anything]] - Value to return if variable doesn't exist |= Parameter 3

Revision as of 20:13, 13 August 2016

Introduced with Armed Assault version 1.001.00
Arguments of this scripting command don't have to be local to the client the command is executed on
Hover & click on the images for descriptions

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
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 or Team Member
name: String - Variable name that was defined in setVariable
defaultValue: Anything - Value to return if variable doesn't exist
Return Value:
Anything or defaultValue if the variable doesn't exist.
Note: If the varspace is nonexistent (objNull, grpNull, controlNull ..etc), return is nil

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
Example 5:
WARNING when using dynamic default value: missionNamespace getVariable ["var", 123 call fnc_abc]; /// fnc_abc is always called even when var is defined
Example 6:
Get current value of a variable and if it is undefined, define it and get the defined value:private _var = missionNamespace getVariable "varName"; if (isNil "_var") then { missionNamespace setVariable ["varName", 123]; _var = 123; }; // _var here will contain current value of the variable varName

Additional Information

See also:
setVariableallVariables

Notes

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

Notes

Bottom Section

Posted on August 13, 2016 - 17:13 (UTC)
Ebay
Warning: the alternative syntax returns undefined when the varspace is an object and that object is null. Example:
_test = objNull getVariable ["test","0"]; systemChat _test; Errors because _test is undefined. Tested in A2OA 1.63.131129