getFSMVariable: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) (support for default value) |
m (template:command argument fix) |
||
| Line 12: | Line 12: | ||
| FSMhandle '''getFSMVariable''' name |= Syntax | | FSMhandle '''getFSMVariable''' name |= Syntax | ||
|p1= FSMhandle: [[Number]] - |= | |p1= FSMhandle: [[Number]] - |PARAMETER1= | ||
|p2= name: [[String]] - name of the variable |= | |p2= name: [[String]] - name of the variable |PARAMETER2= | ||
|p3= |= | |p3= |PARAMETER3= | ||
| [[Anything]] |= | | [[Anything]] |RETURNVALUE= | ||
| s2= FSMhandle '''getFSMVariable''' [name, defaultValue] (''Since Arma 3 v1.67'') |= Syntax | | s2= FSMhandle '''getFSMVariable''' [name, defaultValue] (''Since Arma 3 v1.67'') |= Syntax | ||
|p21= [name, defaultValue]: [[Array]] - |= | |p21= [name, defaultValue]: [[Array]] - |PARAMETER2= | ||
|p22= FSMhandle: [[Number]] - |= | |p22= FSMhandle: [[Number]] - |PARAMETER1= | ||
|p23= name: [[String]] - name of the variable |= | |p23= name: [[String]] - name of the variable |PARAMETER2= | ||
|p24= defaultValue: [[Anything]] - value to return if variable is [[nil]]|= | |p24= defaultValue: [[Anything]] - value to return if variable is [[nil]]|PARAMETER3= | ||
| r2= [[Anything]] |= | | r2= [[Anything]] |RETURNVALUE= | ||
|x1= <code>_handle [[getFSMVariable]] "_foo";</code>|= | |x1= <code>_handle [[getFSMVariable]] "_foo";</code>|EXAMPLE1= | ||
|x2= <code>_handle [[getFSMVariable]] ["_foo", 123];</code>|= | |x2= <code>_handle [[getFSMVariable]] ["_foo", 123];</code>|EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[FSM]], [[commandFSM]], [[completedFSM]], [[doFSM]] [[execFSM]], [[setFSMVariable]] |= | | [[FSM]], [[commandFSM]], [[completedFSM]], [[doFSM]] [[execFSM]], [[setFSMVariable]] |SEEALSO= | ||
| |= | | |MPBEHAVIOUR= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
}} | }} | ||
Revision as of 11:31, 7 April 2019
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:
- Uncategorised
Syntax
- Syntax:
- FSMhandle getFSMVariable name
- Parameters:
- FSMhandle: Number -
- name: String - name of the variable
- Return Value:
- Anything
Alternative Syntax
- Syntax:
- FSMhandle getFSMVariable [name, defaultValue] (Since Arma 3 v1.67)
- 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