BIS fnc endMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>(\[?[^\[]+\]?) *(\[\[)?(call|spawn)(\]\])? *(\[\[)?(BI(N|S)_fnc_[a-zA-Z0-9_]+)(\]\])?;?<\/code>" to "<sqf>$1 $3 $6;</sqf>")
m (Some wiki formatting)
 
(3 intermediate revisions by the same user not shown)
Line 31: Line 31:
|r1= [[Boolean]]
|r1= [[Boolean]]


|x1= <code>["mission2", 1, "You won"] [[call]] [[BIS_fnc_endMission]]; {{cc|[[endMission]] "mission2_1"}}</code>
|x1= <sqf>["mission2", 1, "You won"] call BIS_fnc_endMission; // endMission "mission2_1"</sqf>


|x2= <code>["mission2", 1, "You lose", [[false]]] [[call]] [[BIS_fnc_endMission]]; {{cc|[[failMission]] "mission2_1"}}</code>
|x2= <sqf>["mission2", 1, "You lose", false] call BIS_fnc_endMission; // failMission "mission2_1"</sqf>


|seealso= [[Debriefing]] [[endMission]] [[failMission]]
|seealso= [[Debriefing]] [[endMission]] [[failMission]]
Line 49: Line 49:
|gr1= Missions
|gr1= Missions


|descr= Ends mission with a signature shot or a fade effect, marks it finished for Steam and activates a key in format {{ic|[[activateKey]] [[format]] ["BIS_%1.%2_done", [[missionName]], [[worldName]]];}}.
|descr= Ends mission with a signature shot or a fade effect, marks it finished for Steam and activates a key in format <sqf inline>activateKey format ["BIS_%1.%2_done", missionName, worldName];</sqf>.


{{Feature|important|This function should always be used instead of the simple [[endMission]]/[[failMission]] commands or trigger endings; otherwise, singleplayer scenarios will not properly be marked as played/finished in the game and on Steam!}}
{{Feature|important|This function should always be used instead of the simple [[endMission]]/[[failMission]] commands or trigger endings; otherwise, singleplayer scenarios will not properly be marked as played/finished in the game and on Steam!}}
Line 56: Line 56:


|p1= endName (Optional, default "end1"):
|p1= endName (Optional, default "end1"):
* [[String]] - End type from {{ic|[[configfile]] >> "CfgDebriefing"}}. Same as with [[endMission]] and [[failMission]]
* [[String]] - end type from <sqf inline>configFile >> "CfgDebriefing"</sqf>. Same as with [[endMission]] and [[failMission]]
* [[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]] for successful end, false for failed end
|p2= isVictory: [[Boolean]] - (Optional, default [[true]]) [[true]] for successful end, false for failed end
Line 63: Line 63:
|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|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= cancelTasks: (Optional, default [[false]]): [[Boolean]] - [[true]] to cancel all pending tasks
|p5= cancelTasks: [[Boolean]] - (Optional, default [[false]]) [[true]] to cancel all pending tasks


|r1= [[Boolean]]
|r1= [[Boolean]]
Line 71: Line 71:
|x1= <sqf>"end1" call BIS_fnc_endMission;</sqf>
|x1= <sqf>"end1" call BIS_fnc_endMission;</sqf>


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


|seealso= [[BIS_fnc_endMissionServer]] [[Debriefing]] [[endMission]] [[markAsFinishedOnSteam]]
|seealso= [[BIS_fnc_endMissionServer]] [[Debriefing]] [[endMission]] [[markAsFinishedOnSteam]]
Line 78: Line 78:
}}
}}


<dl class="command_description">
{{Note
 
|user= R3vo
<dt></dt>
|timestamp= 20160321111200
<dd class="notedate">Posted on March 21, 2016 - 11:12 (UTC)</dd>
|text= To end a multiplayer mission one can use <sqf inline>["end1", true] remoteExecCall ["BIS_fnc_endMission"];</sqf> - see also [[BIS_fnc_endMissionServer]].
<dt class="note">[[User:R3vo|R3vo]]</dt>
}}
<dd class="note">To end a multiplayer mission one can use {{ic|["end1", [[true]]] [[remoteExecCall]] ["[[BIS_fnc_endMission]]", 0];}} - see also [[BIS_fnc_endMissionServer]].</dd>
 
</dl>

Latest revision as of 01:44, 22 May 2023

tkoh logo small.png Take On Helicopters
Arma 3 logo black.png Arma 3
tkoh logo small.png1.00
LELocal
Hover & click on the images for description

Description

Description:
Ends mission with the specified ending. Always ends with a 4 seconds black out effect.
ⓘ
nextMission and endingId parameters are assembled together to define which ending is called, in format nextMission_endType.
Execution:
call
Groups:
Missions

Syntax

Syntax:
[nextMission, endingId, displayText, isSuccess, code] call BIS_fnc_endMission
Parameters:
nextMission: String - (Optional, default worldName)
endingId: Number - (Optional, default 1)
displayText: String - (Optional, default "") text displayed on black out
isSuccess: Boolean - (Optional, default true) true to endMission, false to failMission
successCode: Code - code executed right before mission ends, only if isSuccess is set to true
Return Value:
Boolean

Examples

Example 1:
["mission2", 1, "You won"] call BIS_fnc_endMission; // endMission "mission2_1"
Example 2:
["mission2", 1, "You lose", false] call BIS_fnc_endMission; // failMission "mission2_1"

Additional Information

See also:
Debriefing endMission failMission

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
Arma 3 logo black.png0.50
LELocal
Hover & click on the images for description

Description

Description:
Ends mission with a signature shot or a fade effect, marks it finished for Steam and activates a key in format activateKey format ["BIS_%1.%2_done", missionName, worldName];.
⚠
This function should always be used instead of the simple endMission/failMission commands or trigger endings; otherwise, singleplayer scenarios will not properly be marked as played/finished in the game and on Steam!
Execution:
call
Groups:
Missions

Syntax

Syntax:
[endName, isVictory, fadeType, playMusic, cancelTasks] call BIS_fnc_endMission
Parameters:
endName (Optional, default "end1"):
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
cancelTasks: Boolean - (Optional, default false) 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_endMissionServer Debriefing endMission markAsFinishedOnSteam

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
R3vo - c
Posted on Mar 21, 2016 - 11:12 (UTC)
To end a multiplayer mission one can use ["end1", true] remoteExecCall ["BIS_fnc_endMission"]; - see also BIS_fnc_endMissionServer.
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_endMission&oldid=341330"