Difference between revisions of "getVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|PARAMETER3= |r2=" to "|PARAMETER23= |r2=")
m (Text replacement - "</dd> </dl>" to "</dd> </dl>")
 
(37 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| arma |Game name=
+
|game1= arma1
|1.00|Game version=
+
|version1= 1.00
|arg= global|Multiplayer Arguments=
 
____________________________________________________________________________________________
 
  
| Return the value of variable in the variable space assigned to various data types. In case of Alt Syntax usage in Arma 3, the default value will be returned if:
+
|game2= arma2
* Requested variable is either undefined or [[nil]]
+
|version2= 1.00
* Variable namespace is null ([[objNull]], [[grpNull]], etc.)
+
 
 +
|game3= arma2oa
 +
|version3= 1.50
 +
 
 +
|game4= tkoh
 +
|version4= 1.00
 +
 
 +
|game5= arma3
 +
|version5= 0.50
 +
 
 +
|arg= global
 +
 
 +
|gr1= Multiplayer
 +
 
 +
|gr2= Variables
 +
 
 +
|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:
* [[Namespace]] getVariable [[String]]
+
{{{!}} class="wikitable"
* [[Namespace]] getVariable [[Array]] (since {{Name|a2}} 1.60)
+
!colspan="2"{{!}}Primary syntax ([[String]]) !! colspan="2"{{!}}Alternative syntax ([[Array]])
* [[Object]] getVariable [[String]]
+
{{!}}-
* [[Object]] getVariable [[Array]]
+
{{!}}'''Code'''
* [[Group]] getVariable [[String]]
+
{{!}}'''Since'''
* [[Group]] getVariable [[Array]]
+
{{!}}'''Code'''
* [[Team_Member]] getVariable [[String]]
+
{{!}}'''Since'''
* [[Team_Member]] getVariable [[Array]]
+
{{!}}-
* [[Task]] getVariable [[String]]
+
{{!}} [[Namespace]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Namespace]] getVariable [[Array]] {{!}}{{!}} {{arma2oa}} v1.60
* [[Task]] getVariable [[Array]] (Since Arma 3 v1.67)
+
{{!}}-
* [[Location]] getVariable [[String]]
+
{{!}} [[Object]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Object]] getVariable [[Array]] {{!}}{{!}} -
* [[Location]] getVariable [[Array]] (Since Arma 3 v1.67)
+
{{!}}-
* [[Control]] getVariable [[String]] (since Arma 3 v1.55.133553)
+
{{!}} [[Group]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Group]] getVariable [[Array]] {{!}}{{!}} -
* [[Control]] getVariable [[Array]] (since Arma 3 v1.55.133553)
+
{{!}}-
* [[Display]] getVariable [[String]] (since Arma 3 v1.55.133553)
+
{{!}} [[Team Member]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Team Member]] getVariable [[Array]] {{!}}{{!}} -
* [[Display]] getVariable [[Array]] (since Arma 3 v1.55.133553)
+
{{!}}-
When variable is set on [[Task]], it is not actually set on task itself, but on FSM attached to the task. So if there is no FSM [[getVariable]] will not work. |DESCRIPTION=
+
{{!}} [[Task]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Task]] getVariable [[Array]] {{!}}{{!}} {{arma3}} v1.68
____________________________________________________________________________________________
+
{{!}}-
 +
{{!}} [[Location]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Location]] getVariable [[Array]] {{!}}{{!}} {{arma3}} v1.68
 +
{{!}}-
 +
{{!}} [[Control]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Control]] getVariable [[Array]] {{!}}{{!}} {{arma3}} v1.56
 +
{{!}}-
 +
{{!}} [[Display]] getVariable [[String]] {{!}}{{!}} {{arma3}} v1.56 {{!}}{{!}} [[Display]] getVariable [[Array]] {{!}}{{!}} {{arma3}} v1.56
 +
{{!}}}
  
| varspace '''getVariable''' name |SYNTAX=
+
{{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.}}
 +
{{Feature | arma3 | In the case of Alt Syntax usage in {{arma3}}, ''defaultValue'' will be returned if:
 +
* Requested variable is either undefined or [[nil]]
 +
* Variable namespace is null ([[objNull]], [[grpNull]], etc.)}}
  
|p1= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]] |PARAMETER1=
+
|s1= varspace [[getVariable]] name
  
|p2= name: [[String]] - Variable name that was defined in [[setVariable]] |PARAMETER2=
+
|p1= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]]
  
| [[Anything]] or [[Nothing]] if the variable doesn't exist |RETURNVALUE=
+
|p2= name: [[String]] - Variable name in given namespace
____________________________________________________________________________________________
 
  
|s2= varspace '''getVariable''' [name, defaultValue] |SYNTAX2=
+
|r1= [[Anything]] or [[Nothing]] if the variable doesn't exist
  
