getFSMVariable

From Bohemia Interactive Community
Revision as of 19:08, 18 January 2017 by Killzone Kid (talk | contribs) (support for default value)
Jump to navigation Jump to search
Hover & click on the images for description

Description

Description:
Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the execFSM command.
Groups:
Uncategorised

Syntax

Syntax:
FSMhandle getFSMVariable name
Parameters:
FSMhandle: Number -
name: String - name of the variable
Return Value:
Anything

Alternative Syntax

Syntax:
FSMhandle getFSMVariable [name, defaultValue]        (Since Arma 3 v1.67)
Parameters:
[name, defaultValue]: Array -
FSMhandle: Number -
name: String - name of the variable
defaultValue: Anything - value to return if variable is nil
Return Value:
Anything

Examples

Example 1:
_handle getFSMVariable "_foo";
Example 2:
_handle getFSMVariable ["_foo", 123];

Additional Information

See also:
FSMcommandFSMcompletedFSMdoFSM execFSMsetFSMVariable

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