Difference between revisions of "getVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Command " to "{{RV|type=command ")
m (Text replacement - ";[ ]+ " to "; ")
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{RV|type=command
 
{{RV|type=command
  
| arma1
+
|game1= arma1
 +
|version1= 1.00
  
|1.00
+
|game2= arma2
 +
|version2= 1.00
 +
 
 +
|game3= arma2oa
 +
|version3= 1.50
 +
 
 +
|game4= tkoh
 +
|version4= 1.00
 +
 
 +
|game5= arma3
 +
|version5= 0.50
  
 
|arg= global
 
|arg= global
Line 11: Line 22:
 
|gr2= Variables
 
|gr2= Variables
  
| Returns the value of variable in the variable space assigned to various data types.
+
|descr= Returns the value of variable in the variable space assigned to various data types.
 
All available data types combinations:
 
All available data types combinations:
{{{!}} class{{=}}"wikitable"
+
{{{!}} class="wikitable"
! Primary syntax ([[String]])
+
!colspan="2"{{!}}Primary syntax ([[String]]) !! colspan="2"{{!}}Alternative syntax ([[Array]])
! Alternative syntax ([[Array]])
 
 
{{!}}-
 
{{!}}-
{{!}}
+
{{!}}'''Code'''
* [[Namespace]] getVariable [[String]]
+
{{!}}'''Since'''
* [[Object]] getVariable [[String]]
+
{{!}}'''Code'''
* [[Group]] getVariable [[String]]
+
{{!}}'''Since'''
* [[Team_Member]] getVariable [[String]]
+
{{!}}-
* [[Task]] getVariable [[String]]
+
{{!}} [[Namespace]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Namespace]] getVariable [[Array]] {{!}}{{!}} {{arma2oa}} v1.60
* [[Location]] getVariable [[String]]
+
{{!}}-
* [[Control]] getVariable [[String]] (since {{arma3}} v1.55.133553)
+
{{!}} [[Object]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Object]] getVariable [[Array]] {{!}}{{!}} -
* [[Display]] getVariable [[String]] (since {{arma3}} v1.55.133553)
+
{{!}}-
{{!}}
+
{{!}} [[Group]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Group]] getVariable [[Array]] {{!}}{{!}} -
* [[Namespace]] getVariable [[Array]] (since {{arma2}} OA v1.60)
+
{{!}}-
* [[Object]] getVariable [[Array]]
+
{{!}} [[Team Member]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Team Member]] getVariable [[Array]] {{!}}{{!}} -
* [[Group]] getVariable [[Array]]
+
{{!}}-
* [[Team_Member]] getVariable [[Array]]
+
{{!}} [[Task]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Task]] getVariable [[Array]] {{!}}{{!}} {{arma3}} v1.68
* [[Task]] getVariable [[Array]] (since {{arma3}} v1.67)
+
{{!}}-
* [[Location]] getVariable [[Array]] (since {{arma3}} v1.67)
+
{{!}} [[Location]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Location]] getVariable [[Array]] {{!}}{{!}} {{arma3}} v1.68
* [[Control]] getVariable [[Array]] (since {{arma3}} v1.55.133553))
+
{{!}}-
* [[Display]] getVariable [[Array]] (since {{arma3}} v1.55.133553)
+
{{!}} [[Control]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Control]] getVariable [[Array]] {{!}}{{!}} {{arma3}} v1.56
 +
{{!}}-
 +
{{!}} [[Display]] getVariable [[String]] {{!}}{{!}} {{arma3}} v1.56 {{!}}{{!}} [[Display]] getVariable [[Array]] {{!}}{{!}} {{arma3}} v1.56
 
{{!}}}
 
{{!}}}
  
