BIS fnc endMission: Difference between revisions

Revision as of 08:59, 11 May 2021

0.50

LELocal

Hover & click on the images for description

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

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

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

: 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.

@@ Line 9: / Line 9: @@
 |gr1= Missions
-|descr= Ends mission with a fade effect. See [[Debriefing]] for more information.
+|descr= Ends mission with a fade effect, marks it finished for Steam and activates a key in format {{ic|[[activateKey]] [[format]] ["BIS_%1.%2_done", [[missionName]], [[worldName]]];}}. See [[Debriefing]] for more information. This should always be used instead of the simple <tt>end1-end_n</tt> endings one can set on trigger activation.<br>Otherwise singleplayer scenarios will not properly be marked as played/finished in Arma 3 and on Steam! See [[markAsFinishedOnSteam]].
-{{Feature|arma3|This should always be used instead of the simple end1-end_n endings one can set on trigger activation.<br>Otherwise singleplayer scenarios will not properly be marked as played/ ended in Arma 3 and on Steam! See [[markAsFinishedOnSteam]].}}
-| [endName, isVictory, fadeType, playMusic, completeTasks] [[spawn]] [[BIS_fnc_endMission]] |= Syntax
+|s1= [endName, isVictory, fadeType, playMusic, cancelTasks] [[call]] [[BIS_fnc_endMission]] |= Syntax
 |p1= endName (Optional, default "end1"):
-* [[String]] - End type, as used in [[endMission]] command
+* [[String]] - End type from {{ic|[[configfile]] >> "CfgDebriefing"}}. Same as with [[endMission]] and [[failMission]]
 * [[Array]] - In format [endName, ID], will be composed to "endName_ID" string
-|p2= isVictory: [[Boolean]] - (Optional, default true) [[true|True]] for successful end, false for failed end
+|p2= isVictory: [[Boolean]] - (Optional, default [[true]]) [[true|True]] for successful end, false for failed end
-|p3= fadeType: [[Boolean]] or [[Number]] - (Optional, default true) true for signature [[Debriefing|closing shot]]. When number, simple fade to black of given duration is used.
+|p3= fadeType: [[Boolean]] or [[Number]] - (Optional, default [[true]]) true for signature [[Debriefing|closing shot]]. When number, simple fade to black of given duration is used
-|p4= '''playMusic''': [[Boolean]] - (Optional, default true) false to disable automatic music during [[Debriefing|closing shot]].
+|p4= playMusic: [[Boolean]] - (Optional, default [[true]]) [[false|False]] to disable automatic music during [[Debriefing|closing shot]]
-|p5= '''completeTasks''' (Optional, default false): [[Boolean]] - true to cancel all pending tasks.
+|p5= cancelTasks: (Optional, default [[false]]): [[Boolean]] - [[true|True]] to cancel all pending tasks
 |r1= [[Boolean]]