game-common / pragma.gameinstance / GameInstanceMatchmakingPlugin /

GameInstanceMatchmakingPlugin #

interface GameInstanceMatchmakingPlugin

GameInstanceMatchmakingPlugin is used to define custom interactions for a game instance and its players when entering matchmaking.

Functions #

NameSummary

buildExtMatchmakingGameInstance

open suspend fun buildExtMatchmakingGameInstance(gameInstance: GameInstance.GameInstance): ExtMatchmakingGameInstance

Called when a game instance is about to be sent to matchmaking. Use to declare any custom data about the game instance that needs to be sent to the MatchmakingService for use in MatchmakingPlugin.matchPartiesWithGame.

buildExtMatchmakingGamePlayer

open suspend fun buildExtMatchmakingGamePlayer(gameInstance: GameInstance.GameInstance, player: GameInstance.GamePlayer): ExtMatchmakingGamePlayer

Called when a game instance is about to be sent to matchmaking. Use to declare any custom data about the game party that needs to be sent to the MatchmakingService for use in MatchmakingPlugin.matchPartiesWithGame.

buildExtMatchmakingKey

open suspend fun buildExtMatchmakingKey(gameInstance: GameInstance.GameInstance): ExtMatchmakingKey

Called when a game instance is about to be sent to matchmaking. Use to declare any custom data about the matchmaking queue that the game instance is going to enter.