getVariable

1.00

  

Click on the images for descriptions

Introduced in

Game:

Armed Assault

Version:

1.00

Description

Description:

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

All available data types combinations:

• Namespace getVariable String
• Namespace getVariable Array (since 1.60)
• Control getVariable String
• Object getVariable String
• Object getVariable Array
• Group getVariable String
• Group getVariable Array
• Team_Member getVariable String
• Team_Member getVariable Array
• Task getVariable String
• Location getVariable String

Syntax

Syntax:

object getVariable name

Parameters:

object: Object or Location

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: Object or Location

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;

Additional Information

Multiplayer:

-

See also:

setVariable

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To