BIS fnc endMissionServer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (Added missing dynamically calculated ending type)
 
(44 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Multiplayer


|1.00|= Game version
|serverExec= server
____________________________________________________________________________________________


| <pre>/*
|eff= global


Description:
|descr= Ends the mission properly for all players in a multiplayer environment.
End the mission on all computers.
{{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>
Parameter(s):
}}
0: STRING - end type. Can be custom or one of dynamically calculated ones:
"Won" - show "MISSION COMPLETED" to everyone
"Lost" - show "MISSION FAILED" to everyone
"SideScore" - show "YOUR SIDE WON" to side with largest score
"GroupScore" - show "YOUR GROUP WON" to group with largest score
"PlayerScore" - show "YOUR WON" to player with largest score
 
Returns:
BOOL
*/
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_endMissionServer]]; --> |= Syntax


|p1= |= Parameter 1
|s1= endType call [[BIS_fnc_endMissionServer]]


| |= Return value
|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></code> |=
|r1= [[Boolean]]
____________________________________________________________________________________________


| |= See also
|x1= <sqf>"SideScore" call BIS_fnc_endMissionServer;</sqf>


|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}}]]

Latest revision as of 21:01, 27 March 2024

Arma 3 logo black.png1.00
GEGlobalSEServer
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 Arma 3 logo black.png1.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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_endMissionServer&oldid=363361"