getFSMVariable: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments( \("local" or "global"\))?|Effects|Multiplayer Effects( \("local" or "global"\))?|Multiplayer Exe...) |
||
Line 1: | Line 1: | ||
{{Command | {{Command | ||
| arma2 | | arma2 | ||
|1.00 | |1.00 | ||
|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. | | Return the value of variable in the variable space of given FSM. The FSM handle is the number returned by the execFSM command. | ||
| FSMhandle '''getFSMVariable''' name | | FSMhandle '''getFSMVariable''' name | ||
|p1= FSMhandle: [[Number]] | |p1= FSMhandle: [[Number]] | ||
|p2= name: [[String]] - name of the variable | |p2= name: [[String]] - name of the variable | ||
| [[Anything]] | | [[Anything]] | ||
|s2= FSMhandle '''getFSMVariable''' [name, defaultValue] {{Since|arma3|1.67|y}} | |s2= FSMhandle '''getFSMVariable''' [name, defaultValue] {{Since|arma3|1.67|y}} | ||
|p21= [name, defaultValue]: [[Array]] - |PARAMETER21= | |p21= [name, defaultValue]: [[Array]] - |PARAMETER21= | ||
Line 27: | Line 27: | ||
|p24= defaultValue: [[Anything]] - value to return if variable is [[nil]]|PARAMETER24= | |p24= defaultValue: [[Anything]] - value to return if variable is [[nil]]|PARAMETER24= | ||
|r2= [[Anything]] | |r2= [[Anything]] | ||
|x1= <code>_handle [[getFSMVariable]] "_foo";</code> | |x1= <code>_handle [[getFSMVariable]] "_foo";</code> | ||
|x2=<code>_handle [[getFSMVariable]] ["_foo", 123];</code> | |x2=<code>_handle [[getFSMVariable]] ["_foo", 123];</code> | ||
| [[FSM]], [[commandFSM]], [[completedFSM]], [[doFSM]] [[execFSM]], [[setFSMVariable]] | | [[FSM]], [[commandFSM]], [[completedFSM]], [[doFSM]] [[execFSM]], [[setFSMVariable]] | ||
| |MPBEHAVIOUR= | | |MPBEHAVIOUR= |
Revision as of 00:34, 18 January 2021
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 -
- 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
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