getFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix bad regex effects)
Tag: Undo
m (Fix bad regex effects)
Line 14: Line 14:
| FSMhandle '''getFSMVariable''' name |SYNTAX=
| FSMhandle '''getFSMVariable''' name |SYNTAX=


|p1= FSMhandle: [[Number]] |PARAMETER1=  
|p1= FSMhandle: [[Number]] |PARAMETER1=  


|p2= name: [[String]] - name of the variable |PARAMETER2=  
|p2= name: [[String]] - name of the variable |PARAMETER2=  
Line 24: Line 24:
|p21= [name, defaultValue]: [[Array]] -  |PARAMETER21=  
|p21= [name, defaultValue]: [[Array]] -  |PARAMETER21=  


|p22=|PARAMETER22=
|p22= FSMhandle: [[Number]] |PARAMETER22=


|p23= name: [[String]] - name of the variable |PARAMETER23=  
|p23= name: [[String]] - name of the variable |PARAMETER23=  


|p24= defaultValue: [[Anything]] - value to return if variable is [[nil]]|PARAMETER24=  
|p24= defaultValue: [[Anything]] - value to return if variable is [[nil]]|PARAMETER24=  

Revision as of 01:10, 25 September 2020

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:
Variables

Syntax

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

Alternative Syntax

Syntax:
FSMhandle getFSMVariable [name, defaultValue] Template:since
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