{{Important | When variable is [[setVariable|set]] on a [[Task]], it is not actually set on the task itself, but on the FSM attached to the task.<br>
+
{{Feature | important | When variable is [[setVariable|set]] on a [[Task]], it is not actually set on the task itself, but on the FSM attached to the task.<br>
 
If there is no FSM, [[getVariable]] will not work.}}
 
If there is no FSM, [[getVariable]] will not work.}}
{{Feature|arma3 | In the case of Alt Syntax usage in {{arma3}}, ''defaultValue'' will be returned if:
+
{{Feature | arma3 | In the case of Alt Syntax usage in {{arma3}}, ''defaultValue'' will be returned if:
 
* Requested variable is either undefined or [[nil]]
 
* Requested variable is either undefined or [[nil]]
 
* Variable namespace is null ([[objNull]], [[grpNull]], etc.)}}
 
* Variable namespace is null ([[objNull]], [[grpNull]], etc.)}}
  
| varspace [[getVariable]] name
+
|s1= varspace [[getVariable]] name
  
 
|p1= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]]
 
|p1= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]]
  
|p2= name: [[String]] - variable name that was defined in [[setVariable]]
+
|p2= name: [[String]] - Variable name in given namespace
  
| [[Anything]] or [[Nothing]] if the variable doesn't exist
+
|r1= [[Anything]] or [[Nothing]] if the variable doesn't exist
  
 
|s2= varspace [[getVariable]] [name, defaultValue]
 
|s2= varspace [[getVariable]] [name, defaultValue]
  
|p21= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]] |PARAMETER21=
+
|p21= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]]
  
|p22= name: [[String]] - Variable name that was defined in [[setVariable]] |PARAMETER22=
+
|p22= name: [[String]] - Variable name in given namespace
  
|p23= defaultValue: [[Anything]] - Value to return if variable doesn't exist |PARAMETER23=
+
|p23= defaultValue: [[Anything]] - Value to return if variable doesn't exist {{Feature|warning|A dynamic ''defaultValue'' e.g. {{ic|[[random]] 500}} will always be executed, even if the variable is defined.}}
  
|r2= [[Anything]] - current value of the variable or ''defaultValue'' if the variable doesn't exist.
+
|r2= [[Anything]] - Current value of the variable or ''defaultValue'' if the variable doesn't exist.
  
 
|x1= <code>[[private]] _variable = myTruck [[getVariable]] "myVariable"; {{cc|returns [[nil]] if "myVariable" is not set}}</code>
 
|x1= <code>[[private]] _variable = myTruck [[getVariable]] "myVariable"; {{cc|returns [[nil]] if "myVariable" is not set}}</code>
Line 65: Line 77:
 
|x2= <code>[[private]] _variable = myTruck [[getVariable]] ["myVariable", 50]; {{cc|returns 50 if "myVariable" is not set}}</code>
 
|x2= <code>[[private]] _variable = myTruck [[getVariable]] ["myVariable", 50]; {{cc|returns 50 if "myVariable" is not set}}</code>
  
|x3= Set damage of car0..car5 to 0:
+
|x3=  
 
<code>[[for]] "_i" [[from]] 0 [[to]] 5 [[do]] {
 
<code>[[for]] "_i" [[from]] 0 [[to]] 5 [[do]] {
 
_car = [[missionNamespace]] [[getVariable]] ("car" [[valuea_plus_valueb|+]] [[str]] _i);
 
_car = [[missionNamespace]] [[getVariable]] ("car" [[valuea_plus_valueb|+]] [[str]] _i);
 
_car [[setDamage]] 0;
 
_car [[setDamage]] 0;
};</code>
+
};{{cc|Set damage of car0..car5 to 0}}</code>
  
 
|x4= <code>myMissionVar = 2015;
 
|x4= <code>myMissionVar = 2015;
[[missionNamespace]] [[getVariable]] "myMissionVar"; {{cc|returns 2015}}</code>
+
[[missionNamespace]] [[getVariable]] "myMissionVar"; {{cc|Returns 2015}}</code>
  
|x5= WARNING when using dynamic default values as they always get evaluated:
+
|x5= Get current value of a variable and if it is undefined, define it and get the defined value:<code>[[private]] _var = [[missionNamespace]] [[getVariable]] "varName";
<code>[[missionNamespace]] [[getVariable]] ["var", 123 [[call]] fnc_abc];
 
{{cc|fnc_abc is called every [[getVariable]] even if "var" is defined}}</code>
 
 
 
