getFSMVariable: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(add. classification)
m (Some wiki formatting)
 
(55 intermediate revisions by 7 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


| Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the execFSM command. |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| FSM handle '''getFSMVariable''' name |= Syntax
|game4= arma3
|version4= 0.50


|p1= FSM handle: [[Number]] -  |= PARAMETER1
|gr1= Variables


|p2= name: [[String]] -  |= PARAMETER2
|descr= Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the [[execFSM]] command.


|p3= |= PARAMETER3
|s1= FSMhandle [[getFSMVariable]] name


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


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


|x1= <code>(example)</code>|= EXAMPLE1
|r1= [[Anything]]


____________________________________________________________________________________________
|s2= FSMhandle [[getFSMVariable]] [name, defaultValue]


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


| |= MPBEHAVIOUR
|p21= FSMhandle: [[Number]]
____________________________________________________________________________________________
 
}}
|p22= name: [[String]] - name of the variable
 
|p23= defaultValue: [[Anything]] - value to return if variable is [[nil]]
 
|r2= [[Anything]]


<h3 style='display:none'>Notes</h3>
|x1= <sqf>_handle getFSMVariable "_foo";</sqf>
<dl class='command_description'>
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x2= <sqf>_handle getFSMVariable ["_foo", 123];</sqf>
</dl>


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[FSM]] [[commandFSM]] [[completedFSM]] [[doFSM]] [[execFSM]] [[setFSMVariable]]
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

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