Difference between revisions of "getVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
 
{{Command|Comments=
 
{{Command|Comments=
____________________________________________________________________________________________
 
  
 
| arma1 |Game name=
 
| arma1 |Game name=
Line 11: Line 10:
  
 
|gr2= Variables |GROUP2=
 
|gr2= Variables |GROUP2=
____________________________________________________________________________________________
 
  
 
| Returns the value of variable in the variable space assigned to various data types.
 
| Returns the value of variable in the variable space assigned to various data types.
Line 44: Line 42:
 
* Requested variable is either undefined or [[nil]]
 
* Requested variable is either undefined or [[nil]]
 
* Variable namespace is null ([[objNull]], [[grpNull]], etc.)}} |DESCRIPTION=
 
* Variable namespace is null ([[objNull]], [[grpNull]], etc.)}} |DESCRIPTION=
____________________________________________________________________________________________
 
  
 
| varspace [[getVariable]] name |SYNTAX=
 
| varspace [[getVariable]] name |SYNTAX=
Line 53: Line 50:
  
 
| [[Anything]] or [[Nothing]] if the variable doesn't exist |RETURNVALUE=
 
| [[Anything]] or [[Nothing]] if the variable doesn't exist |RETURNVALUE=
____________________________________________________________________________________________
 
  
 
|s2= varspace [[getVariable]] [name, defaultValue] |SYNTAX2=
 
|s2= varspace [[getVariable]] [name, defaultValue] |SYNTAX2=
Line 64: Line 60:
  
 
|r2= [[Anything]] - current value of the variable or ''defaultValue'' if the variable doesn't exist. |RETURNVALUE2=
 
|r2= [[Anything]] - current value of the variable or ''defaultValue'' if the variable doesn't exist. |RETURNVALUE2=
____________________________________________________________________________________________
 
  
 
|x1= <code>[[private]] _variable = myTruck [[getVariable]] "myVariable"; {{cc|returns [[nil]] if "myVariable" is not set}}</code> |EXAMPLE1=
 
|x1= <code>[[private]] _variable = myTruck [[getVariable]] "myVariable"; {{cc|returns [[nil]] if "myVariable" is not set}}</code> |EXAMPLE1=
Line 90: Line 85:
 
};
 
};
 
{{cc|_var here will contain current value of the variable varName}}</code> |EXAMPLE6=
 
{{cc|_var here will contain current value of the variable varName}}</code> |EXAMPLE6=
____________________________________________________________________________________________
 
  
 
| [[setVariable]], [[allVariables]], [[getFSMVariable]]|SEEALSO=
 
| [[setVariable]], [[allVariables]], [[getFSMVariable]]|SEEALSO=

Revision as of 01:38, 17 January 2021

Hover & click on the images for description

Description

Description:
Returns the value of variable in the variable space assigned to various data types. All available data types combinations:
Primary syntax (String) Alternative syntax (Array)

Template:Important

Arma 3
In the case of Alt Syntax usage in Arma 3, defaultValue will be returned if:
  • Requested variable is either undefined or nil
  • Variable namespace is null (objNull, grpNull, etc.)
Groups:
MultiplayerVariables

Syntax

Syntax:
varspace getVariable name
Parameters:
varspace: Namespace, Object, Display, Control, Group, Location, Task, Team Member, Display, Control
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, Location, Task, Team Member, Display, Control
name: String - Variable name that was defined in setVariable
defaultValue: Anything - Value to return if variable doesn't exist
Return Value:
Anything - current value of the variable or defaultValue if the variable doesn't exist.

Examples

Example 1:
private _variable = myTruck getVariable "myVariable"; // returns nil if "myVariable" is not set
Example 2:
private _variable = myTruck getVariable ["myVariable", 50]; // returns 50 if "myVariable" is not set
Example 3:
Set damage of car0..car5 to 0: for "_i" from 0 to 5 do { _car = missionNamespace getVariable ("car" + str _i); _car setDamage 0; };
Example 4:
myMissionVar = 2015; missionNamespace getVariable "myMissionVar"; // returns 2015
Example 5:
WARNING when using dynamic default values as they always get evaluated: missionNamespace getVariable ["var", 123 call fnc_abc]; // fnc_abc is called every getVariable even if "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:
setVariableallVariablesgetFSMVariable

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

Posted on August 13, 2016 - 17:13 (UTC)
Ebay
NOTE: Arma 2 ONLY! In Arma 3 this will return default value: 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
Posted on August 31, 2017 - 03:29 (UTC)
AgentRev
You can do typechecking using param: private _myVar = [player getVariable "myVar"] param [0, "", [""]]; and params: [player getVariable "myVar"] params [["_myVar", "", [""]]];

Bottom Section