getVariable: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "Category:Scripting Commands ArmA2" to "Category:Scripting Commands Arma 2") |
Lou Montana (talk | contribs) m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}") |
||
(12 intermediate revisions by 2 users not shown) | |||
Line 2: | Line 2: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| | | arma1 |Game name= | ||
|1.00|Game version= | |1.00|Game version= | ||
|arg= global |Multiplayer Arguments= | |arg= global |Multiplayer Arguments= | ||
|gr1= Multiplayer |GROUP1= | |||
|gr2= Variables |GROUP2= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Returns the value of variable in the variable space assigned to various data types. | | 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{{=}}" | {{{!}} class{{=}}"wikitable" | ||
! Primary syntax ([[String]]) | ! Primary syntax ([[String]]) | ||
! Alternative syntax ([[Array]]) | ! Alternative syntax ([[Array]]) | ||
Line 37: | Line 41: | ||
{{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> | {{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.)}} |DESCRIPTION= | * Variable namespace is null ([[objNull]], [[grpNull]], etc.)}} |DESCRIPTION= | ||
Line 99: | Line 103: | ||
<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 varspace 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> | ||
Line 109: | Line 113: | ||
<dd class="note"> | <dd class="note"> | ||
You can do typechecking using [[param]]: | You can do typechecking using [[param]]: | ||
<code>[[private]] _myVar = <nowiki | <code>[[private]] _myVar = [<nowiki/>[[player]] [[getVariable]] "myVar"] [[param]] [0, "", [""]];</code> | ||
and [[params]]: | and [[params]]: | ||
<code><nowiki>[</nowiki>[[player]] [[getVariable]] "myVar"] [[params]] [["_myVar", "", [""]]];</code> | <code><nowiki>[</nowiki>[[player]] [[getVariable]] "myVar"] [[params]] [["_myVar", "", [""]]];</code> | ||
Line 119: | Line 123: | ||
<h3 style="display:none">Bottom Section</h3> | <h3 style="display:none">Bottom Section</h3> | ||
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | [[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]] | ||
{{GameCategory|arma1|Scripting Commands}} | |||
{{GameCategory|arma2|Scripting Commands}} | |||
{{GameCategory|arma3|Scripting Commands}} | |||
{{GameCategory|tkoh|Scripting Commands}} | |||
[[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]] | [[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]] |
Revision as of 03:39, 10 January 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) - 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:
- MultiplayerVariables
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", "", [""]]];
Bottom Section
Categories:
- Scripting Commands
- Introduced with Armed Assault version 1.00
- ArmA: Armed Assault: New Scripting Commands
- ArmA: Armed Assault: Scripting Commands
- Command Group: Multiplayer
- Command Group: Variables
- Arma 2: Scripting Commands
- Arma 3: Scripting Commands
- Take On Helicopters: Scripting Commands
- Command Group: Locations