BIS fnc endMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(see also)
(Add MarkAsFinishedOnSteam)
Line 1: Line 1:
{{Function|= Comments
{{Function|Comments=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| arma3 |Game name=


|0.50|= Game version
|0.50|Game version=


|eff= local |=
|eff= local |Effect=
____________________________________________________________________________________________
____________________________________________________________________________________________


| Ends mission with a fade effect. See [[Debriefing]] for more information.<br>
| Ends mission with a fade effect. See [[Debriefing]] for more information.
{{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!}}|= Description
{{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]].}}|Description=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [endName,isVictory,fadeType,playMusic,completeTasks] [[spawn]] [[BIS_fnc_endMission]]; |= Syntax
| [endName, isVictory, fadeType, playMusic, completeTasks] [[spawn]] [[BIS_fnc_endMission]] |= Syntax


|p1= '''endName''' (Optional): <br/>[[String]] - end type, as used in [[endMission]] command (default: "end1") <br/>[[Array]] - in format [endName,ID], will be composed to "endName_ID" string |=
|p1= '''endName''' (Optional, default "end1"):
|p2= '''isVictory''' (Optional): [[Boolean]] - true to successful end, false for failed end (default: true) |=
* [[String]] - end type, as used in [[endMission]] command
|p3= '''fadeType''' (Optional): [[Boolean]] or [[Number]] - true for signature [[Debriefing|closing shot]]. When number, simple fade to black of given duration is used. |=
* [[Array]] - in format [endName, ID], will be composed to "endName_ID" string |Parameter 1=
|p4= '''playMusic''' (Optional): [[Boolean]] - false to disable automatic music during [[Debriefing|closing shot]]. (default: true) |=
|p2= '''isVictory''': [[Boolean]] - (Optional, default true) true to successful end, false for failed end |Parameter 2=
|p5= '''completeTasks''' (Optional): [[Boolean]] - true to cancel all pending tasks. (default: false) |=
|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. |Parameter 3=
|p4= '''playMusic''': [[Boolean]] - (Optional, default true) false to disable automatic music during [[Debriefing|closing shot]]. |Parameter 4=
|p5= '''completeTasks''' (Optional, default false): [[Boolean]] - true to cancel all pending tasks. |Parameter 5=


| [[Boolean]] |= Return value
| [[Boolean]] |Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <code>"end1" [[call]] [[BIS_fnc_endMission]];</code> |=
|x1= <code>"end1" [[call]] [[BIS_fnc_endMission]];</code> |Example 1=


|x2= <code><nowiki>[</nowiki>"epicFail",[[false]],2] [[call]] [[BIS_fnc_endMission]];</code> |=
|x2= <code><nowiki>[</nowiki>"epicFail", [[false]], 2] [[call]] [[BIS_fnc_endMission]];</code> |Example 2=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[BIS_fnc_endMissionServer]], [[Debriefing]] |= See also
| [[BIS_fnc_endMissionServer]], [[Debriefing]], [[endMission]], [[markAsFinishedOnSteam]] |See also=
 
}}
}}


Revision as of 22:58, 2 January 2019

Arma 3 logo black.png0.50
LELocal
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 mission properly on a server, use BIS_fnc_endMissionServer instead
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_endMission&oldid=115419"