BIS fnc endMissionServer: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Remove "you")
m (Added missing dynamically calculated ending type)
 
(10 intermediate revisions by one other user not shown)
Line 11: Line 11:


|descr= 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:
{{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:
<code>["MyEnding", [[true]], 3] [[remoteExec]] ["BIS_fnc_endMission", 0, [[true]]];</code>
<sqf>["MyEnding", true, 3] remoteExec ["BIS_fnc_endMission", 0, true];</sqf>
}}
}}


|s1= 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>
|p1= endType: [[String]] - class name of ending defined in [[Description.ext#CfgDebriefing|CfgDebriefing]].<br>
Can be '''custom''' or one of dynamically calculated ones:
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
* "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
* "SideScore" - Show "YOUR SIDE WON" to side with largest score
* "GroupScore" - Show "YOUR GROUP WON" to group with largest score
* "GroupScore" - Show "YOUR GROUP WON" to group with largest score
Line 27: Line 28:
|r1= [[Boolean]]
|r1= [[Boolean]]


|x1= <code>"SideScore" [[call]] [[BIS_fnc_endMissionServer]];</code>
|x1= <sqf>"SideScore" call BIS_fnc_endMissionServer;</sqf>


|seealso= [[BIS_fnc_endMission]], [[failMission]], [[forceEnd]], [[endMission]]
|seealso= [[BIS_fnc_endMission]] [[failMission]] [[forceEnd]] [[endMission]]
}}
}}

Latest revision as of 21:01, 27 March 2024

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