Class SteamGameServerStats

Namespace: SwiftlyS2.Shared.SteamAPI

Assembly: SwiftlyS2.CS2.dll

public static class SteamGameServerStats

Inheritance

• object
• SteamGameServerStats

Inherited Members

• object.Equals(object?)
• object.Equals(object?, object?)
• object.GetHashCode()
• object.GetType()
• object.MemberwiseClone()
• object.ReferenceEquals(object?, object?)
• object.ToString()

Methods

ClearUserAchievement(CSteamID, string)

public static bool ClearUserAchievement(CSteamID steamIDUser, string pchName)

• steamIDUser CSteamID
• pchName string

• bool

GetUserAchievement(CSteamID, string, out bool)

public static bool GetUserAchievement(CSteamID steamIDUser, string pchName, out bool pbAchieved)

• steamIDUser CSteamID
• pchName string
• pbAchieved bool

• bool

GetUserStat(CSteamID, string, out int)

requests stat information for a user, usable after a successful call to RequestUserStats()

public static bool GetUserStat(CSteamID steamIDUser, string pchName, out int pData)

• steamIDUser CSteamID
• pchName string
• pData int

• bool

GetUserStat(CSteamID, string, out float)

public static bool GetUserStat(CSteamID steamIDUser, string pchName, out float pData)

• steamIDUser CSteamID
• pchName string
• pData float

• bool

RequestUserStats(CSteamID)

downloads stats for the user

returns a GSStatsReceived_t callback when completed

if the user has no stats, GSStatsReceived_t.m_eResult will be set to k_EResultFail

these stats will only be auto-updated for clients playing on the server. For other

users you'll need to call RequestUserStats() again to refresh any data

public static SteamAPICall_t RequestUserStats(CSteamID steamIDUser)

• steamIDUser CSteamID

• SteamAPICall_t

SetUserAchievement(CSteamID, string)

public static bool SetUserAchievement(CSteamID steamIDUser, string pchName)

• steamIDUser CSteamID
• pchName string

• bool

SetUserStat(CSteamID, string, int)

Set / update stats and achievements.

Note: These updates will work only on stats game servers are allowed to edit and only for

game servers that have been declared as officially controlled by the game creators.

Set the IP range of your official servers on the Steamworks page

public static bool SetUserStat(CSteamID steamIDUser, string pchName, int nData)

• steamIDUser CSteamID
• pchName string
• nData int

• bool

SetUserStat(CSteamID, string, float)

public static bool SetUserStat(CSteamID steamIDUser, string pchName, float fData)

• steamIDUser CSteamID
• pchName string
• fData float

• bool

StoreUserStats(CSteamID)

Store the current data on the server, will get a GSStatsStored_t callback when set.

If the callback has a result of k_EResultInvalidParam, one or more stats

uploaded has been rejected, either because they broke constraints

or were out of date. In this case the server sends back updated values.

The stats should be re-iterated to keep in sync.

public static SteamAPICall_t StoreUserStats(CSteamID steamIDUser)

• steamIDUser CSteamID

• SteamAPICall_t

UpdateUserAvgRateStat(CSteamID, string, float, double)

public static bool UpdateUserAvgRateStat(CSteamID steamIDUser, string pchName, float flCountThisSession, double dSessionLength)

• steamIDUser CSteamID
• pchName string
• flCountThisSession float
• dSessionLength double

• bool