LapinerTools.Steam.Data.LeaderboardsScoreEntry Class Reference

The LeaderboardsScoreEntry class stores all available data about a Steam leaderboard score entry. You can get the native Steam data (e.g. SteamLeaderboard) from the LeaderboardsScoreEntry.SteamNative property. Most properties are self-explanatory and not documented in more detail. More...

Classes
class	SteamNativeData
	The LeaderboardsScoreEntry.SteamNativeData class contains Steam native data such as SteamIDUser, UGCHandle or the SteamLeaderboard handle. You can use this data to make own calls to the Steamworks.NET API. More...

Public Member Functions
	LeaderboardsScoreEntry ()

Properties
string	LeaderboardName [get, set]
string	UserName [get, set]
int	GlobalRank [get, set]
int	Score [get, set]
string	ScoreString [get, set]
	Score formatted with SteamLeaderboardsMain.ScoreFormatNumeric or SteamLeaderboardsMain.ScoreFormatSeconds or SteamLeaderboardsMain.ScoreFormatMilliSeconds taking LeaderboardsScoreEntry.ScoreType into account. More...
ELeaderboardDisplayType	ScoreType [get, set]
	The display type of the leaderboard, which was used to upload the score. More...
int	DetailsAvailableLength [get, set]
	The length of the details array for this score entry available on Steam. Use the SteamLeaderboardsMain.ScoreDownloadDetailsLength property to download this data. More...
int []	DetailsDownloaded [get, set]
	The downloaded details array for this score entry. Use the SteamLeaderboardsMain.ScoreDownloadDetailsLength property to download this data. More...
string	DetailsDownloadedAsString [get]
	Converts LeaderboardsScoreEntry.DetailsDownloaded from an integer array to a string. Same as SteamLeaderboardsMain.ConvertIntArrayToStr. More...
bool	IsCurrentUserScore [get, set]
	True if this score entry belongs to the current user. More...
SteamNativeData	SteamNative [get, set]
	Contains Steam native data such as CSteamID, UGCHandle or the SteamLeaderboard handle. You can use this data to make own calls to the Steamworks.NET API. More...

Detailed Description

The LeaderboardsScoreEntry class stores all available data about a Steam leaderboard score entry. You can get the native Steam data (e.g. SteamLeaderboard) from the LeaderboardsScoreEntry.SteamNative property. Most properties are self-explanatory and not documented in more detail.

Constructor & Destructor Documentation

LeaderboardsScoreEntry()

LapinerTools.Steam.Data.LeaderboardsScoreEntry.LeaderboardsScoreEntry

(

)

Property Documentation

DetailsAvailableLength

int LapinerTools.Steam.Data.LeaderboardsScoreEntry.DetailsAvailableLength

getset

The length of the details array for this score entry available on Steam. Use the SteamLeaderboardsMain.ScoreDownloadDetailsLength property to download this data.

DetailsDownloaded

int [] LapinerTools.Steam.Data.LeaderboardsScoreEntry.DetailsDownloaded

getset

The downloaded details array for this score entry. Use the SteamLeaderboardsMain.ScoreDownloadDetailsLength property to download this data.

DetailsDownloadedAsString

string LapinerTools.Steam.Data.LeaderboardsScoreEntry.DetailsDownloadedAsString

get

Converts LeaderboardsScoreEntry.DetailsDownloaded from an integer array to a string. Same as SteamLeaderboardsMain.ConvertIntArrayToStr.

GlobalRank

int LapinerTools.Steam.Data.LeaderboardsScoreEntry.GlobalRank

getset

IsCurrentUserScore

bool LapinerTools.Steam.Data.LeaderboardsScoreEntry.IsCurrentUserScore

getset

True if this score entry belongs to the current user.

LeaderboardName

string LapinerTools.Steam.Data.LeaderboardsScoreEntry.LeaderboardName

getset

Score

int LapinerTools.Steam.Data.LeaderboardsScoreEntry.Score

getset

ScoreString

string LapinerTools.Steam.Data.LeaderboardsScoreEntry.ScoreString

getset

Score formatted with SteamLeaderboardsMain.ScoreFormatNumeric or SteamLeaderboardsMain.ScoreFormatSeconds or SteamLeaderboardsMain.ScoreFormatMilliSeconds taking LeaderboardsScoreEntry.ScoreType into account.

ScoreType

ELeaderboardDisplayType LapinerTools.Steam.Data.LeaderboardsScoreEntry.ScoreType

getset

The display type of the leaderboard, which was used to upload the score.

SteamNative

SteamNativeData LapinerTools.Steam.Data.LeaderboardsScoreEntry.SteamNative

getset

Contains Steam native data such as CSteamID, UGCHandle or the SteamLeaderboard handle. You can use this data to make own calls to the Steamworks.NET API.

UserName

string LapinerTools.Steam.Data.LeaderboardsScoreEntry.UserName

getset

---

The documentation for this class was generated from the following file:

• LapinerTools/Steam/Leaderboards/Scripts/Data/LeaderboardsScoreEntry.cs