getFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| ?p22 ?=.*\|PARAMETER1= *" to " |p22=$1|PARAMETER22=")
m (Fix bad regex effects)
Tag: Undo
Line 17: Line 17:


|p2= name: [[String]] - name of the variable |PARAMETER2=  
|p2= name: [[String]] - name of the variable |PARAMETER2=  
|p3= |PARAMETER3=


| [[Anything]] |RETURNVALUE=  
| [[Anything]] |RETURNVALUE=  


| s2= FSMhandle '''getFSMVariable''' [name, defaultValue]        (''Since Arma 3 v1.67'') |SYNTAX2=
|s2= FSMhandle '''getFSMVariable''' [name, defaultValue] {{since|arma3|1.67|y}} |SYNTAX2=


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


|p22=|PARAMETER22=  
|p22=|PARAMETER22=


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


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


|r2=(.*)|RETURNVALUE2=  
|r2= [[Anything]] |RETURNVALUE2=


|x1= <code>_handle [[getFSMVariable]] "_foo";</code>|EXAMPLE1=


|x1= <code>_handle [[getFSMVariable]] "_foo";</code>|EXAMPLE1=
|x2=<code>_handle [[getFSMVariable]] ["_foo", 123];</code> |EXAMPLE2=
|x2=|EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[FSM]], [[commandFSM]], [[completedFSM]], [[doFSM]] [[execFSM]], [[setFSMVariable]] |SEEALSO=  
| [[FSM]], [[commandFSM]], [[completedFSM]], [[doFSM]] [[execFSM]], [[setFSMVariable]] |SEEALSO=  


|  |MPBEHAVIOUR=  
|  |MPBEHAVIOUR=
____________________________________________________________________________________________
____________________________________________________________________________________________
}}
}}
Line 54: Line 52:
<h3 style='display:none'>Bottom Section</h3>
<h3 style='display:none'>Bottom Section</h3>


[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 21:21, 24 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 -
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