BaseMatchable #

findParty

abstract fun findParty(partyId: UUID): MatchParty?

Finds a party within this Matchable with a given party ID. Returns null if the party is not found.

findPartyWithPlayer

abstract fun findPartyWithPlayer(playerId: UUID): MatchParty?

Finds a party that contains a specific player within this Matchable with a given player ID. Returns null if the party is not found.

findPlayer

abstract fun findPlayer(playerId: Fixed128): MatchPlayerInfo?

Finds a player within the parties in this Matchable with a given player ID. Returns null if the player is not found.

getQueueKey

open fun getQueueKey(): MatchmakingQueueKey

Get the QueueKey for this Matchable, which is the combination of a ExtMatchmakingKey and a GameServerVersion

gameServerVersion

abstract val gameServerVersion: String

The GameServerVersion for this Matchable. For a PotentialMatch, it represents the GameServerVersion for the match when it starts. For an ActiveMatch, it represents the value for the in progress match.

matchmakingKey

abstract val matchmakingKey: ExtMatchmakingKey

The MatchmakingKey for this Matchable. The custom Ext representing the characteristics of the queue this Matchable is in.

parties

abstract val parties: List<MatchParty>

The parties in this Matchable. The returned list is a snapshot of the current state of the Matchable and will not update, instead call the property again to get the updated state.

players

abstract val players: List<MatchPlayerInfo>

The players from each party in this Matchable. The returned list is a snapshot of the current state of the Matchable and will not update, instead call the property again to get the updated state.

ConsumingMatchable

ProvidingMatchable