Heathen KB
GitHub Sponsor
Home Page
Asset Store
Search…
General
Introduction
Heathen Group
General Guides
Asset Developers
Lore
Introduction
Ireland
Assets
Licensing
Art Assets
Blockchain Game SDK
PhysKit
Steamworks
Installation
Learning
API
Components
Objects
Achievement Object
Authentication Session
Authentication Ticket
Avg Rate Stat
Chat Room
Clan
Clan Chat Msg
Currency
Data Model
DLC Data
Downloadable Content Object
Favorite Game
Float Stat
Input Action
Input Action Data
Input Action Set
Input Action Set Layer
Int Stat
Inventory Result
Item Detail
Item Definition
Leaderboard Entry
Leaderboard Object
Lobby
Lobby Chat Msg
Lobby Game Server
Lobby Member
Party Beacon Details
Rank Change
Remote Storage File
Steam Settings
UGC Query
UGC Community Item
User Data
User Leave Data
User Lobby Leave Data
Workshop Item Data
Workshop Item Data Create Status
Workshop Item Key Value Tag
Workshop Item Preview File
Enums
uGUI Tools
System Core
User eXperience [UX]
Services
Introduction
Consulting & Contracting
Publishing
Powered By
GitBook
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
Previous
Item Definition
Next
Leaderboard Object
Last modified
5mo ago
Copy link
Contents
Definition
Fields and Attributes
Events
evtUgcDownloaded
Methods
Get Attachment
Start UGC Download
UGC Download Progress