BIS_fnc_endMission

From Bohemia Interactive Community
Jump to navigation Jump to search
Introduced with Arma 3 version 0.50
  Effects of this scripting function are not broadcasted over the network and remain local to the client the function is executed on

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
0.50

Description

Description:
Ends mission with a fade effect. See Debriefing for more information.
Arma 3 logo black.png
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.

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

Execution:
call
Multiplayer:
-
See also:
BIS_fnc_endMissionServerDebriefingendMissionmarkAsFinishedOnSteam

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section

Posted on March 21, 2016 - 11:12 (UTC)
Revo
To end a mission properly on a server, use BIS_fnc_endMissionServer instead