BIS fnc execFSM: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
mNo edit summary
(add desc; syntax; see also execfsm; adapted examples)
Line 8: Line 8:
____________________________________________________________________________________________
____________________________________________________________________________________________


| ''N/A'' |= Description
| Execute the scripted FSM. Shell for [[execFSM]] command |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_execFSM]]; --> |= Syntax
| filename [[call]] '''BIS_fnc_execFSM'''; |= Syntax


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


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


|x1= <code>[_params,_fsm] call [[BIS_fnc_execFSM]]</code> |=  
|s2= [params, filename] [[call]] '''BIS_fnc_execFSM'''; |=
|x2= <code>[_fsm] call [[BIS_fnc_execFSM]]</code> |=  
 
|p21= params: [[Array]] - parameters are passed to script as variable [[_this]] |= Parameter2 1
|p22= filename: [[FSM]] - [[FSM]] filename |= Parameter2 2
 
|r2= [[Number]] - FSM handle or '''0''' on error |=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[BIS_fnc_execRemote]], [[BIS_fnc_execVM]], [[BIS_fnc_spawn]] |= See also
|x1= <code>_handle = <nowiki>[[</nowiki>_param1, _param2, ''etc..''], "test.fsm"] [[call]] [[BIS_fnc_execFSM]];</code> |=
|x2= <code>_handle = "test.fsm" [[call]] [[BIS_fnc_execFSM]];</code> |=
____________________________________________________________________________________________
 
|exec= call |= Execution By (defaults to [[call]] if omitted)
 
| [[execFSM]], [[FSM]], [[BIS_fnc_execRemote]], [[BIS_fnc_execVM]], [[BIS_fnc_call]] |= See also


}}
}}

Revision as of 16:56, 4 December 2014


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