API reference
API reference
Select your platform
No SDKs available
No versions available

LeaderboardEntry Class

A leaderboard entry object contains information about the Models.User who made the entry, their score, and other relevant details in the leaderboard. It provides a way for a game to keep track of players and their scores in relation to other. A single leaderboard entry can be written by Leaderboards.WriteEntry(). A block of leaderboard entries can be retrieved using Leaderboards.GetEntries(). Visit our website for more information about the leaderboard entry.

Constructors

LeaderboardEntry ( o )
Signature
Oculus.Platform.Models.LeaderboardEntry.LeaderboardEntry(IntPtr o)
Parameters
o: IntPtr

Fields

DisplayScore : readonly string
The formatted score that will be displayed in the leaderboard of this entry. You can select a score type to determine how scores are displayed on Leaderboard. See here for examples of different score type.
Signature
readonly string Oculus.Platform.Models.LeaderboardEntry.DisplayScore
ExtraData : readonly byte []
A 2KB custom data field that is associated with the leaderboard entry. This can be a game replay or anything that provides more detail about the entry to the viewer. It will be used by two entry methods: Leaderboards.WriteEntry() and Leaderboards.WriteEntryWithSupplementaryMetric()
Signature
readonly byte [] Oculus.Platform.Models.LeaderboardEntry.ExtraData
ID : readonly UInt64
This is a unique identifier for the leaderboard entry. It is of type id and is optional.
Signature
readonly UInt64 Oculus.Platform.Models.LeaderboardEntry.ID
Rank : readonly int
The rank of this leaderboard entry in the leaderboard. It is of type int. It can be used in Leaderboards.GetEntriesAfterRank() to retrieve leaderboard entries starting from a specified rank.
Signature
readonly int Oculus.Platform.Models.LeaderboardEntry.Rank
Score : readonly long
The raw underlying value of the score achieved by the user in the leaderboard. It's of type long_as_string and it's used to determine the user's rank in the leaderboard.
Signature
readonly long Oculus.Platform.Models.LeaderboardEntry.Score
SupplementaryMetric : readonly SupplementaryMetric
Signature
readonly SupplementaryMetric Oculus.Platform.Models.LeaderboardEntry.SupplementaryMetric
SupplementaryMetricOptional : readonly SupplementaryMetric
Models.SupplementaryMetric is a supplemental piece of data that can be used for tiebreakers by Leaderboards.WriteEntryWithSupplementaryMetric().
Signature
readonly SupplementaryMetric Oculus.Platform.Models.LeaderboardEntry.SupplementaryMetricOptional
Timestamp : readonly DateTime
The timestamp of this entry being created in the leaderboard.
Signature
readonly DateTime Oculus.Platform.Models.LeaderboardEntry.Timestamp
User : readonly User
User of this leaderboard entry. It is of type Models.User. You can request a block of leaderboard entries for the specified user ID(s) by Leaderboards.GetEntriesByIds().
Signature
readonly User Oculus.Platform.Models.LeaderboardEntry.User