game-common / pragma.gameinstance / GameServerProviderPlugin /

GameServerProviderPlugin #

interface GameServerProviderPlugin

GameServerProviderPlugin is used to allocate a game server for a game instance.

Functions #

NameSummary

startAllocationForGameInstance

abstract suspend fun startAllocationForGameInstance(gameInstanceId: <ERROR CLASS>, ext: ExtAllocateGameServer, clientTokenFunction: () -> PartnerClientTokens, gameServerVersion: <ERROR CLASS>, gameServerZone: <ERROR CLASS>)

Invoked when GameInstance.GameInstance.allocateGameServer is called on a game instance in the GameInstancePlugin. Used to send a request to a game server hosting provider to allocate a game server. The game server must use the Pragma SDK to call MatchApi::RequestStartGame() with the gameInstanceId to complete the allocation.

Inheritors #

Name

LocalProcessGameServerProviderPlugin