JavaSteam/in.dragonbra.javasteam.steam.handlers.steammatchmaking

Package-level declarations

Types

DistanceFilter

class DistanceFilter(val value: ELobbyDistanceFilter) : Filter

Can be used to filter lobbies geographically (based on IP according to Steam's IP database).

Filter

abstract class Filter(val filterType: ELobbyFilterType, val key: String, val comparison: ELobbyComparison)

The lobby filter base class.

Lobby

class Lobby(val steamID: SteamID, val lobbyType: ELobbyType, val lobbyFlags: Int, val ownerSteamID: SteamID?, val metadata: Map<String, String> = mapOf(), val maxMembers: Int, val numMembers: Int, val members: List<Member> = listOf(), val distance: Float?, val weight: Long?)

Represents a Steam lobby.

LobbyCache

class LobbyCache

Cache for managing Steam lobbies.

Member

data class Member(val steamID: SteamID, val personaName: String, val metadata: Map<String, String> = emptyMap())

Represents a Steam user within a lobby.

NearValueFilter

class NearValueFilter(val key: String, val value: Int) : Filter

Can be used to filter lobbies with a metadata value closest to the specified value. Multiple near filters can be specified, with former filters taking precedence over latter filters.

NumericalFilter

class NumericalFilter(val key: String, val value: Int, val comparison: ELobbyComparison) : Filter

Can be used to filter lobbies by comparing an integer against a value in each lobby's metadata.

SlotsAvailableFilter

class SlotsAvailableFilter(val slotsAvailable: Int) : Filter

Can be used to filter lobbies by minimum number of slots available.

SteamMatchmaking

class SteamMatchmaking : ClientMsgHandler

This handler is used for creating, joining and obtaining lobby information.

StringFilter

class StringFilter(val key: String, val value: String, val comparison: ELobbyComparison) : Filter

Can be used to filter lobbies by comparing a string against a value in each lobby's metadata.