BIS fnc execFSM: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(add desc; syntax; see also execfsm; adapted examples)
m (template:command argument fix)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Execute the scripted FSM. Shell for [[execFSM]] command |= Description
| Execute the scripted FSM. Shell for [[execFSM]] command |DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| filename [[call]] '''BIS_fnc_execFSM'''; |= Syntax
| filename [[call]] '''BIS_fnc_execFSM'''; |SYNTAX=


|p1= filename: [[String]] - [[FSM]] filename |= Parameter 1  
|p1= filename: [[String]] - [[FSM]] filename |= Parameter 1  


| [[Number]] - [[FSM]] handle |= Return value
| [[Number]] - [[FSM]] handle |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|s2= [params, filename] [[call]] '''BIS_fnc_execFSM'''; |=  
|s2= [params, filename] [[call]] '''BIS_fnc_execFSM'''; |=  


|p21= params: [[Array]] - parameters are passed to script as variable [[_this]] |= Parameter2 1
|p21= params: [[Array]] - parameters are passed to script as variable [[_this]] |PARAMETER2= 1
|p22= filename: [[FSM]] - [[FSM]] filename |= Parameter2 2
|p22= filename: [[FSM]] - [[FSM]] filename |PARAMETER2= 2


|r2= [[Number]] - FSM handle or '''0''' on error |=
|r2= [[Number]] - FSM handle or '''0''' on error |=
Line 32: Line 32:
|exec= call |= Execution By (defaults to [[call]] if omitted)
|exec= call |= Execution By (defaults to [[call]] if omitted)


| [[execFSM]], [[FSM]], [[BIS_fnc_execRemote]], [[BIS_fnc_execVM]], [[BIS_fnc_call]] |= See also
| [[execFSM]], [[FSM]], [[BIS_fnc_execRemote]], [[BIS_fnc_execVM]], [[BIS_fnc_call]] |SEEALSO=


}}
}}

Revision as of 11:28, 7 April 2019


Hover & click on the images for description

Description

Description:
Execute the scripted FSM. Shell for execFSM command
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
filename call BIS_fnc_execFSM;
Parameters:
filename: String - FSM filename
Return Value:
Number - FSM handle

Alternative Syntax

Syntax:
[params, filename] call BIS_fnc_execFSM;
Parameters:
params: Array - parameters are passed to script as variable _this
filename: FSM - FSM filename
Return Value:
Number - FSM handle or 0 on error

Examples

Example 1:
_handle = [[_param1, _param2, etc..], "test.fsm"] call BIS_fnc_execFSM;
Example 2:
_handle = "test.fsm" call BIS_fnc_execFSM;

Additional Information

See also:
execFSMFSMBIS_fnc_execRemoteBIS_fnc_execVMBIS_fnc_call

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