getVariable: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
Lou Montana (talk | contribs) m (Fix Category:Pages using duplicate arguments in template calls and presentation. Table improvements welcome) |
||
(63 intermediate revisions by 19 users not shown) | |||
Line 1: | Line 1: | ||
{{Command|= | {{Command|Comments= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| arma | | | arma |Game name= | ||
|1.00| | |1.00|Game version= | ||
|arg= global |Multiplayer Arguments= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | Returns the value of variable in the variable space assigned to various data types. | ||
All available data types combinations: | |||
{{{!}} class{{=}}"bikitable" | |||
! Primary syntax ([[String]]) | |||
! Alternative syntax ([[Array]]) | |||
{{!}}- | |||
{{!}} | |||
* [[Namespace]] getVariable [[String]] | |||
* [[Object]] getVariable [[String]] | |||
* [[Group]] getVariable [[String]] | |||
* [[Team_Member]] getVariable [[String]] | |||
* [[Task]] getVariable [[String]] | |||
* [[Location]] getVariable [[String]] | |||
* [[Control]] getVariable [[String]] (since {{arma3}} v1.55.133553) | |||
* [[Display]] getVariable [[String]] (since {{arma3}} v1.55.133553) | |||
{{!}} | |||
* [[Namespace]] getVariable [[Array]] (since {{arma2}} OA v1.60) | |||
* [[Object]] getVariable [[Array]] | |||
* [[Group]] getVariable [[Array]] | |||
* [[Team_Member]] getVariable [[Array]] | |||
* [[Task]] getVariable [[Array]] (since {{arma3}} v1.67) | |||
* [[Location]] getVariable [[Array]] (since {{arma3}} v1.67) | |||
* [[Control]] getVariable [[Array]] (since {{arma3}} v1.55.133553)) | |||
* [[Display]] getVariable [[Array]] (since {{arma3}} v1.55.133553) | |||
{{!}}} | |||
{{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.)}} |DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[ | | varspace [[getVariable]] name |SYNTAX= | ||
|p1= | |p1= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]] |PARAMETER1= | ||
|p2= name: [[String]] |= | |p2= name: [[String]] - variable name that was defined in [[setVariable]] |PARAMETER2= | ||
| [[ | | [[Anything]] or [[Nothing]] if the variable doesn't exist |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[ | |s2= varspace [[getVariable]] [name, defaultValue] |SYNTAX2= | ||
|p21= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]] |PARAMETER21= | |||
|p22= name: [[String]] - Variable name that was defined in [[setVariable]] |PARAMETER22= | |||
|p23= defaultValue: [[Anything]] - Value to return if variable doesn't exist |PARAMETER23= | |||
|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= | |||
|x2= <code>[[private]] _variable = myTruck [[getVariable]] ["myVariable", 50]; {{cc|returns 50 if "myVariable" is not set}}</code> |EXAMPLE2= | |||
|x3= Set damage of car0..car5 to 0: | |||
<code>[[for]] "_i" [[from]] 0 [[to]] 5 [[do]] { | |||
_car = [[missionNamespace]] [[getVariable]] ("car" [[valuea_plus_valueb|+]] [[str]] _i); | |||
_car [[setDamage]] 0; | |||
};</code> |EXAMPLE3= | |||
|x4= <code>myMissionVar = 2015; | |||
[[missionNamespace]] [[getVariable]] "myMissionVar"; {{cc|returns 2015}}</code>|EXAMPLE4= | |||
|x5= WARNING when using dynamic default values as they always get evaluated: | |||
<code>[[missionNamespace]] [[getVariable]] ["var", 123 [[call]] fnc_abc]; | |||
{{cc|fnc_abc is called every [[getVariable]] even if "var" is defined}}</code>|EXAMPLE5= | |||
|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]] | |||
{ | |||
[[missionNamespace]] [[setVariable]] ["varName", 123]; | |||
_var = 123; | |||
}; | |||
{{cc|_var here will contain current value of the variable varName}}</code> |EXAMPLE6= | |||
____________________________________________________________________________________________ | |||
| [[setVariable]], [[allVariables]], [[getFSMVariable]]|SEEALSO= | |||
}} | }} | ||
Line 27: | Line 94: | ||
<dl class="command_description"> | <dl class="command_description"> | ||
<!-- Note Section BEGIN --> | <!-- Note Section BEGIN --> | ||
<dd class="notedate">Posted on August | |||
<dt class="note">'''[[User: | <dd class="notedate">Posted on August 13, 2016 - 17:13 (UTC)</dd> | ||
<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 varspace is an object and that object is null. Example:<br /> | |||
<code>_test = [[objNull]] [[getVariable]] ["test", "0"]; | |||
[[systemChat]] _test;</code> | |||
Errors because _test is undefined. Tested in A2OA 1.63.131129 | |||
</dd> | |||
<dd class="notedate">Posted on August 31, 2017 - 03:29 (UTC)</dd> | |||
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt> | |||
<dd class="note"> | |||
You can do typechecking using [[param]]: | |||
<code>[[private]] _myVar = <nowiki>[</nowiki>[[player]] [[getVariable]] "myVar"] [[param]] [0, "", [""]];</code> | |||
and [[params]]: | |||
<code><nowiki>[</nowiki>[[player]] [[getVariable]] "myVar"] [[params]] [["_myVar", "", [""]]];</code> | |||
</dd> | |||
<!-- Note Section END --> | <!-- Note Section END --> | ||
</dl> | </dl> | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Scripting Commands| | [[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands ArmA| | [[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]] | |||
[[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]] | [[Category:Command_Group:_Variables|{{uc:{{PAGENAME}}}}]] | ||
[[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]] |
Revision as of 19:56, 5 September 2019
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) - Namespace getVariable Array (since Arma 2 OA v1.60)
- Object getVariable Array
- Group getVariable Array
- Team_Member getVariable Array
- Task getVariable Array (since Arma 3 v1.67)
- Location getVariable Array (since Arma 3 v1.67)
- Control getVariable Array (since Arma 3 v1.55.133553))
- Display getVariable Array (since Arma 3 v1.55.133553)
- Groups:
- Uncategorised
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", "", [""]]];