Unigine.Plugins.SteamLeaderboard Class
SteamLeaderboard Class
Перечисления (Enums)
DATA_REQUEST#
DISPLAY_TYPE#
SORT_METHOD#
| Имя | Описание |
|---|---|
| NONE = 0 | Only ever used when a leaderboard is invalid, you should never set this yourself. |
| ASCENDING = 1 | The top-score is the lowest number. |
| DESCENDING = 2 | The top-score is the highest number. |
Properties
int NumEntries#
The existing number of entries.
SteamLeaderboard.DISPLAY_TYPE DisplayType#
The type of data to be displayed with the leaderboard.
SteamLeaderboard.SORT_METHOD SortMethod#
The order for the leaderboard sorting.
int EntryCount#
The
SteamLeaderboard.DATA_REQUEST LastDataRequest#
The
bool IsLastDownloadFailed#
The
bool IsLastUploadFailed#
The
bool IsDownloading#
The Checks the leaderboard downloading status.
bool IsUploading#
The Checks the leaderboard uploading status.
bool IsFound#
The value stating if the leaderboard was found.
string Name#
The leaderboard name.
int ID#
The leaderboard id.
Members
bool Find ( ) #
Returns the value stating if the leaderboard was created.Return value
true if a leaderboard is created, otherwise false.bool FindOrCreate ( SteamLeaderboard.SORT_METHOD sort_method, SteamLeaderboard.DISPLAY_TYPE display_type ) #
Checks if a leaderboard is created, it will create it if it's not yet created.Arguments
- SteamLeaderboard.SORT_METHOD sort_method - The sort order of the new leaderboard if it's created.
- SteamLeaderboard.DISPLAY_TYPE display_type - The display type (used by the Steam Community web site) of the new leaderboard if it's created.
Return value
true if a leaderboard is created, otherwise false.bool UploadScore ( int score, bool forced = false ) #
Uploads the user score to the current leaderboard.Arguments
- int score - The value to store in the current leaderboard.
- bool forced - If set to true, the leaderboard will always replace score with specified; if set to false, the leaderboard will keep user's best score.
Return value
true if , otherwise false.bool DownloadScores ( SteamLeaderboard.DATA_REQUEST request, int num_before, int num_after ) #
Downloads a set of entries from the current leaderboard.Arguments
- SteamLeaderboard.DATA_REQUEST request - Type of requested data, one of the DATA_REQUEST values.
- int num_before - Number of entries before the current user.
- int num_after - Number of entries after the current user.
Return value
false if a leaderboard has not been selected yet, otherwise true.ulong GetEntryUserID ( int num ) #
Returns the ID of the user who this entry belongs to.Arguments
- int num - Number of an entry in a leaderboard.
Return value
The globally unique identifier for all Steam accounts.int GetEntryRank ( int num ) #
Returns the global rank of the entry.Arguments
- int num - Number of an entry in a leaderboard.
Return value
The global rank of this entry ranging from [1..N], where N is the number of users with an entry in the leaderboard.int GetEntryScore ( int num ) #
Returns the raw score of the entry as set in the leaderboard.Arguments
- int num - Number of an entry in a leaderboard.
Return value
The raw score as set in the leaderboard.Last update:
13.12.2024
Помогите сделать статью лучше
Была ли эта статья полезной?
(или выберите слово/фразу и нажмите Ctrl+Enter