Class ISteamUserStats

Namespace

MarymoorStudios.Core.Steamworks

Assembly

MarymoorStudios.Core.Steamworks.dll

public sealed class ISteamUserStats : SteamNativeObject

Inheritance

object

SteamNativeObject

ISteamUserStats

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

INTERFACE_VERSION

public const string INTERFACE_VERSION = "STEAMUSERSTATS_INTERFACE_VERSION013"

Field Value

string

Methods

AttachLeaderboardUGC(SteamLeaderboard, UGCHandle)

public Promise<LeaderboardUGCSet> AttachLeaderboardUGC(SteamLeaderboard steamLeaderboard, UGCHandle uGC)

Parameters

steamLeaderboard SteamLeaderboard

uGC UGCHandle

Returns

Promise<LeaderboardUGCSet>

ClearAchievement(string)

public bool ClearAchievement(string name)

Parameters

name string

Returns

bool

DownloadLeaderboardEntries(SteamLeaderboard, ELeaderboardDataRequest, int, int)

public Promise<LeaderboardScoresDownloaded> DownloadLeaderboardEntries(SteamLeaderboard steamLeaderboard, ELeaderboardDataRequest leaderboardDataRequest, int rangeStart, int rangeEnd)

Parameters

steamLeaderboard SteamLeaderboard

leaderboardDataRequest ELeaderboardDataRequest

rangeStart int

rangeEnd int

Returns

Promise<LeaderboardScoresDownloaded>

DownloadLeaderboardEntriesForUsers(SteamLeaderboard, Span<CSteamID>)

public Promise<LeaderboardScoresDownloaded> DownloadLeaderboardEntriesForUsers(SteamLeaderboard steamLeaderboard, Span<CSteamID> prgUsers)

Parameters

steamLeaderboard SteamLeaderboard

prgUsers Span<CSteamID>

Returns

Promise<LeaderboardScoresDownloaded>

FindLeaderboard(string)

public Promise<LeaderboardFindResult> FindLeaderboard(string leaderboardName)

Parameters

leaderboardName string

Returns

Promise<LeaderboardFindResult>

FindOrCreateLeaderboard(string, ELeaderboardSortMethod, ELeaderboardDisplayType)

public Promise<LeaderboardFindResult> FindOrCreateLeaderboard(string leaderboardName, ELeaderboardSortMethod leaderboardSortMethod, ELeaderboardDisplayType leaderboardDisplayType)

Parameters

leaderboardName string

leaderboardSortMethod ELeaderboardSortMethod

leaderboardDisplayType ELeaderboardDisplayType

Returns

Promise<LeaderboardFindResult>

GetAchievement(string, out bool)

public bool GetAchievement(string name, out bool achieved)

Parameters

name string

achieved bool

Returns

bool

GetAchievementAchievedPercent(string, out float)

public bool GetAchievementAchievedPercent(string name, out float percent)

Parameters

name string

percent float

Returns

bool

GetAchievementAndUnlockTime(string, out bool, out uint)

public bool GetAchievementAndUnlockTime(string name, out bool achieved, out uint unlockTime)

Parameters

name string

achieved bool

unlockTime uint

Returns

bool

GetAchievementDisplayAttribute(string, string)

public string GetAchievementDisplayAttribute(string name, string key)

Parameters

name string

key string

Returns

string

GetAchievementIcon(string)

public int GetAchievementIcon(string name)

Parameters

name string

Returns

int

GetAchievementName(uint)

public string GetAchievementName(uint achievement)

Parameters

achievement uint

Returns

string

GetAchievementProgressLimits(string, out int, out int)

public bool GetAchievementProgressLimits(string name, out int minProgress, out int maxProgress)

Parameters

name string

minProgress int

maxProgress int

Returns

bool

GetAchievementProgressLimits(string, out float, out float)

public bool GetAchievementProgressLimits(string name, out float pfMinProgress, out float pfMaxProgress)

Parameters

name string

pfMinProgress float

pfMaxProgress float

Returns

bool

GetDownloadedLeaderboardEntry(SteamLeaderboardEntries, int, out LeaderboardEntry, Span<int>)

public bool GetDownloadedLeaderboardEntry(SteamLeaderboardEntries steamLeaderboardEntries, int index, out LeaderboardEntry leaderboardEntry, Span<int> details)

Parameters

steamLeaderboardEntries SteamLeaderboardEntries

index int

leaderboardEntry LeaderboardEntry

details Span<int>

Returns

bool

GetGlobalStat(string, out double)

public bool GetGlobalStat(string statName, out double data)

Parameters

statName string

data double

Returns

bool

GetGlobalStat(string, out long)

public bool GetGlobalStat(string statName, out long data)

Parameters

statName string

data long

Returns

bool

GetGlobalStatHistory(string, Span<double>)

public int GetGlobalStatHistory(string statName, Span<double> data)

Parameters

statName string

data Span<double>

Returns

int

GetGlobalStatHistory(string, Span<long>)

public int GetGlobalStatHistory(string statName, Span<long> data)

Parameters

statName string

data Span<long>

Returns

int

GetLeaderboardDisplayType(SteamLeaderboard)

public ELeaderboardDisplayType GetLeaderboardDisplayType(SteamLeaderboard steamLeaderboard)

Parameters

steamLeaderboard SteamLeaderboard

Returns

ELeaderboardDisplayType

GetLeaderboardEntryCount(SteamLeaderboard)

public int GetLeaderboardEntryCount(SteamLeaderboard steamLeaderboard)

Parameters

steamLeaderboard SteamLeaderboard

Returns

int

GetLeaderboardName(SteamLeaderboard)

public string GetLeaderboardName(SteamLeaderboard steamLeaderboard)

Parameters

steamLeaderboard SteamLeaderboard

