game / pragma.gameinstance / GameInstanceService / addPlayersServiceV1 /

addPlayersServiceV1 #

suspend fun addPlayersServiceV1(session: ServiceSession, request: GameInstanceRpc.AddPlayersServiceV1Request): GameInstanceRpc.AddPlayersServiceV1Response

Called by other backend services to add players to an existing GameInstance.

If the game instance is in matchmaking, the MatchmakingService will be provided the new players that were added.

Plugins

• GameInstancePlugin.handleBackendAddPlayersRequest - Process the addition(s).

PragmaResultErrors

• PragmaError.GameInstanceService_UnknownGameInstanceId - If the game instance id from request is not found.
• PragmaError.GameInstanceService_FailedToUpdateMatchmakingGameInstance - If the MatchmakingService.updateMatchmakingGameInstanceV1 call fails.
• PragmaError.GameInstanceService_InternalError - If a lock on the specified game instance could not be held.