BIS fnc endMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "{{Feature arma3|" to "{{Feature|arma3|")
m (Text replacement - "Revo" to "R3vo")
Line 52: Line 52:
<dl class="command_description">
<dl class="command_description">
<dd class="notedate">Posted on March 21, 2016 - 11:12 (UTC)</dd>
<dd class="notedate">Posted on March 21, 2016 - 11:12 (UTC)</dd>
<dt class="note">[[User:Revo|Revo]]</dt>
<dt class="note">[[User:R3vo|R3vo]]</dt>
<dd class="note">
<dd class="note">
To end a multiplayer mission one can use <code>["end1",[[true]]<nowiki>]</nowiki> [[remoteExecCall]] ['[[BIS_fnc_endMission]]',0];</code> or [[BIS_fnc_endMissionServer]].
To end a multiplayer mission one can use <code>["end1",[[true]]<nowiki>]</nowiki> [[remoteExecCall]] ['[[BIS_fnc_endMission]]',0];</code> or [[BIS_fnc_endMissionServer]].

Revision as of 06:56, 30 December 2020

Hover & click on the images for description

Description

Description:
Ends mission with a fade effect. See Debriefing for more information.
Arma 3
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/ ended in Arma 3 and on Steam! See markAsFinishedOnSteam.
Execution:
call
Groups:
Missions

Syntax

Syntax:
[endName, isVictory, fadeType, playMusic, completeTasks] spawn BIS_fnc_endMission
Parameters:
endName (Optional, default "end1"):
  • String - end type, as used in endMission command
  • Array - in format [endName, ID], will be composed to "endName_ID" string
isVictory: Boolean - (Optional, default true) true to 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.
completeTasks (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

Notes

Bottom Section

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.