getFSMVariable: Difference between revisions
Jump to navigation
Jump to search
m (melt "FSM" and "handler" together so thy don't look like 2 parameters) |
Killzone Kid (talk | contribs) (support for default value) |
||
| Line 14: | Line 14: | ||
|p1= FSMhandle: [[Number]] - |= PARAMETER1 | |p1= FSMhandle: [[Number]] - |= PARAMETER1 | ||
|p2= name: [[String]] - | |p2= name: [[String]] - name of the variable |= PARAMETER2 | ||
|p3= |= PARAMETER3 | |p3= |= PARAMETER3 | ||
| [[Anything]] |= RETURNVALUE | | [[Anything]] |= RETURNVALUE | ||
| s2= FSMhandle '''getFSMVariable''' [name, defaultValue] (''Since Arma 3 v1.67'') |= Syntax | |||
|p21= [name, defaultValue]: [[Array]] - |= PARAMETER2 | |||
|p22= FSMhandle: [[Number]] - |= PARAMETER1 | |||
|p23= name: [[String]] - name of the variable |= PARAMETER2 | |||
|p24= defaultValue: [[Anything]] - value to return if variable is [[nil]]|= PARAMETER3 | |||
| r2= [[Anything]] |= RETURNVALUE | |||
|x1= <code>_handle [[getFSMVariable]] "_foo";</code>|= EXAMPLE1 | |x1= <code>_handle [[getFSMVariable]] "_foo";</code>|= EXAMPLE1 | ||
|x2= <code>_handle [[getFSMVariable]] ["_foo", 123];</code>|= EXAMPLE1 | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 18:08, 18 January 2017
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