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

Leaderboards Class

Static Methods

Get ( leaderboardName )
Gets the information for a single leaderboard
Signature
static Request<Models.LeaderboardList> Oculus.Platform.Leaderboards.Get(string leaderboardName)
Parameters
leaderboardName: string  The name of the leaderboard to return.
GetEntries ( leaderboardName , limit , filter , startAt )
Requests a block of leaderboard entries. Error codes
  • 100: Parameter {parameter}: invalid user id: {user_id}
  • 100: Something went wrong.
  • 12074: You're not yet ranked on this leaderboard.
Signature
static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetEntries(string leaderboardName, int limit, LeaderboardFilterType filter, LeaderboardStartAt startAt)
Parameters
leaderboardName: string  The name of the leaderboard whose entries to return.
limit: int  Defines the maximum number of entries to return.
filter: LeaderboardFilterType  By using ovrLeaderboard_FilterFriends, this allows you to filter the returned values to bidirectional followers.
startAt: LeaderboardStartAt  Defines whether to center the query on the user or start at the top of the leaderboard.
GetEntriesAfterRank ( leaderboardName , limit , afterRank )
Requests a block of leaderboard entries.
Signature
static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetEntriesAfterRank(string leaderboardName, int limit, ulong afterRank)
Parameters
leaderboardName: string  The name of the leaderboard.
limit: int  The maximum number of entries to return.
afterRank: ulong  The position after which to start. For example, 10 returns leaderboard results starting with the 11th user.
GetEntriesByIds ( leaderboardName , limit , startAt , userIDs )
Requests a block of leaderboard entries. Will return only entries matching the user IDs passed in.
Signature
static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetEntriesByIds(string leaderboardName, int limit, LeaderboardStartAt startAt, UInt64[] userIDs)
Parameters
leaderboardName: string  The name of the leaderboard whose entries to return.
limit: int  Defines the maximum number of entries to return.
startAt: LeaderboardStartAt  Defines whether to center the query on the user or start at the top of the leaderboard. If this is LeaderboardStartAt.CenteredOnViewer or LeaderboardStartAt.CenteredOnViewerOrTop, then the current user's ID will be automatically added to the query.
userIDs: UInt64 []  Defines a list of user ids to get entries for.
GetNextEntries ( list )
Signature
static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetNextEntries(Models.LeaderboardEntryList list)
GetNextLeaderboardListPage ( list )
Signature
static Request<Models.LeaderboardList> Oculus.Platform.Leaderboards.GetNextLeaderboardListPage(Models.LeaderboardList list)
Parameters
GetPreviousEntries ( list )
Signature
static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetPreviousEntries(Models.LeaderboardEntryList list)
WriteEntry ( leaderboardName , score , extraData , forceUpdate )
Writes a single entry to a leaderboard. Error codes
  • 100: Parameter {parameter}: invalid user id: {user_id}
  • 100: Something went wrong.
  • 100: This leaderboard entry is too late for the leaderboard's allowed time window.
Signature
static Request<bool> Oculus.Platform.Leaderboards.WriteEntry(string leaderboardName, long score, byte[] extraData=null, bool forceUpdate=false)
Parameters
leaderboardName: string  The leaderboard for which to write the entry.
score: long  The score to write.
extraData: 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.
forceUpdate: bool  If true, the score always updates. This happens even if it is not the user's best score.
Returns
Request< bool >
WriteEntryWithSupplementaryMetric ( leaderboardName , score , supplementaryMetric , extraData , forceUpdate )
Writes a single entry to a leaderboard, can include supplementary metrics Error codes
  • 100: Parameter {parameter}: invalid user id: {user_id}
  • 100: Something went wrong.
  • 100: This leaderboard entry is too late for the leaderboard's allowed time window.
Signature
static Request<bool> Oculus.Platform.Leaderboards.WriteEntryWithSupplementaryMetric(string leaderboardName, long score, long supplementaryMetric, byte[] extraData=null, bool forceUpdate=false)
Parameters
leaderboardName: string  The leaderboard for which to write the entry.
score: long  The score to write.
supplementaryMetric: long  A metric that can be used for tiebreakers.
extraData: 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.
forceUpdate: bool  If true, the score always updates. This happens ecen if it is not the user's best score.
Returns
Request< bool >