game-common / pragma.gameinstance / GameInstancePlugin / onGameServerDisconnected /

onGameServerDisconnected #

open suspend fun onGameServerDisconnected(readOnlyGameInstance: GameInstance.ReadOnlyGameInstance)

Called when a game server disconnects.

A game server disconnects when it does not send a GameInstanceRpc.GameKeepAliveV1Request within the timeout defined by GameInstanceServiceConfig.keepAliveMissesLimit and GameInstanceServiceConfig.keepAliveIntervalMillis. This only occurs if GameInstanceServiceConfig.enableKeepAlive is enabled.

The game instance will be terminated, triggering the GameInstanceApi::OnGameInstanceTerminated event on the player’s game client for each player in the game instance.

Parameters #

readOnlyGameInstance

A read-only version of the game instance whose linked game server disconnected.