C# Class Steamworks.SteamGameServerStats

Mostrar archivo Open project: rlabrecque/Steamworks.NET

Public Methods

Method	Description
ClearUserAchievement ( CSteamID steamIDUser, string pchName ) : bool
GetUserAchievement ( CSteamID steamIDUser, string pchName, bool &pbAchieved ) : bool
GetUserStat ( CSteamID steamIDUser, string pchName, float &pData ) : bool
GetUserStat ( CSteamID steamIDUser, string pchName, int &pData ) : bool	requests stat information for a user, usable after a successful call to RequestUserStats()
RequestUserStats ( CSteamID steamIDUser ) : SteamAPICall_t	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
SetUserAchievement ( CSteamID steamIDUser, string pchName ) : bool
SetUserStat ( CSteamID steamIDUser, string pchName, float fData ) : bool
SetUserStat ( CSteamID steamIDUser, string pchName, int nData ) : bool	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
StoreUserStats ( CSteamID steamIDUser ) : SteamAPICall_t	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.
UpdateUserAvgRateStat ( CSteamID steamIDUser, string pchName, float flCountThisSession, double dSessionLength ) : bool

Method Details

ClearUserAchievement() public static method

public static ClearUserAchievement ( CSteamID steamIDUser, string pchName ) : bool
steamIDUser	CSteamID
pchName	string
return	bool

GetUserAchievement() public static method

public static GetUserAchievement ( CSteamID steamIDUser, string pchName, bool &pbAchieved ) : bool
steamIDUser	CSteamID
pchName	string
pbAchieved	bool
return	bool

GetUserStat() public static method

public static GetUserStat ( CSteamID steamIDUser, string pchName, float &pData ) : bool
steamIDUser	CSteamID
pchName	string
pData	float
return	bool

GetUserStat() public static method

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

public static GetUserStat ( CSteamID steamIDUser, string pchName, int &pData ) : bool
steamIDUser	CSteamID
pchName	string
pData	int
return	bool

RequestUserStats() public static method

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 RequestUserStats ( CSteamID steamIDUser ) : SteamAPICall_t
steamIDUser	CSteamID
return	SteamAPICall_t

SetUserAchievement() public static method

public static SetUserAchievement ( CSteamID steamIDUser, string pchName ) : bool
steamIDUser	CSteamID
pchName	string
return	bool

SetUserStat() public static method

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

SetUserStat() public static method

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 SetUserStat ( CSteamID steamIDUser, string pchName, int nData ) : bool
steamIDUser	CSteamID
pchName	string
nData	int
return	bool

StoreUserStats() public static method

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 StoreUserStats ( CSteamID steamIDUser ) : SteamAPICall_t
steamIDUser	CSteamID
return	SteamAPICall_t

UpdateUserAvgRateStat() public static method

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