BIS_fnc_endMission
Jump to navigation
Jump to search
Description
- Description:
- Ends mission with a fade effect, marks it finished for Steam and activates a key in format
activateKey format ["BIS_%1.%2_done", missionName, worldName];
. See Debriefing for more information. This should always be used instead of the simple end1-end_n endings one can set on trigger activation.
Otherwise singleplayer scenarios will not properly be marked as played/finished in Arma 3 and on Steam! See markAsFinishedOnSteam. - Execution:
- call
- Groups:
- Missions
Syntax
- Syntax:
- [endName, isVictory, fadeType, playMusic, cancelTasks] call BIS_fnc_endMission
- Parameters:
- endName (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
- String - End type from
- 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: (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
- Posted on March 21, 2016 - 11:12 (UTC)
- R3vo
-
To end a multiplayer mission one can use
["end1", true] remoteExecCall ["BIS_fnc_endMission", 0];
or BIS_fnc_endMissionServer.