Returns

string

GetLeaderboardSortMethod(SteamLeaderboard)

public ELeaderboardSortMethod GetLeaderboardSortMethod(SteamLeaderboard steamLeaderboard)

Parameters

steamLeaderboard SteamLeaderboard

Returns

ELeaderboardSortMethod

GetMostAchievedAchievementInfo(Span<byte>, out float, out bool)

public int GetMostAchievedAchievementInfo(Span<byte> name, out float percent, out bool achieved)

Parameters

name Span<byte>

percent float

achieved bool

Returns

int

GetNextMostAchievedAchievementInfo(int, Span<byte>, out float, out bool)

public int GetNextMostAchievedAchievementInfo(int iteratorPrevious, Span<byte> name, out float percent, out bool achieved)

Parameters

iteratorPrevious int

name Span<byte>

percent float

achieved bool

Returns

int

GetNumAchievements()

public uint GetNumAchievements()

Returns

uint

GetNumberOfCurrentPlayers()

public Promise<NumberOfCurrentPlayers> GetNumberOfCurrentPlayers()

Returns

Promise<NumberOfCurrentPlayers>

GetStat(string, out int)

public bool GetStat(string name, out int data)

Parameters

name string

data int

Returns

bool

GetStat(string, out float)

public bool GetStat(string name, out float data)

Parameters

name string

data float

Returns

bool

GetUserAchievement(CSteamID, string, out bool)

public bool GetUserAchievement(CSteamID steamIDUser, string name, out bool achieved)

Parameters

steamIDUser CSteamID

name string

achieved bool

Returns

bool

GetUserAchievementAndUnlockTime(CSteamID, string, out bool, out uint)

public bool GetUserAchievementAndUnlockTime(CSteamID steamIDUser, string name, out bool achieved, out uint unlockTime)

Parameters

steamIDUser CSteamID

name string

achieved bool

unlockTime uint

Returns

bool

GetUserStat(CSteamID, string, out int)

public bool GetUserStat(CSteamID steamIDUser, string name, out int data)

Parameters

steamIDUser CSteamID

name string

data int

Returns

bool

GetUserStat(CSteamID, string, out float)

public bool GetUserStat(CSteamID steamIDUser, string name, out float data)

Parameters

steamIDUser CSteamID

name string

data float

Returns

bool

IndicateAchievementProgress(string, uint, uint)

public bool IndicateAchievementProgress(string name, uint curProgress, uint maxProgress)

Parameters

name string

curProgress uint

maxProgress uint

Returns

bool

OnGSStatsUnloaded(CallbackAction<GSStatsUnloaded>)

public IDisposable OnGSStatsUnloaded(CallbackAction<GSStatsUnloaded> func)

Parameters

func CallbackAction<GSStatsUnloaded>

Returns

IDisposable

OnUserAchievementIconFetched(CallbackAction<UserAchievementIconFetched>)

public IDisposable OnUserAchievementIconFetched(CallbackAction<UserAchievementIconFetched> func)

Parameters

func CallbackAction<UserAchievementIconFetched>

Returns

IDisposable

OnUserAchievementStored(CallbackAction<UserAchievementStored>)

public IDisposable OnUserAchievementStored(CallbackAction<UserAchievementStored> func)

Parameters

func CallbackAction<UserAchievementStored>

Returns

IDisposable

OnUserStatsStored(CallbackAction<UserStatsStored>)

public IDisposable OnUserStatsStored(CallbackAction<UserStatsStored> func)

Parameters

func CallbackAction<UserStatsStored>

Returns

IDisposable

OnUserStatsUnloaded(CallbackAction<UserStatsUnloaded>)

public IDisposable OnUserStatsUnloaded(CallbackAction<UserStatsUnloaded> func)

Parameters

func CallbackAction<UserStatsUnloaded>

Returns

IDisposable

RequestGlobalAchievementPercentages()

public Promise<GlobalAchievementPercentagesReady> RequestGlobalAchievementPercentages()

Returns

Promise<GlobalAchievementPercentagesReady>

RequestGlobalStats(int)

public Promise<GlobalStatsReceived> RequestGlobalStats(int historyDays)

Parameters

historyDays int

Returns

Promise<GlobalStatsReceived>

RequestUserStats(CSteamID)

public Promise<UserStatsReceived> RequestUserStats(CSteamID steamIDUser)

Parameters

steamIDUser CSteamID

Returns

Promise<UserStatsReceived>

ResetAllStats(bool)

public bool ResetAllStats(bool achievementsToo)

Parameters

achievementsToo bool

Returns

bool

SetAchievement(string)

public bool SetAchievement(string name)

Parameters

name string

Returns

bool

SetStat(string, int)

public bool SetStat(string name, int data)

Parameters

name string

data int

Returns

bool

SetStat(string, float)

public bool SetStat(string name, float data)

Parameters

name string

data float

Returns

bool

StoreStats()

public bool StoreStats()

Returns

bool

UpdateAvgRateStat(string, float, double)

public bool UpdateAvgRateStat(string name, float countThisSession, double sessionLength)

Parameters

name string

countThisSession float

sessionLength double

Returns

bool

UploadLeaderboardScore(SteamLeaderboard, ELeaderboardUploadScoreMethod, int, ReadOnlySpan<int>)

public Promise<LeaderboardScoreUploaded> UploadLeaderboardScore(SteamLeaderboard steamLeaderboard, ELeaderboardUploadScoreMethod leaderboardUploadScoreMethod, int score, ReadOnlySpan<int> scoreDetails)

Parameters

steamLeaderboard SteamLeaderboard

leaderboardUploadScoreMethod ELeaderboardUploadScoreMethod

score int

scoreDetails ReadOnlySpan<int>

Returns

Promise<LeaderboardScoreUploaded>