game-common / pragma.gameinstance / GameInstanceApi / removePlayers /

removePlayers #

suspend fun removePlayers(gameInstanceId: <ERROR CLASS>, requestExt: ExtBackendRemovePlayersRequest, playersToRemove: Map<<ERROR CLASS>, ExtBackendRemovePlayer>): PragmaResult<Unit, PragmaFailure>

Request to remove players from a GameInstance. Triggers the GameInstancePlugin.handleBackendRemovePlayersRequest plugin method.

Parameters #

gameInstanceId

The id of the game instance to remove players from.

requestExt

The data to be sent along with the request.

playersToRemove

A map of player ids to ext data for each player to remove from the game instance.

Throws #

pragma.PragmaError.GameInstanceService_UnknownGameInstanceId

if a game instance is not found for the provided game instance id.