BIS_fnc_endMission

From Bohemia Interactive Community
Jump to navigation Jump to search
tkoh logo small.png Take On Helicopters
Arma 3 logo black.png Arma 3
Hover & click on the images for description

Description

Description:
Ends mission with a signature shot or a fade effect, marks it finished for Steam and activates a key in format cactivateKey format ["BIS_%1.%2_done", missionName, worldName];.
This function should always be used instead of the simple endMission/failMission commands or trigger endings; otherwise, singleplayer scenarios will not properly be marked as played/finished in the game and on Steam!
Execution:
call
Groups:
Missions

Syntax

Syntax:
[endName, isVictory, fadeType, playMusic, cancelTasks] call BIS_fnc_endMission
Parameters:
endName (Optional, default "end1"):
isVictory: Boolean - (Optional, default true) true for 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
cancelTasks: Boolean - (Optional, default false) true to cancel all pending tasks
Return Value:
Boolean

Examples

Example 1:
Copy
"end1" call BIS_fnc_endMission;
Example 2:
Copy
["epicFail", false, 2] call BIS_fnc_endMission;

Additional Information

See also:
BIS_fnc_endMissionServer Debriefing endMission markAsFinishedOnSteam

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
R3vo - c
Posted on Mar 21, 2016 - 11:12 (UTC)
To end a multiplayer mission one can use c["end1", true] remoteExecCall ["BIS_fnc_endMission"]; - see also BIS_fnc_endMissionServer.