BIS fnc execFSM: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Fix SQF)
 
(44 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Program Flow


|1.00|= Game version
|descr= Execute the scripted FSM. Shell for [[execFSM]] command
____________________________________________________________________________________________


| Execute the scripted FSM. Shell for [[execFSM]] command |DESCRIPTION=
|s1= filename call [[BIS_fnc_execFSM]]
____________________________________________________________________________________________


| filename [[call]] '''BIS_fnc_execFSM'''; |SYNTAX=
|p1= filename: [[String]] - [[FSM]] filename


|p1= filename: [[String]] - [[FSM]] filename |PARAMETER1=
|r1= [[Number]] - [[FSM]] handle


| [[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 [[Magic Variables#this|_this]]


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


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


|x1= <code>_handle = <nowiki>[[</nowiki>_param1, _param2, ''etc..''], "test.fsm"] [[call]] [[BIS_fnc_execFSM]];</code> |=
|x1= <sqf>private _handle = [[_param1, _param2, _param3 /* etc */], "test.fsm"] call BIS_fnc_execFSM;</sqf>
|x2= <code>_handle = "test.fsm" [[call]] [[BIS_fnc_execFSM]];</code> |=
____________________________________________________________________________________________


|exec= call |= Execution By (defaults to [[call]] if omitted)
|x2= <sqf>private _handle = "test.fsm" call BIS_fnc_execFSM;</sqf>
 
| [[execFSM]], [[FSM]], [[BIS_fnc_execRemote]], [[BIS_fnc_execVM]], [[BIS_fnc_call]] |SEEALSO=


|seealso= [[execFSM]] [[FSM]] [[BIS_fnc_execRemote]] [[BIS_fnc_execVM]] [[BIS_fnc_call]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: MP|{{uc:execFSM}}]]
[[Category:Functions|{{uc:execFSM}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:execFSM}}]]

Latest revision as of 17:34, 1 November 2022

Arma 3 logo black.png1.00
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:
private _handle = [[_param1, _param2, _param3 /* etc */], "test.fsm"] call BIS_fnc_execFSM;
Example 2:
private _handle = "test.fsm" call BIS_fnc_execFSM;

Additional Information

See also:
execFSM FSM BIS_fnc_execRemote BIS_fnc_execVM BIS_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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_execFSM&oldid=330759"