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

onGameInstanceExpired #

open suspend fun onGameInstanceExpired(readOnlyGameInstance: GameInstance.ReadOnlyGameInstance)

Called when a game instance expires.

A game server expires when it is not interacted with by a player, game server, or backend service within the timeout defined by GameInstanceServiceConfig.staleGameInstanceExpirationMinutes. This only occurs if GameInstanceServiceConfig.enableStaleGameInstanceExpiration 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 that has expired.