end screen - Global-Conflicts-ArmA/Olsen-Framework-Arma-3 GitHub Wiki
The end screen is shown when the mission has been completed based on the End Conditions. It can show a message about the end condition outcome reached, the amount of rounds fired per side, the casualty figures, and damaged equipment if tracked.
The mission end screen is activated is activated within the End Conditions file with either the EndMission
or the SoftEndMission
functions.
The EndMission
function call immediately brings up the end screen on players' machines. It will slightly fade in, then display for 30 seconds, then end the mission itself. The message the end screen displays is determined by the string in the call parameter, eg:
"USMC VICTORY<br />VDV has retreated due to casualties." call FUNC(EndMission);
results in:
Note the line break using <br/>
If you do not want the end screen to immediately activate but rather display a warning message before the actual end of the mission, you can use the SoftEndMission
function. eg:
["USMC VICTORY<br />VDV has retreated due to casualties.", "VDV has retreated due to casualties.", 10] call FUNC(softEndMission)
would result in the warn text appearing at the center top of every players' screen before the wait timer counts down and shows the regular end screen with the end message string.
[
<MISSION END MESSAGE: STRING>,
<MISSION END WARN MESSAGE: STRING | OPTIONAL>,
<TIME TO WAIT: NUMBER | OPTIONAL>
] call FUNC(SoftEndMission);
is called from the End Conditions.
Setting the time to wait parameter to -1 will stop the SoftEndMission
from stopping the mission and showing the end screen. eg:
[
"USMC VICTORY<br />VDV has retreated due to casualties.",
"VDV has retreated due to casualties.",
-1
] call FUNC(SoftEndMission);