game-common / pragma.party / PartyPlugin / onPartyExpired /

onPartyExpired #

open suspend fun onPartyExpired(readOnlyParty: Party.ReadOnlyParty)

Called when a party expires.

A party expires when it is not interacted with by a player or backend service within the timeout defined by PartyConfig.stalePartyExpirationMinutes. This only occurs if PartyConfig.enableStalePartyExpiration is enabled.

The party will be shutdown, triggering the PartyApi::OnRemovedFromParty event on the player’s game client for each player in the party.

Parameters #

readOnlyParty

A read-only version of the party that has expired.