execFSM: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(format)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| 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.  
| Executes scripted FSM and returns the FSM handle or 0 when failed. The FSM file is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder. Argument (if any) are available in <tt>_this</tt> variable inside FSM. In Arma 3 FSM handle is also available in <tt>_thisFSM</tt> variable. |= Description
<br>Argument(s) (if any) is/are passed as <tt>_this</tt> to the FSM.
<br>Returns the FSM handle or 0 when failed. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| argument(s) '''execFSM''' filename |= Syntax
| arguments '''execFSM''' filename |= Syntax


|p1= argument(s): [[Any Value]](s) - Argument(s) accessible as <tt>_this</tt> in the FSM|= Parameter 1
|p1= arguments: [[Anything]] - Arguments 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 10:53, 1 August 2016

Hover & click on the images for description

Description

Description:
Executes scripted FSM and returns the FSM handle or 0 when failed. The FSM file is first searched in the mission folder, then in the campaign scripts folder and finally in the global scripts folder. Argument (if any) are available in _this variable inside FSM. In Arma 3 FSM handle is also available in _thisFSM variable.
Groups:
Uncategorised

Syntax

Syntax:
arguments execFSM filename
Parameters:
arguments: Anything - Arguments 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