javasteam/in.dragonbra.javasteam.steam.steamclient.configuration/SteamConfiguration

SteamConfiguration

class SteamConfiguration

Configuration object to use. This object should not be mutated after it is passed to one or more SteamClient objects.

Types

Companion

object Companion

Properties

cellID

val cellID: Int

The Steam Cell ID to prioritize when connecting.

connectionTimeout

val connectionTimeout: Long

The connection timeout used when connecting to Steam serves.

defaultPersonaStateFlags

val defaultPersonaStateFlags: EnumSet<EClientPersonaStateFlag>

The default persona state flags used when requesting information for a new friend, or when calling SteamFriends.RequestFriendInfo without specifying flags.

httpClient

val httpClient: OkHttpClient

The http client

isAllowDirectoryFetch

val isAllowDirectoryFetch: Boolean

Whether to use the Steam Directory to discover available servers.

protocolTypes

val protocolTypes: EnumSet<ProtocolTypes>

The supported protocol types to use when attempting to connect to Steam.

serverList

val serverList: SmartCMServerList

The server list provider to use.

serverListProvider

val serverListProvider: IServerListProvider

The server list provider to use.

universe

val universe: EUniverse

The Universe to connect to. This should always be EUniverse.Public unless you work at Valve and are using this internally. If this is you, hello there.

webAPIBaseAddress

val webAPIBaseAddress: String

The base address of the Steam Web API to connect to. Use of "partner.steam-api.com" requires a Partner API key.

webAPIKey

val webAPIKey: String?

An API key to be used for authorized requests. Keys can be obtained from Steam Web API Documentation or the Steamworks Partner site.

Functions

getWebAPI

fun getWebAPI(interface: String): WebAPI

Retrieves a handler capable of interacting with the specified interface on the Web API.