javasteam/in.dragonbra.javasteam.steam.handlers.steamuserstats/SteamUserStats

SteamUserStats

class SteamUserStats : ClientMsgHandler

This handler handles Steam user statistic related actions.

Constructors

SteamUserStats

constructor()

Types

Companion

object Companion

Functions

createLeaderboard

fun createLeaderboard(appId: Int, name: String, sortMethod: ELeaderboardSortMethod, displayType: ELeaderboardDisplayType): AsyncJobSingle<FindOrCreateLeaderboardCallback>

Asks the Steam back-end for a leaderboard by name, and will create it if it's not yet. Results are returned in a FindOrCreateLeaderboardCallback. The returned AsyncJobSingle can also be awaited to retrieve the callback result.

findLeaderBoard

fun findLeaderBoard(appId: Int, name: String?): AsyncJobSingle<FindOrCreateLeaderboardCallback>

Asks the Steam back-end for a leaderboard by name for a given appid. Results are returned in a FindOrCreateLeaderboardCallback. The returned AsyncJobSingle can also be awaited to retrieve the callback result.

getLeaderboardEntries

fun getLeaderboardEntries(appId: Int, id: Int, rangeStart: Int, rangeEnd: Int, dataRequest: ELeaderboardDataRequest): AsyncJobSingle<LeaderboardEntriesCallback>

Asks the Steam back-end for a set of rows in the leaderboard. Results are returned in a LeaderboardEntriesCallback. The returned AsyncJobSingle can also be awaited to retrieve the callback result.

getNumberOfCurrentPlayers

fun getNumberOfCurrentPlayers(appId: Int): AsyncJobSingle<NumberOfPlayersCallback>

Retrieves the number of current players for a given app id. Results are returned in a NumberOfPlayersCallback.

handleMsg

open override fun handleMsg(packetMsg: IPacketMsg)

Handles a client message. This should not be called directly.

setup

fun setup(client: SteamClient)