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

returnFromGameInstance #

open suspend fun returnFromGameInstance(party: Party.Party, returningPlayers: List<Party.PartyPlayer>, config: PartyConfig)

DEPRECATED in version 0.4.0 REMOVAL by 0.6.0.

Move your logic into PartyPlugin.handleBackendUpdateRequest and call PartyApi.update whenever players are removed from the game.

Called when players are returning from a game instance. Use to perform any necessary updates to the player or party state. The returning players may be a subset of all the players in the party.

Used by:

  • PartyService.returnFromGameInstanceV1

Parameters #

party

The party the players are in.

returningPlayers

The players that have left a game instance.

config

The party service configuration.