BIS fnc endMission: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Misc(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "") |
mNo edit summary |
||
Line 7: | Line 7: | ||
|eff= local |Effect= | |eff= local |Effect= | ||
|gr1 = Missions |GROUP1= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 15:04, 10 October 2020
Description
- Description:
- Ends mission with a fade effect. See Debriefing for more information.
- Execution:
- call
- Groups:
- Missions
Syntax
- Syntax:
- [endName, isVictory, fadeType, playMusic, completeTasks] spawn BIS_fnc_endMission
- Parameters:
- endName (Optional, default "end1"):
- String - end type, as used in endMission command
- Array - in format [endName, ID], will be composed to "endName_ID" string
- isVictory: Boolean - (Optional, default true) true to successful end, false for failed end
- fadeType: Boolean or Number - (Optional, default true) true for signature closing shot. When number, simple fade to black of given duration is used.
- playMusic: Boolean - (Optional, default true) false to disable automatic music during closing shot.
- completeTasks (Optional, default false): Boolean - true to cancel all pending tasks.
- Return Value:
- Boolean
Examples
- Example 1:
"end1" call BIS_fnc_endMission;
- Example 2:
["epicFail", false, 2] call BIS_fnc_endMission;
Additional Information
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
- Posted on March 21, 2016 - 11:12 (UTC)
- Revo
-
To end a multiplayer mission one can use
["end1",true] remoteExecCall ['BIS_fnc_endMission',0];
or BIS_fnc_endMissionServer.