BIS fnc endMission: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "\|gr([0-9]+) = " to "|gr$1= ") |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma3 | |game1= arma3 | ||
|0.50 | |version1= 0.50 | ||
|eff= local | |eff= local | ||
| Line 9: | Line 9: | ||
|gr1= Missions | |gr1= Missions | ||
| Ends mission with a fade effect. See [[Debriefing]] for more information. | |descr= 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 | ||
|p1= | |p1= endName (Optional, default "end1"): | ||
* [[String]] - | * [[String]] - End type, as used in [[endMission]] command | ||
* [[Array]] - | * [[Array]] - In format [endName, ID], will be composed to "endName_ID" string | ||
|p2= | |p2= isVictory: [[Boolean]] - (Optional, default true) [[true|True]] for successful end, false for failed end | ||
|p3= | |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]] | |r1= [[Boolean]] | ||
|x1= <code>"end1" [[call]] [[BIS_fnc_endMission]];</code> | |x1= <code>"end1" [[call]] [[BIS_fnc_endMission]];</code> | ||
| Line 30: | Line 30: | ||
|seealso= [[BIS_fnc_endMissionServer]], [[Debriefing]], [[endMission]], [[markAsFinishedOnSteam]] | |seealso= [[BIS_fnc_endMissionServer]], [[Debriefing]], [[endMission]], [[markAsFinishedOnSteam]] | ||
}} | }} | ||
<dl class="command_description"> | <dl class="command_description"> | ||
| Line 41: | Line 36: | ||
<dt class="note">[[User:R3vo|R3vo]]</dt> | <dt class="note">[[User:R3vo|R3vo]]</dt> | ||
<dd class="note"> | <dd class="note"> | ||
To end a multiplayer mission one can use | To end a multiplayer mission one can use {{ic|["end1", [[true]]<nowiki>]</nowiki> [[remoteExecCall]] ["[[BIS_fnc_endMission]]", 0];}} or [[BIS_fnc_endMissionServer]]. | ||
</dd> | </dd> | ||
</dl> | </dl> | ||
Revision as of 01:01, 11 May 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:
- Syntax needed
- 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 for 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
- 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.