game-common / pragma.matchmaking.matchables / Matchable /

Matchable #

interface Matchable : ConsumingMatchable, ProvidingMatchable

Interface for Matchables that consume and provide parties to other Matchables.

Functions #

NameSummary

findParty

abstract override fun findParty(partyId: UUID): Matchmaking.Party?

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

findPartyWithPlayer

abstract override fun findPartyWithPlayer(playerId: UUID): Matchmaking.Party?

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 override fun findPlayer(playerId: UUID): Matchmaking.Player?

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

takePartiesFrom

abstract override fun takePartiesFrom(providingMatchable: ProvidingMatchable, parties: List<Matchmaking.Party>)

Moves parties from the passed in Matchable to this Matchable. Ignores unknown parties.

Properties #

NameSummary

parties

abstract override val parties: List<Matchmaking.Party>

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 override val players: List<Matchmaking.Player>

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.

Inheritors #

Name

PotentialMatch