OnGameModeExit

(Difference between revisions)

Revision as of 13:28, 20 August 2016

Description:

This callback is called when a gamemode ends, either through 'gmx', the server being shut down, or GameModeExit.

Parameters:

This callback has no parameters.

Return Values:

This callback does not handle returns.

Notes

This function can also be used in a filterscript to detect if the gamemode changes with RCON commands like changemode or gmx, as changing the gamemode does not reload a filterscript.
When using OnGameModeExit() in conjunction with the 'rcon gmx' console command keep in mind there is a potential for client bugs to occur an example of this is excessive RemoveBuildingForPlayer() calls during OnGameModeInit() which could result in a client crash.
This callback will NOT be called if the server crashes or the process is killed by other means, such as using the Linux kill command or pressing the close-button on the Windows console.

Example Usage:

public OnGameModeExit()
{
    print("Gamemode ended.");
    return 1;
}

The following callbacks might be useful as well, as they are related to this callback in one way or another.

The following functions might be useful, as they're related to this callback in one way or another.

 {{NoReturnCallback}}
-{{note|This function can also be used in a filterscript to detect if the gamemode changes with [[RCON#RCON_Commands|RCON commands]] like changemode or gmx, as changing the gamemode does not reload a filterscript.}}
+{{notes|
+*This function can also be used in a filterscript to detect if the gamemode changes with [[RCON#RCON_Commands|RCON commands]] like changemode or gmx, as changing the gamemode does not reload a filterscript.
-{{note|When using OnGameModeExit() in conjunction with the 'rcon gmx' console command keep in mind there is a potential for client bugs to occur an example of this is excessive RemoveBuildingForPlayer() calls during OnGameModeInit() which could result in a client crash.}}
+*When using OnGameModeExit() in conjunction with the 'rcon gmx' console command keep in mind there is a potential for client bugs to occur an example of this is excessive RemoveBuildingForPlayer() calls during OnGameModeInit() which could result in a client crash.
+*This callback will NOT be called if the server crashes or the process is killed by other means, such as using the Linux kill command or pressing the close-button on the Windows console.
+}}
 {{Example}}