getVariable: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) |
Lou Montana (talk | contribs) m (Text replacement - "<sqf>([^↵][^\/]*↵[^\/]*)<\/sqf>" to "<sqf> $1 </sqf>") |
||
(31 intermediate revisions by 2 users not shown) | |||
Line 18: | Line 18: | ||
|arg= global | |arg= global | ||
|gr1= | |gr1= Variables | ||
|gr2= Namespaces | |||
| | |gr3= Multiplayer | ||
|descr= Returns the value of variable in the variable space assigned to various data types. | |descr= Returns the value of variable in the variable space assigned to various data types. | ||
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]] - | |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]] - | |p22= name: [[String]] - variable name in given namespace | ||
|p23= defaultValue: [[Anything]] - | |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]] - | |r2= [[Anything]] - current value of the variable or ''defaultValue'' if the variable doesn't exist. | ||
|x1= < | |x1= <sqf>private _variable = myTruck getVariable "myVariable"; // returns nil if "myVariable" is not set</sqf> | ||
|x2= < | |x2= <sqf>private _variable = myTruck getVariable ["myVariable", 50]; // returns 50 if "myVariable" is not set</sqf> | ||
|x3= | |x3= <sqf> | ||
< | for "_i" from 0 to 5 do | ||
_car = | { | ||
_car | _car = missionNamespace getVariable ("car" + str _i); | ||
}; | _car setDamage 0; | ||
}; // Set damage of car0..car5 to 0 | |||
</sqf> | |||
|x4= < | |x4= <sqf> | ||
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: | ||
<sqf> | |||
private _var = missionNamespace getVariable "varName"; | |||
if (isNil "_var") then | |||
{ | { | ||
missionNamespace setVariable ["varName", 123]; | |||
_var = 123; | _var = 123; | ||
}; | }; | ||
// _var here will contain current value of the variable varName | |||
</sqf> | |||
|seealso= [[setVariable]] [[allVariables]] | |seealso= [[setVariable]] [[allVariables]] [[getFSMVariable]] | ||
}} | }} | ||
{{Note | |||
|user= Ebay | |||
|timestamp= 20160813171300 | |||
|text= '''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 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> | ||
< | <sqf> | ||
_test = objNull getVariable ["test", "0"]; | |||
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 | ||
}} | |||
{{Note | |||
|user= AgentRev | |||
|timestamp= 20170831032900 | |||
|text= You can do typechecking using [[param]]: | |||
You can do typechecking using [[param]]: | <sqf>private _myVar = [player getVariable "myVar"] param [0, "", [""]];</sqf> | ||
< | |||
and [[params]]: | and [[params]]: | ||
< | <sqf>[player getVariable "myVar"] params [["_myVar", "", [""]]];</sqf> | ||
}} | |||
Latest revision as of 11:34, 3 September 2024
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:
- 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
- Return Value:
- Anything - current value of the variable or defaultValue if the variable doesn't exist.
Examples
- Example 1:
- Example 2:
- Example 3:
- Example 4:
- 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)
-
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:
Errors because _test is undefined. Tested in Arma 2: Operation Arrowhead 1.63.131129
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: Variables
- Command Group: Namespaces
- Command Group: Multiplayer