game / pragma.gameinstance / GameInstanceService / removePlayersV1 /

removePlayersV1 #

suspend fun removePlayersV1(session: PartnerSession, request: GameInstanceRpc.RemovePlayersV1Request): GameInstanceRpc.RemovePlayersV1Response

Remove players from a game instance. Invoked by the game server.

The players being removed are passed into the GameInstancePlugin.onRemovePlayers plugin method for an opportunity for custom data to be created on a ExtRemovedFromGame that is sent to the players on a GameInstanceRpc.RemovedFromGameV1Notification. Players can only be removed if they have not been previously removed.

The removed players are released and marked as removed from the game instance to be sent back to their party via the PartyRpc.ReturnFromGameInstanceV1Request.

Plugins

• GameInstancePlugin.onRemovePlayers - Perform updates to the player inventories and/or set custom data to send to the players.

PragmaResultErrors

• PragmaError.GameInstanceService_UnknownGameInstanceId - If the game instance id from the request is not found.
• PragmaError.GameInstanceService_PlayerNotInGameInstance - If the player is not in the game instance specified.