|x6= Get current value of a variable and if it is undefined, define it and get the defined value:<code>[[private]] _var = [[missionNamespace]] [[getVariable]] "varName";
 
 
[[if]] ([[isNil]] "_var") [[then]]
 
[[if]] ([[isNil]] "_var") [[then]]
 
{
 
{
[[missionNamespace]] [[setVariable]] ["varName", 123];  
+
[[missionNamespace]] [[setVariable]] ["varName", 123];
 
_var = 123;
 
_var = 123;
 
};
 
};
 
{{cc|_var here will contain current value of the variable varName}}</code>
 
{{cc|_var here will contain current value of the variable varName}}</code>
  
| [[setVariable]], [[allVariables]], [[getFSMVariable]]
+
|seealso= [[setVariable]], [[allVariables]], [[getFSMVariable]]
 
}}
 
}}
  
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
 
  
 +
<dt><dt>
 
<dd class="notedate">Posted on August 13, 2016 - 17:13 (UTC)</dd>
 
<dd class="notedate">Posted on August 13, 2016 - 17:13 (UTC)</dd>
 
<dt class="note">[[User:Ebay|Ebay]]</dt>
 
<dt class="note">[[User:Ebay|Ebay]]</dt>
 
<dd class="note">
 
<dd class="note">
'''NOTE: {{arma2}} ONLY! In {{arma3}} this will return default value:'''
+
'''NOTE: {{arma2}} only! In {{arma3}} this will return default value:'''
Warning: the alternative syntax returns undefined when the varspace is an object and that object is null. Example:<br>
+
Warning: the alternative syntax returns undefined when the namespace is an object and that object is null. Example:<br>
 
<code>_test = [[objNull]] [[getVariable]] ["test", "0"];
 
<code>_test = [[objNull]] [[getVariable]] ["test", "0"];
 
[[systemChat]] _test;</code>
 
[[systemChat]] _test;</code>
Errors because _test is undefined. Tested in A2OA 1.63.131129
+
Errors because _test is undefined. Tested in {{arma2oa}} 1.63.131129
 
</dd>
 
</dd>
  
 +
<dt><dt>
 
<dd class="notedate">Posted on August 31, 2017 - 03:29 (UTC)</dd>
 
<dd class="notedate">Posted on August 31, 2017 - 03:29 (UTC)</dd>
 
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
 
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
Line 111: Line 120:
 
</dd>
 
</dd>
  
<!-- Note Section END -->
 
 
</dl>
 
</dl>
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
{{GameCategory|arma1|Scripting Commands}}
 
{{GameCategory|arma2|Scripting Commands}}
 
{{GameCategory|arma3|Scripting Commands}}
 
{{GameCategory|tkoh|Scripting Commands}}
 

Latest revision as of 00:55, 8 August 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)
Code Since Code Since
Namespace getVariable String - Namespace getVariable Array Arma 2: Operation Arrowhead v1.60
Object getVariable String - Object getVariable Array -
Group getVariable String - Group getVariable Array -
Team Member getVariable String - Team Member getVariable Array -
Task getVariable String - Task getVariable Array Arma 3 v1.68
Location getVariable String - Location getVariable Array Arma 3 v1.68
Control getVariable String - Control getVariable Array Arma 3 v1.56
Display getVariable String Arma 3 v1.56 Display getVariable Array Arma 3 v1.56
When variable is set on a Task, it is not actually set on the task itself, but on the FSM attached to the task.
If there is no FSM, getVariable will not work.
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 in given namespace
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 in given namespace
defaultValue: Anything - Value to return if variable doesn't exist
A dynamic defaultValue e.g. random 500 will always be executed, even if the variable is defined.
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:
for "_i" from 0 to 5 do { _car = missionNamespace getVariable ("car" + str _i); _car setDamage 0; };// Set damage of car0..car5 to 0
Example 4:
myMissionVar = 2015; missionNamespace getVariable "myMissionVar"; // Returns 2015
Example 5:
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
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 namespace is an object and that object is null. Example:
_test = objNull getVariable ["test", "0"]; systemChat _test; Errors because _test is undefined. Tested in Arma 2: Operation Arrowhead 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", "", [""]]];