getFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix bad regex effects)
Tag: Undo
m (Some wiki formatting)
 
(35 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
|version2= 1.50


|gr1= Variables |GROUP1=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


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


| FSMhandle '''getFSMVariable''' name |SYNTAX=
|gr1= Variables


|p1= FSMhandle: [[Number]] -  |PARAMETER1=
|descr= Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the [[execFSM]] command.


|p2= name: [[String]] - name of the variable |PARAMETER2=
|s1= FSMhandle [[getFSMVariable]] name


| [[Anything]] |RETURNVALUE=
|p1= FSMhandle: [[Number]]


|s2= FSMhandle '''getFSMVariable''' [name, defaultValue] {{since|arma3|1.67|y}} |SYNTAX2=
|p2= name: [[String]] - name of the variable


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


|p22=|PARAMETER22=
|s2= FSMhandle [[getFSMVariable]] [name, defaultValue]


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


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


|r2= [[Anything]] |RETURNVALUE2=
|p22= name: [[String]] - name of the variable


|x1= <code>_handle [[getFSMVariable]] "_foo";</code>|EXAMPLE1=
|p23= defaultValue: [[Anything]] - value to return if variable is [[nil]]


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


| [[FSM]], [[commandFSM]], [[completedFSM]], [[doFSM]] [[execFSM]], [[setFSMVariable]] |SEEALSO=  
|x1= <sqf>_handle getFSMVariable "_foo";</sqf>


| |MPBEHAVIOUR=
|x2= <sqf>_handle getFSMVariable ["_foo", 123];</sqf>
____________________________________________________________________________________________
 
|seealso= [[FSM]] [[commandFSM]] [[completedFSM]] [[doFSM]] [[execFSM]] [[setFSMVariable]]
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style='display:none'>Bottom Section</h3>
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 21:25, 4 September 2022

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
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]
Parameters:
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:
FSM commandFSM completedFSM doFSM execFSM setFSMVariable

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
Retrieved from "https://community.bistudio.com/wiki?title=getFSMVariable&oldid=330370"