getFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (template:command argument fix)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the execFSM command. |= Description
| Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the execFSM command. |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| FSMhandle '''getFSMVariable''' name |= Syntax
| FSMhandle '''getFSMVariable''' name |SYNTAX=


|p1= FSMhandle: [[Number]] -  |PARAMETER1=  
|p1= FSMhandle: [[Number]] -  |PARAMETER1=  
Line 20: Line 20:
| [[Anything]] |RETURNVALUE=  
| [[Anything]] |RETURNVALUE=  


| s2= FSMhandle '''getFSMVariable''' [name, defaultValue]        (''Since Arma 3 v1.67'') |= Syntax
| s2= FSMhandle '''getFSMVariable''' [name, defaultValue]        (''Since Arma 3 v1.67'') |SYNTAX=


|p21= [name, defaultValue]: [[Array]] -  |PARAMETER2=  
|p21= [name, defaultValue]: [[Array]] -  |PARAMETER2=  

Revision as of 14:40, 7 April 2019

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