BIS fnc endMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (expanded note)
m (Text replacement - "\[\[Category\:Function Group\: Misc(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
Line 42: Line 42:


<h3 style="display:none">Bottom Section</h3>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:endMission}}]]
 
[[Category:Functions|{{uc:endMission}}]]
[[Category:Functions|{{uc:endMission}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:endMission}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:endMission}}]]

Revision as of 10:03, 10 October 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:
Uncategorised

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)
Revo
To end a multiplayer mission one can use ["end1",true] remoteExecCall ['BIS_fnc_endMission',0]; or BIS_fnc_endMissionServer.