game-common / pragma.matchmaking / NewGameInstance /
NewGameInstance #
class NewGameInstance(var ext: ExtGameInstance = ExtGameInstance.getDefaultInstance(), var requestExt: ExtBackendCreateRequest = ExtBackendCreateRequest.getDefaultInstance(), var gameServerZone: <ERROR CLASS>)
A NewGameInstance represents a successful matchmaking result that will be used to create a new game instance by triggering the GameInstancePlugin.handleBackendCreateRequest plugin method. A NewGameInstance should be constructed and returned from the MatchmakingPlugin.initialize or MatchmakingPlugin.matchParties plugin methods.
Constructors #
NewGameInstance | fun NewGameInstance(ext: ExtGameInstance = ExtGameInstance.getDefaultInstance(), requestExt: ExtBackendCreateRequest = ExtBackendCreateRequest.getDefaultInstance(), gameServerZone: <ERROR CLASS>) |
Functions #
Name | Summary |
---|---|
Select parties that should be added to the game instance. | |
Indicate that after the game instance is created, it should be immediately be added into matchmaking to find more players. | |
Set the ext for a player. | |
DEPRECATED in version 0.5.0, removal by 0.6.0. Use setExtForPlayer instead. | |
Set the team number on some players. |
Properties #
Name | Summary |
---|---|
A customer-defined payload of extra game information that will be used to create the game instance. | |
A string id that indicates which game server zone that game will be created within. | |
Calculated as true if NewGameInstance.continueMatchmaking has been called. | |
The key for the matchmaking queue that the game instance will be added to if NewGameInstance.continueMatchmaking is called. | |
The list of players in the NewGameInstance. List is copied when retrieved. | |
A customer-defined payload of extra game information that will be used to create the game instance. |