BIS fnc endMissionServer: Difference between revisions

Latest revision as of 22:01, 27 March 2024

1.00

GEGlobal SEServer

Hover & click on the images for description

Description

Description:: Ends the mission properly for all players in a multiplayer environment.
ⓘ
This function is somewhat deprecated for custom endings since 1.50 as remote-executing BIS_fnc_endMission allows for more options:
["MyEnding", true, 3] remoteExec ["BIS_fnc_endMission", 0, true];
Execution:: call
Groups:: Multiplayer

Syntax

Syntax:

endType call BIS_fnc_endMissionServer

Parameters:

endType: String - class name of ending defined in CfgDebriefing.
Can be custom or one of dynamically calculated ones:

"EveryoneWon" - Show "MISSION COMPLETED" to everyone
"EveryoneLost" - Show "MISSION FAILED" to everyone
"SideTickets" - Show "YOUR SIDE WON" to side/s with most tickets and "YOUR SIDE LOST" to everyone else
"SideScore" - Show "YOUR SIDE WON" to side with largest score
"GroupScore" - Show "YOUR GROUP WON" to group with largest score
"PlayerScore" - Show "YOU WON" to player with largest score

Return Value:

Boolean

Examples

Example 1:: "SideScore" call BIS_fnc_endMissionServer;

Additional Information

See also:: BIS_fnc_endMission failMission forceEnd endMission

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

@@ Line 1: / Line 1: @@
-{{Function|= Comments
+{{RV|type=function
-____________________________________________________________________________________________
-| arma3 |= Game name
+|game1= arma3
+|version1= 1.00
-|1.00|= Game version
+|gr1= Multiplayer
-____________________________________________________________________________________________
-| Ends the mission properly for all players in a multiplayer environment|= Description
+|serverExec= server
-____________________________________________________________________________________________
-|end type call BIS_fnc_endMissionServer |= Syntax
+|eff= global
-|p1= end type: [[String]]<br>
+|descr= Ends the mission properly for all players in a multiplayer environment.
-Class name of ending defined in CfgDebriefing<br>
+{{Feature|informative|This function is somewhat deprecated for custom endings since {{GVI|arma3|1.50}} as [[remoteExec|remote-exec]]uting [[BIS_fnc_endMission]] allows for more options:
-Can be custom or one of dynamically calculated ones:<br>
+<sqf>["MyEnding", true, 3] remoteExec ["BIS_fnc_endMission", 0, true];</sqf>
-"EveryoneWon" - show "MISSION COMPLETED" to everyone<br>
+}}
-"EveryoneLost" - show "MISSION FAILED" to everyone<br>
-"SideScore" - show "YOUR SIDE WON" to side with largest score<br>
-"GroupScore" - show "YOUR GROUP WON" to group with largest score<br>
-"PlayerScore" - show "YOUR WON" to player with largest score<br>
-|= PARAMETER1
-| [[BOOL]]|= RETURNVALUE
+|s1= endType call [[BIS_fnc_endMissionServer]]
+|p1= endType: [[String]] - class name of ending defined in [[Description.ext#CfgDebriefing|CfgDebriefing]].<br>
+Can be '''custom''' or one of dynamically calculated ones:
+* "EveryoneWon" - Show "MISSION COMPLETED" to everyone
+* "EveryoneLost" - Show "MISSION FAILED" to everyone
+* "SideTickets" - Show "YOUR SIDE WON" to side/s with most tickets and "YOUR SIDE LOST" to everyone else
+* "SideScore" - Show "YOUR SIDE WON" to side with largest score
+* "GroupScore" - Show "YOUR GROUP WON" to group with largest score
+* "PlayerScore" - Show "YOU WON" to player with largest score
-|x1= <code>"SideScore" call BIS_fnc_endMissionServer</code>|= EXAMPLE1
+|r1= [[Boolean]]
-____________________________________________________________________________________________
-| [[BIS_fnc_endMission]], [[failMission]], [[forceEnd]], [[endMission]] |= SEEALSO
+|x1= <sqf>"SideScore" call BIS_fnc_endMissionServer;</sqf>
-|  |= MPBEHAVIOUR
+|seealso= [[BIS_fnc_endMission]] [[failMission]] [[forceEnd]] [[endMission]]
-____________________________________________________________________________________________
 }}
-<h3 style='display:none'>Notes</h3>
-<dl class='command_description'>
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style='display:none'>Bottom Section</h3>
-[[Category:Function Group: Misc|{{uc:endMissionServer}}]]
-[[Category:Functions|{{uc:endMissionServer}}]]
-[[Category:{{Name|arma3}}: Functions|{{uc:endMissionServer}}]]
-<!-- CONTINUE Notes -->
-<!-- DISCONTINUE Notes -->