execFSM: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(alt syntax)
mNo edit summary
Line 14: Line 14:
| argument(s) '''execFSM''' filename |= Syntax
| argument(s) '''execFSM''' filename |= Syntax


|p1= argument(s): [[Any Value]](s) - Optional. Argument(s) accessible as <tt>_this</tt> in the FSM|= Parameter 1
|p1= argument(s): [[Any Value]](s) - Argument(s) accessible as <tt>_this</tt> in the FSM|= Parameter 1


|p2= filename: [[String]] - file with FSM code |= Parameter 2
|p2= filename: [[String]] - file with FSM code |= Parameter 2

Revision as of 15:39, 22 December 2015

Hover & click on the images for description

Description

Description:
Execute the scripted FSM. The FSM file is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder.
Argument(s) (if any) is/are passed as _this to the FSM.
Returns the FSM handle or 0 when failed.
Groups:
Uncategorised

Syntax

Syntax:
argument(s) execFSM filename
Parameters:
argument(s): Any Value(s) - Argument(s) accessible as _this in the FSM
filename: String - file with FSM code
Return Value:
Number - FSM handle, can be used to determine (via completedFSM) when the execed FSM has finished. In Arma 3, the handle is also available inside the FSM in _thisFSM variable.

Alternative Syntax

Syntax:
execFSM filename
Parameters:
filename: String - file with FSM code String
Return Value:
Number - FSM handle, can be used to determine (via completedFSM) when the execed FSM has finished. In Arma 3, the handle is also available inside the FSM in _thisFSM variable.

Examples

Example 1:
_id = player execFSM "test.fsm";
Example 2:
_handle = [_a, _b, _c] execFSM "test.fsm";
Example 3:
_handle = execFSM "test.fsm";

Additional Information

See also:
FSMFSM Editor ManualexecVMcallspawnexeccommandFSMcompletedFSMdoFSMgetFSMVariablesetFSMVariable

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

Notes

Bottom Section