getFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. ArmA2 classification)
 
m (Some wiki formatting)
 
(59 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{RV|type=command


[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
|game1= arma2
|version1= 1.00
 
|game2= arma2oa
|version2= 1.50
 
|game3= tkoh
|version3= 1.00
 
|game4= arma3
|version4= 0.50
 
|gr1= Variables
 
|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
 
|p1= FSMhandle: [[Number]]
 
|p2= name: [[String]] - name of the variable
 
|r1= [[Anything]]
 
|s2= FSMhandle [[getFSMVariable]] [name, defaultValue]
 
|s2since= arma3 1.68
 
|p21= FSMhandle: [[Number]]
 
|p22= name: [[String]] - name of the variable
 
|p23= defaultValue: [[Anything]] - value to return if variable is [[nil]]
 
|r2= [[Anything]]
 
|x1= <sqf>_handle getFSMVariable "_foo";</sqf>
 
|x2= <sqf>_handle getFSMVariable ["_foo", 123];</sqf>
 
|seealso= [[FSM]] [[commandFSM]] [[completedFSM]] [[doFSM]] [[execFSM]] [[setFSMVariable]]
}}

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