Leaderboard Entry

Definition

1
public class LeaderboardEntry
Copied!
Represents an entry found on a leaderboard and contains data about that entry such as the user its related to, details and any attachments.

Fields and Attributes

Type
Name
Notes
LeaderboardEntry_t
entry
The native entry
int[]
details
Details loaded for the entry if any
UserData
User
The user the entry relates to
int
Rank
The rank aka position on the board for this entry
int
Score
The score for this entry
UGCHandle_t
UgcHandle
The handle to the attachment if any
bool
HasCashedUgcFileName
Do we have the file name for this attachment yet
string
cashedUgcFileName
The name for the attachment

Events

evtUgcDownloaded

Occurs when the UGC is downloaded.

Methods

Get Attachment

1
public void GetAttachedUgc<T>(callback);
Copied!
This starts, updats and completes a UGC download if required and returns the results on the callback in a single line call.
This will download the UGC attachment if any and invoke the callback with the results when finished.

Start UGC Download

1
public bool StartUgcDownload(priority, callback);
Copied!
Starts the process of downloading the UGC attachment if any. Returns false if the attachment handle is invalid e.g. no attachment present

UGC Download Progress

1
public float UgcDownloadProgress();
Copied!
returns the current progres of the UGC download. returns a value between 0 and 1