Difference between revisions of "getVariable"

From Bohemia Interactive Community
Jump to navigation Jump to search
(support for control and display)
(example warning)
Line 59: Line 59:
 
|x4= <code>myMissionVar = 2015;
 
|x4= <code>myMissionVar = 2015;
 
[[missionNamespace]] [[getVariable]] "myMissionVar";//Returns 2015</code>|= Example 4
 
[[missionNamespace]] [[getVariable]] "myMissionVar";//Returns 2015</code>|= Example 4
 +
 +
|x5= WARNING when using dynamic default value: <code>[[missionNamespace]] [[getVariable]] ["var", 123 [[call]] fnc_abc];
 +
/// fnc_abc is always called even when '''var''' is defined</code>|=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  

Revision as of 22:52, 4 December 2015

Introduced with Armed Assault version 1.001.00Arguments of this scripting command don't have to be local to the client the command is executed on
Hover & click on the images for descriptions

Description

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

All available data types combinations:

Syntax

Syntax:
varspace getVariable name
Parameters:
varspace: Namespace, Object, Display, Control, Group, Location, Task or Team Member
name: String - Variable name that was defined in setVariable (Case sensitive)
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 or Team Member
name: String - Variable name that was defined in setVariable (Case sensitive)
defaultValue: Anything - Value to return if variable doesn't exist
Return Value:
Anything or defaultValue if the variable doesn't exist

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
Example 5:
WARNING when using dynamic default value: missionNamespace getVariable ["var", 123 call fnc_abc]; /// fnc_abc is always called even when var is defined

Additional Information

See also:
setVariableallVariables

Notes

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

Notes

Bottom Section