BIS fnc execFSM: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1 = Program Flow |GROUP1=
|gr1 = Program Flow |GROUP1=
____________________________________________________________________________________________


| 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=
Line 17: Line 14:


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


|s2= [params, filename] [[call]] '''BIS_fnc_execFSM'''; |SYNTAX2=  
|s2= [params, filename] [[call]] '''BIS_fnc_execFSM'''; |SYNTAX2=  
Line 25: Line 21:


|r2= [[Number]] - FSM handle or '''0''' on error |RETURNVALUE2=
|r2= [[Number]] - FSM handle or '''0''' on error |RETURNVALUE2=
____________________________________________________________________________________________


|x1= <code>_handle = <nowiki>[[</nowiki>_param1, _param2, ''etc..''], "test.fsm"] [[call]] [[BIS_fnc_execFSM]];</code> |Example1=
|x1= <code>_handle = <nowiki>[[</nowiki>_param1, _param2, ''etc..''], "test.fsm"] [[call]] [[BIS_fnc_execFSM]];</code> |Example1=


|x2= <code>_handle = "test.fsm" [[call]] [[BIS_fnc_execFSM]];</code> |EXAMPLE2=  
|x2= <code>_handle = "test.fsm" [[call]] [[BIS_fnc_execFSM]];</code> |EXAMPLE2=  
____________________________________________________________________________________________


|exec= call |Execution= By (defaults to [[call]] if omitted)
|exec= call |Execution= By (defaults to [[call]] if omitted)

Revision as of 00:13, 17 January 2021

Hover & click on the images for description

Description

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

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