game-common / pragma.matchmaking / MatchmakingPlugin / initialize /

initialize #

open fun initialize(queueKey: MatchmakingRpc.MatchmakingQueueKey, party: Matchmaking.Party): NewGameInstance?

Called with a new Matchmaking.Party before it enters matchmaking. Perform any validation logic or initial transformations to party or players here. Return a NewGameInstance to start the game instance before it enters the matchmaking queue. Return null to continue to the matchmaking queue. If the Matchmaking.Party is not valid, prevent it from entering matchmaking by throwing an ExtException.

If returning a NewGameInstance:

If this method throws an exception the Matchmaking.Party that is being initialized will be rejected from the queue.

Parameters #


There are separate queues for each distinct MatchmakingQueueKey.


The newly created Matchmaking.Party representing a party entering a matchmaking queue.