getVariable: Difference between revisions
Jump to navigation
Jump to search
Waffle SS. (talk | contribs) No edit summary |
Lou Montana (talk | contribs) m (Text replacement - ";[ ]+ " to "; ") |
||
(71 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| | |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 | |||
|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: | ||
{{{!}} class="wikitable" | |||
!colspan="2"{{!}}Primary syntax ([[String]]) !! colspan="2"{{!}}Alternative syntax ([[Array]]) | |||
{{!}}- | |||
{{!}}'''Code''' | |||
{{!}}'''Since''' | |||
{{!}}'''Code''' | |||
{{!}}'''Since''' | |||
{{!}}- | |||
{{!}} [[Namespace]] getVariable [[String]] {{!}}{{!}} - {{!}}{{!}} [[Namespace]] getVariable [[Array]] {{!}}{{!}} {{arma2oa}} 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]] {{!}}{{!}} {{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 | |||
{{!}}} | |||
| | {{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.)}} | |||
| | |s1= varspace [[getVariable]] name | ||
| | |p1= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]] | ||
| [[ | |p2= name: [[String]] - Variable name in given namespace | ||
| | |r1= [[Anything]] or [[Nothing]] if the variable doesn't exist | ||
| | |s2= varspace [[getVariable]] [name, defaultValue] | ||
| | |p21= varspace: [[Namespace]], [[Object]], [[Display]], [[Control]], [[Group]], [[Location]], [[Task]], [[Team Member]], [[Display]], [[Control]] | ||
| | |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.}} | ||
| | |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> | ||
|x3= <code>[[for]] "_i" [[from]] 0 [[to]] 5 [[do]] { | |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]] { | ||
_car = [[missionNamespace]] [[getVariable]] ("car" [[valuea_plus_valueb|+]] [[str]] _i); | |||
_car [[setDamage]] 0; | |||
};{{cc|Set damage of car0..car5 to 0}}</code> | |||
|x4= <code>myMissionVar = 2015; | |x4= <code>myMissionVar = 2015; | ||
[[missionNamespace]] [[getVariable]] "myMissionVar"; | [[missionNamespace]] [[getVariable]] "myMissionVar"; {{cc|Returns 2015}}</code> | ||
| [[ | |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"; | ||
[[if]] ([[isNil]] "_var") [[then]] | |||
{ | |||
[[missionNamespace]] [[setVariable]] ["varName", 123]; | |||
_var = 123; | |||
}; | |||
{{cc|_var here will contain current value of the variable varName}}</code> | |||
|seealso= [[setVariable]], [[allVariables]], [[getFSMVariable]] | |||
}} | }} | ||
<dl class="command_description"> | <dl class="command_description"> | ||
< | <dt><dt> | ||
[[ | <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 namespace 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 {{arma2oa}} 1.63.131129 | |||
</dd> | |||
< | <dt><dt> | ||
< | <dd class="notedate">Posted on August 31, 2017 - 03:29 (UTC)</dd> | ||
<dd class="notedate">Posted on | <dt class="note">[[User:AgentRevolution|AgentRev]]</dt> | ||
<dt class="note">[[User: | |||
<dd class="note"> | <dd class="note"> | ||
You can do typechecking using [[param]]: | |||
<code>[[private]] _myVar = [<nowiki/>[[player]] [[getVariable]] "myVar"] [[param]] [0, "", [""]];</code> | |||
and [[params]]: | |||
<code><nowiki>[</nowiki>[[player]] [[getVariable]] "myVar"] [[params]] [["_myVar", "", [""]]];</code> | |||
</dd> | |||
</dl> | </dl> | ||
Revision as of 01:55, 8 August 2021
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 - 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
- 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", "", [""]]];
Categories:
- Scripting Commands
- Introduced with Armed Assault version 1.00
- ArmA: Armed Assault: New Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Arma 2: Scripting Commands
- Arma 2: Operation Arrowhead: Scripting Commands
- Take On Helicopters: Scripting Commands
- Arma 3: Scripting Commands
- Command Group: Multiplayer
- Command Group: Variables