game-common / pragma.gameinstance / GameInstancePlugin / onGameInstanceExpired /
onGameInstanceExpired #
open suspend fun onGameInstanceExpired(gameInstanceSnapshot: GameInstance.GameInstance)
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.
Default implementation: terminates the game instance.
Parameters #
gameInstanceSnapshot | The game instance that has expired. |