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

create #

suspend fun create(requestExt: ExtBackendCreateRequest, playersToAdd: List<PlayerToAdd>, gameServerVersion: <ERROR CLASS>, gameServerZone: <ERROR CLASS>): PragmaResult<<ERROR CLASS>, PragmaFailure>

Request to create a game instance. Triggers the GameInstancePlugin.handleBackendCreateRequest plugin method.

Return #

The id of the created game instance.

Parameters #

requestExt

The data to be sent along with the request.

playersToAdd

A list of players to add to the game instance.

gameServerVersion

The game server version for the game instance.

gameServerZone

The game server zone for the game instance.