BIS fnc endMission: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...) |
||
| Line 1: | Line 1: | ||
{{Function | {{Function | ||
| arma3 | | arma3 | ||
|0.50 | |0.50 | ||
|eff= local |Effect= | |eff= local |Effect= | ||
|gr1 = Missions | |gr1 = Missions | ||
| 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]].}} | {{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]].}} | ||
| [endName, isVictory, fadeType, playMusic, completeTasks] [[spawn]] [[BIS_fnc_endMission]] |= Syntax | | [endName, isVictory, fadeType, playMusic, completeTasks] [[spawn]] [[BIS_fnc_endMission]] |= Syntax | ||
| Line 16: | Line 16: | ||
|p1= '''endName''' (Optional, default "end1"): | |p1= '''endName''' (Optional, default "end1"): | ||
* [[String]] - end type, as used in [[endMission]] command | * [[String]] - end type, as used in [[endMission]] command | ||
* [[Array]] - in format [endName, ID], will be composed to "endName_ID" string | * [[Array]] - in format [endName, ID], will be composed to "endName_ID" string | ||
|p2= '''isVictory''': [[Boolean]] - (Optional, default true) true to successful end, false for failed end | |p2= '''isVictory''': [[Boolean]] - (Optional, default true) true to successful end, false for failed end | ||
|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. | |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. | ||
|p4= '''playMusic''': [[Boolean]] - (Optional, default true) false to disable automatic music during [[Debriefing|closing shot]]. | |p4= '''playMusic''': [[Boolean]] - (Optional, default true) false to disable automatic music during [[Debriefing|closing shot]]. | ||
|p5= '''completeTasks''' (Optional, default false): [[Boolean]] - true to cancel all pending tasks. | |p5= '''completeTasks''' (Optional, default false): [[Boolean]] - true to cancel all pending tasks. | ||
| [[Boolean]] | | [[Boolean]] | ||
|x1= <code>"end1" [[call]] [[BIS_fnc_endMission]];</code> | |x1= <code>"end1" [[call]] [[BIS_fnc_endMission]];</code> | ||
|x2= <code><nowiki>[</nowiki>"epicFail", [[false]], 2] [[call]] [[BIS_fnc_endMission]];</code> | |x2= <code><nowiki>[</nowiki>"epicFail", [[false]], 2] [[call]] [[BIS_fnc_endMission]];</code> | ||
| [[BIS_fnc_endMissionServer]], [[Debriefing]], [[endMission]], [[markAsFinishedOnSteam]] | | [[BIS_fnc_endMissionServer]], [[Debriefing]], [[endMission]], [[markAsFinishedOnSteam]] | ||
}} | }} | ||
Revision as of 23:00, 17 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
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.