Difference between revisions of "getVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-9_]+)\]\]([^<]*) *<\/code>" to "<code>$1$2$3</code>")
m (Some wiki formatting)
 
(12 intermediate revisions by the same user not shown)
Line 49: Line 49:
 
{{!}}}
 
{{!}}}
  
{{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>
+
{{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.)}}
Line 59: Line 59:
 
|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 in given namespace
+
|p2= name: [[String]] - variable name in given namespace
  
 
|r1= [[Anything]] or [[Nothing]] if the variable doesn't exist
 
|r1= [[Anything]] or [[Nothing]] if the variable doesn't exist
Line 67: Line 67:
 
|p21= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]]
 
|p21= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]]
  
|p22= name: [[String]] - Variable name in given namespace
+
|p22= name: [[String]] - variable name in given namespace
  
|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.}}
+
|p23= defaultValue: [[Anything]] - value to return if variable doesn't exist {{Feature|warning|A dynamic ''defaultValue'' e.g <sqf inline>random 500</sqf> 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"; // returns nil if "myVariable" is not set</code>
+
|x1= <sqf>private _variable = myTruck getVariable "myVariable"; // returns nil if "myVariable" is not set</sqf>
  
|x2= <code>private _variable = myTruck getVariable ["myVariable", 50]; // returns 50 if "myVariable" is not set</code>
+
|x2= <sqf>private _variable = myTruck getVariable ["myVariable", 50]; // returns 50 if "myVariable" is not set</sqf>
  
|x3=  
+
|x3= <sqf>
<code>for "_i" from 0 to 5 do {
+
for "_i" from 0 to 5 do
_car = missionNamespace [[getVariable]] ("car" [[valuea_plus_valueb|+]] [[str]] _i);
+
{
_car [[setDamage]] 0;
+
_car = missionNamespace getVariable ("car" + str _i);
};// Set damage of car0..car5 to 0</code>
+
_car setDamage 0;
 +
}; // Set damage of car0..car5 to 0
 +
</sqf>
  
|x4= <code>myMissionVar = 2015;
+
|x4= <sqf>
missionNamespace getVariable "myMissionVar"; // Returns 2015</code>
+
myMissionVar = 2015;
 +
missionNamespace getVariable "myMissionVar"; // returns 2015
 +
</sqf>
  
 
|x5= Get current value of a variable and if it is undefined, define it and get the defined value:
 
|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";
+
<sqf>
[[if]] ([[isNil]] "_var") [[then]]
+
private _var = missionNamespace getVariable "varName";
 +
if (isNil "_var") then
 
{
 
{
[[missionNamespace]] [[setVariable]] ["varName", 123];
+
missionNamespace setVariable ["varName", 123];
 
_var = 123;
 
_var = 123;
 
};
 
};
// _var here will contain current value of the variable varName</code>
+
// _var here will contain current value of the variable varName
 +
</sqf>
  
 
|seealso= [[setVariable]] [[allVariables]] [[getFSMVariable]]
 
|seealso= [[setVariable]] [[allVariables]] [[getFSMVariable]]
 
}}
 
}}
  
<dl class="command_description">
+
{{Note
 
+
|user= Ebay
<dt><dt>
+
|timestamp= 20160813171300
<dd class="notedate">Posted on August 13, 2016 - 17:13 (UTC)</dd>
+
|text= '''NOTE: {{arma2}} only! In {{arma3}} this will return default value:'''
<dt class="note">[[User:Ebay|Ebay]]</dt>
 
<dd class="note">
 
'''NOTE: {{arma2}} only! In {{arma3}} this will return default value:'''
 
 
Warning: the alternative syntax returns undefined when the namespace 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"];
+
<sqf>_test = objNull getVariable ["test", "0"];
systemChat _test;</code>
+
systemChat _test;</sqf>
 
Errors because _test is undefined. Tested in {{arma2oa}} 1.63.131129
 
Errors because _test is undefined. Tested in {{arma2oa}} 1.63.131129
</dd>
+
}}
  
<dt><dt>
+
{{Note
<dd class="notedate">Posted on August 31, 2017 - 03:29 (UTC)</dd>
+
|user= AgentRev
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
+
|timestamp= 20170831032900
<dd class="note">
+
|text= You can do typechecking using [[param]]:
You can do typechecking using [[param]]:
+
<sqf>private _myVar = [player getVariable "myVar"] param [0, "", [""]];</sqf>
<code>private _myVar = [<nowiki/>player getVariable "myVar"] param [0, "", [""]];</code>
 
 
and [[params]]:
 
and [[params]]:
<code><nowiki>[</nowiki>player getVariable "myVar"] params [["_myVar", "", [""]]];</code>
+
<sqf>[player getVariable "myVar"] params [["_myVar", "", [""]]];</sqf>
</dd>
+
}}
 
 
</dl>
 

Latest revision as of 02:34, 19 July 2022

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:
VariablesNamespacesMultiplayer

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:
setVariable allVariables getFSMVariable

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 Aug 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 Aug 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", "", [""]]];