BIS fnc endMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " " to " ")
m (Text replacement - "<dl class="command_description"> <dt></dt>" to "<dl class="command_description"> <dt></dt>")
Line 35: Line 35:


<dl class="command_description">
<dl class="command_description">
<dt></dt>
<dt></dt>
<dd class="notedate">Posted on March 21, 2016 - 11:12 (UTC)</dd>
<dd class="notedate">Posted on March 21, 2016 - 11:12 (UTC)</dd>

Revision as of 14:23, 12 June 2021

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"):
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_endMissionServerDebriefingendMissionmarkAsFinishedOnSteam

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.