|p21= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]] |PARAMETER21=
+
|s2= varspace [[getVariable]] [name, defaultValue]
  
|p22= [name, defaultValue]: [[Array]]
+
|p21= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]]
  
|p23= name: [[String]] - Variable name that was defined in [[setVariable]] |PARAMETER2=
+
|p22= name: [[String]] - Variable name in given namespace
  
|p24= 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. |RETURNVALUE= 2
+
|r2= [[Anything]] - Current value of the variable or ''defaultValue'' if the variable doesn't exist.
____________________________________________________________________________________________
 
  
|x1= <code>_thePublicVariable = _myTruck [[getVariable]] "myPublicVariable";</code> |EXAMPLE1=
+
|x1= <code>[[private]] _variable = myTruck [[getVariable]] "myVariable"; {{cc|returns [[nil]] if "myVariable" is not set}}</code>
  
|x2= <code>_aLocalVariable = _myTruck [[getVariable]] ["myLocalVariable", ["Not set", _var]<nowiki>]</nowiki> [[select]] 1;</code> |EXAMPLE2=
+
|x2= <code>[[private]] _variable = myTruck [[getVariable]] ["myVariable", 50]; {{cc|returns 50 if "myVariable" is not set}}</code>
  
|x3= <code>[[for]] "_i" [[from]] 0 [[to]] 5 [[do]] {
+
|x3=  
    _car = [[missionNamespace]] [[getVariable]] ("car" [[valuea_plus_valueb|+]] [[str]] _i);
+
<code>[[for]] "_i" [[from]] 0 [[to]] 5 [[do]] {
    _car [[setDamage]] 0;
+
_car = [[missionNamespace]] [[getVariable]] ("car" [[valuea_plus_valueb|+]] [[str]] _i);
};</code>
+
_car [[setDamage]] 0;
Sets damage of car0, car1, ..., car5 to 0. |EXAMPLE3=
+
};{{cc|Set damage of car0..car5 to 0}}</code>
  
 
|x4= <code>myMissionVar = 2015;
 
|x4= <code>myMissionVar = 2015;
[[missionNamespace]] [[getVariable]] "myMissionVar";//Returns 2015</code>|EXAMPLE4=
+
[[missionNamespace]] [[getVariable]] "myMissionVar"; {{cc|Returns 2015}}</code>
  
|x5= WARNING when using dynamic default value: <code>[[missionNamespace]] [[getVariable]] ["var", 123 [[call]] fnc_abc];
+
|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";
/// fnc_abc is always called even when '''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]]
 
{
 
{
Line 74: Line 92:
 
_var = 123;
 
_var = 123;
 
};
 
};
// _var here will contain current value of the variable varName</code> |EXAMPLE6=
+
{{cc|_var here will contain current value of the variable varName}}</code>
____________________________________________________________________________________________
 
 
 
| [[setVariable]], [[allVariables]], [[getFSMVariable]]|SEEALSO=
 
  
 +
|seealso= [[setVariable]], [[allVariables]], [[getFSMVariable]]
 
}}
 
}}
  
<h3 style="display:none">Notes</h3>
 
 
<dl class="command_description">
 
<dl class="command_description">
<!-- Note Section BEGIN -->
 
<!-- Note Section END -->
 
</dl>
 
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|GETVARIABLE]]
 
[[Category:Scripting Commands ArmA|GETVARIABLE]]
 
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
  
<!-- CONTINUE Notes -->
+
<dt><dt>
<dl class="command_description">
 
 
<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: Arma 2 ONLY! In Arma 3 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>
</dl>
 
<!-- DISCONTINUE Notes -->
 
  
<!-- CONTINUE Notes -->
+
<dt><dt>
<dl class="command_description">
 
 
<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>
 
<dd class="note">
 
<dd class="note">
 
You can do typechecking using [[param]]:
 
You can do typechecking using [[param]]:
<code>private _myVar = [player getVariable "myVar"] param [0,"",[""]];</code>
+
<code>[[private]] _myVar = [<nowiki/>[[player]] [[getVariable]] "myVar"] [[param]] [0, "", [""]];</code>
 
and [[params]]:
 
and [[params]]:
<code>[player getVariable "myVar"] params [["_myVar","",[""]]];</code>
+
<code><nowiki>[</nowiki>[[player]] [[getVariable]] "myVar"] [[params]] [["_myVar", "", [""]]];</code>
 
</dd>
 
</dd>
 +
 
</dl>
 
</dl>
<!-- DISCONTINUE Notes -->
 

Latest revision as of 17:08, 13 June 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", "", [""]]];