BIS_fnc_endMission

Description

Ends mission with a signature shot or a fade effect, marks it finished for Steam and activates a key in format activateKey format ["BIS_%1.%2_done", missionName, worldName];.

Important

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!

Syntax

[endName, isVictory, fadeType, playMusic, cancelTasks] call BIS_fnc_endMission

Parameters:

• endName: String or Array - (Optional, default "end1")

  • String - end type from configFile >> "CfgDebriefing". Same as with endMission and failMission
  • Array - in format [endName, ID], will be composed to "endName_ID" string

• 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

Returns: Boolean

Examples

Example 1

"end1" call BIS_fnc_endMission;

Example 2

["epicFail", false, 2] call BIS_fnc_endMission;

See also

BIS_fnc_endMissionServer · Debriefing · endMission · markAsFinishedOnSteam