game-common / pragma.gameinstance / GameInstanceMatchmakingPlugin / buildExtMatchmakingKey /

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.

Used by:

  • GameInstance.enterMatchmakingV1
  • GameInstance.createMatchV2 (if GameInstance is to continue matchmaking after being created)

Return #

A customer-defined ext describing which matchmaking queue the game instance should enter.

Parameters #

gameInstance

The game being sent to matchmaking.