BIS fnc endMission: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) |
Lou Montana (talk | contribs) m (Text replacement - "_{10,} " to "") |
||
| Line 1: | Line 1: | ||
{{Function|Comments= | {{Function|Comments= | ||
| arma3 |Game name= | | arma3 |Game name= | ||
| Line 9: | Line 8: | ||
|gr1 = Missions |GROUP1= | |gr1 = Missions |GROUP1= | ||
| Ends mission with a fade effect. See [[Debriefing]] for more information. | | 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! See [[markAsFinishedOnSteam]].}}|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 | ||
| Line 26: | Line 23: | ||
| [[Boolean]] |Return value= | | [[Boolean]] |Return value= | ||
|x1= <code>"end1" [[call]] [[BIS_fnc_endMission]];</code> |Example 1= | |x1= <code>"end1" [[call]] [[BIS_fnc_endMission]];</code> |Example 1= | ||
|x2= <code><nowiki>[</nowiki>"epicFail", [[false]], 2] [[call]] [[BIS_fnc_endMission]];</code> |Example 2= | |x2= <code><nowiki>[</nowiki>"epicFail", [[false]], 2] [[call]] [[BIS_fnc_endMission]];</code> |Example 2= | ||
| [[BIS_fnc_endMissionServer]], [[Debriefing]], [[endMission]], [[markAsFinishedOnSteam]] |See also= | | [[BIS_fnc_endMissionServer]], [[Debriefing]], [[endMission]], [[markAsFinishedOnSteam]] |See also= | ||
Revision as of 23:05, 16 January 2021
Description
- Description:
- Ends mission with a fade effect. 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/ 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
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.