BIS fnc endMission: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(56 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{TabView


{{Function|= Comments
|selected= 2
____________________________________________________________________________________________


| tkoh |= Game name
|title1= {{TabView/GameTitle|tkoh}}
|content1=
{{RV|type=function


|1.00|= Game version
|game1= tkoh
____________________________________________________________________________________________
|version1= 1.00


| <pre>/*
|eff= local


Description:
|gr1= Missions
Ends mission with specific ending.


Parameter(s):
|descr= Ends mission with the specified ending. Always ends with a 4 seconds black out effect.
0 (Optional):
{{Feature|informative|''nextMission'' and ''endingId'' parameters are assembled together to define which ending is called, in format {{hl|nextMission_endType}}.}}
STRING - end name (default: "end1")
ARRAY in format [endName,ID], will be composed to "endName_ID" string
1 (Optional): BOOL - true to end mission, false to fail mission (default: true)
2 (Optional):
BOOL - true for signature closing shot (default: true)
NUMBER - duration of a simple fade out to black
3 (Optional): BOOL - false to disable automatic music during signature shot (default: true)
4 (Optional): BOOL - true to cancel all pending tasks (default: false)


Returns:
|s1= [nextMission, endingId, displayText, isSuccess, code] call [[BIS_fnc_endMission]]
BOOL
*/


#define TERMINATE_DEAD if ((missionNamespace getVariable ["BIS_fnc_endMission_checkAliveState",true]) && !ismultiplayer && !alive player) exitwith {{_x cuttext ["","plain"]} foreach [_layerNoise,_layerInterlacing,_layerStatic,_layerEnd]};
|p1= nextMission: [[String]] - (Optional, default [[worldName]])


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
|p2= endingId: [[Number]] - (Optional, default 1)
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_endMission]]; --> |= Syntax
|p3= displayText: [[String]] - (Optional, default "") text displayed on black out


|p1= |= Parameter 1
|p4= isSuccess: [[Boolean]] - (Optional, default [[true]]) [[true]] to [[endMission]], [[false]] to [[failMission]]


| |= Return value
|p5= successCode: [[Code]] - code executed right before mission ends, only if ''isSuccess'' is set to [[true]]
____________________________________________________________________________________________


|x1= <code></code> |=
|r1= [[Boolean]]
____________________________________________________________________________________________


| |= See also
|x1= <sqf>["mission2", 1, "You won"] call BIS_fnc_endMission; // endMission "mission2_1"</sqf>


|x2= <sqf>["mission2", 1, "You lose", false] call BIS_fnc_endMission; // failMission "mission2_1"</sqf>
|seealso= [[Debriefing]] [[endMission]] [[failMission]]
}}
}}


<h3 style="display:none">Notes</h3>
|title2= {{TabView/GameTitle|arma3}}
<dl class="command_description">
|content2=
<!-- Note Section BEGIN -->
{{RV|type=function
 
|game1= arma3
|version1= 0.50
 
|eff= local
 
|gr1= Missions
 
|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!}}


<!-- Note Section END -->
|s1= [endName, isVictory, fadeType, playMusic, cancelTasks] call [[BIS_fnc_endMission]]
</dl>


<h3 style="display:none">Bottom Section</h3>
|p1= endName (Optional, default "end1"):
[[Category:Function Group: Misc|{{uc:endMission}}]]
* [[String]] - end type from <sqf inline>configFile >> "CfgDebriefing"</sqf>. Same as with [[endMission]] and [[failMission]]
[[Category:Functions|{{uc:endMission}}]]
* [[Array]] - in format [endName, ID], will be composed to "endName_ID" string
[[Category:{{Name|tkoh}}: Functions|{{uc:endMission}}]]
 
[[Category:{{Name|arma3}}: Functions|{{uc:endMission}}]]
|p2= isVictory: [[Boolean]] - (Optional, default [[true]]) [[true]] for 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
 
|p4= playMusic: [[Boolean]] - (Optional, default [[true]]) [[false]] to disable automatic music during [[Debriefing|closing shot]]
 
|p5= cancelTasks: [[Boolean]] - (Optional, default [[false]]) [[true]] to cancel all pending tasks
 
|r1= [[Boolean]]
 
|x1= <sqf>"end1" call BIS_fnc_endMission;</sqf>
 
|x2= <sqf>["epicFail", false, 2] call BIS_fnc_endMission;</sqf>
 
|seealso= [[BIS_fnc_endMissionServer]] [[Debriefing]] [[endMission]] [[markAsFinishedOnSteam]]
}}
 
}}
 
{{Note
|user= R3vo
|timestamp= 20160321111200
|text= To end a multiplayer mission one can use <sqf inline>["end1", true] remoteExecCall ["BIS_fnc_endMission"];</sqf> - see also [[BIS_fnc_endMissionServer]].
}}

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"