BIS fnc endMissionServer: Difference between revisions

Latest revision as of 21: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
+{{RV|type=function
-| arma3
+|game1= arma3
+|version1= 1.00
-|1.00
+|gr1= Multiplayer
-|gr1 = Multiplayer
+|serverExec= server
-|serverExec= server
+|eff= global
-| Ends the mission properly for all players in a multiplayer environment.
+|descr= Ends the mission properly for all players in a multiplayer environment.
+{{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:
+<sqf>["MyEnding", true, 3] remoteExec ["BIS_fnc_endMission", 0, true];</sqf>
+}}
-| endType call [[BIS_fnc_endMissionServer]]
+|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
+* "EveryoneWon" - Show "MISSION COMPLETED" to everyone
-* "EveryoneLost" - show "MISSION FAILED" to everyone
+* "EveryoneLost" - Show "MISSION FAILED" to everyone
-* "SideScore" - show "YOUR SIDE WON" to side with largest score
+* "SideTickets" - Show "YOUR SIDE WON" to side/s with most tickets and "YOUR SIDE LOST" to everyone else
-* "GroupScore" - show "YOUR GROUP WON" to group with largest score
+* "SideScore" - Show "YOUR SIDE WON" to side with largest score
-* "PlayerScore" - show "YOU WON" to player with largest score
+* "GroupScore" - Show "YOUR GROUP WON" to group with largest score
-&nbsp;
+* "PlayerScore" - Show "YOU WON" to player with largest score
-| [[Boolean]]
-|x1= <code>"SideScore" [[call]] [[BIS_fnc_endMissionServer]];</code>
-| [[BIS_fnc_endMission]], [[failMission]], [[forceEnd]], [[endMission]]
-|}}
+|r1= [[Boolean]]
-[[Category:Functions|{{uc:endMissionServer}}]]
+|x1= <sqf>"SideScore" call BIS_fnc_endMissionServer;</sqf>
-[[Category:{{Name|arma3}}: Functions|{{uc:endMissionServer}}]]
-<!-- CONTINUE Notes -->
+|seealso= [[BIS_fnc_endMission]] [[failMission]] [[forceEnd]] [[endMission]]
-<!-- DISCONTINUE Notes -->
+}}