getVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(moving to talk)
Line 76: Line 76:
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<dd class="notedate">Posted on May 17, 2015 - 20:42 (UTC)</dd>
<dt class="note">[[User:Waffle SS.|Waffle SS.]]</dt>
<dd class="note">
'''defaultValue''' is processed even if the default isn't used.
<code>[[player]] '''getVariable''' ["yolo",call {[[hint]] "!"; [[true]]}];</code>
The [[hint]] will '''always''' print, even if the "yolo" variable exists.
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 23:32, 17 May 2015

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Return the value of variable in the variable space of given object or location.

All available data types combinations:
Groups:
Uncategorised

Syntax

Syntax:
object getVariable name
Parameters:
object: Control, Group, Location, Namespace, Object, Task or Team Member
name: String - Variable name that was defined in setVariable (Case sensitive)
Return Value:
Any Value
Returns Nothing if the variable doesn't exist.
Returns Anything if the object is undefined.

Alternative Syntax

Syntax:
object getVariable [name, defaultValue]
Parameters:
object: Group, Namespace, Object or Team Member
name: String - Variable name that was defined in setVariable (Case sensitive)
defaultValue: Any Value - Value to return if variable doesn't exist
Return Value:
Any Value
Returns defaultValue if the variable doesn't exist.
Returns Anything if the object is undefined.

Examples

Example 1:
_thePublicVariable = _myTruck getVariable "myPublicVariable";
Example 2:
_aLocalVariable = _myTruck getVariable ["myLocalVariable", ["Not set", _var]] select 1;
Example 3:
for "_i" from 0 to 5 do { _car = missionNamespace getVariable ("car" + str _i); _car setDamage 0; }; Sets damage of car0, car1, ..., car5 to 0.
Example 4:
myMissionVar = 2015; missionNamespace getVariable "myMissionVar";//Returns 2015

Additional Information

See also:
setVariableallVariables

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

Bottom Section