getFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *(([^=\| ]+)('''|\[\[)([^=\| ]+)) * \|p1=" to " |s1= $1 |p1=")
m (Some wiki formatting)
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2
|game1= arma2
|1.00
|version1= 1.00


|game2= arma2oa
|game2= arma2oa
Line 15: Line 15:
|gr1= Variables
|gr1= Variables


| Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the [[execFSM]] command.
|descr= Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the [[execFSM]] command.


|s1= FSMhandle '''getFSMVariable''' name
|s1= FSMhandle [[getFSMVariable]] name


|p1= FSMhandle: [[Number]]
|p1= FSMhandle: [[Number]]
Line 25: Line 25:
|r1= [[Anything]]
|r1= [[Anything]]


|s2= FSMhandle [[getFSMVariable]] [name, defaultValue] {{Since|arma3|1.67|y}}
|s2= FSMhandle [[getFSMVariable]] [name, defaultValue]


|p21= [name, defaultValue]: [[Array]] -
|s2since= arma3 1.68


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


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


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


|r2= [[Anything]]
|r2= [[Anything]]


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


|x2=<code>_handle [[getFSMVariable]] ["_foo", 123];</code>
|x2= <sqf>_handle getFSMVariable ["_foo", 123];</sqf>


|seealso= [[FSM]], [[commandFSM]], [[completedFSM]], [[doFSM]] [[execFSM]], [[setFSMVariable]]
|seealso= [[FSM]] [[commandFSM]] [[completedFSM]] [[doFSM]] [[execFSM]] [[setFSMVariable]]
}}
}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 21:25, 4 September 2022

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