OnGameModeExit

OnGameModeExit

Description:

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

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.

Parameters:

(This callback has no parameters.)

Return Values:

• 0 - Will prevent other filterscripts from receiving this callback.
• 1 - Indicates that this callback will be passed to the next filterscript.
• It is always called first in gamemode.

Examples:

Example 1

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

Related Callbacks

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

• OnGameModeInit: Called when a gamemode starts.
• OnFilterScriptInit: Called when a filterscript is loaded.
• OnFilterScriptExit: Called when a filterscript is unloaded.