Meta Developers

static Request< Models.LeaderboardEntryList >	GetNextEntries ( Models.LeaderboardEntryList list )
static Request< Models.LeaderboardEntryList >	GetPreviousEntries ( Models.LeaderboardEntryList list )
static Request< Models.LeaderboardList >	Get ( string leaderboardName )
static Request< Models.LeaderboardEntryList >	GetEntries ( string leaderboardName, int limit, LeaderboardFilterType filter, LeaderboardStartAt startAt )
static Request< Models.LeaderboardEntryList >	GetEntriesAfterRank ( string leaderboardName, int limit, ulong afterRank )
static Request< Models.LeaderboardEntryList >	GetEntriesByIds ( string leaderboardName, int limit, LeaderboardStartAt startAt, UInt64 [] userIDs )
static Request< bool >	WriteEntry ( string leaderboardName, long score, byte [] extraData, bool forceUpdate )
static Request< bool >	WriteEntryWithSupplementaryMetric ( string leaderboardName, long score, long supplementaryMetric, byte [] extraData, bool forceUpdate )
static Request< Models.LeaderboardList >	GetNextLeaderboardListPage ( Models.LeaderboardList list )

Details

Static Member Functions

static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetNextEntries ( Models.LeaderboardEntryList list )
No description available.

static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetPreviousEntries ( Models.LeaderboardEntryList list )
No description available.

static Request<Models.LeaderboardList> Oculus.Platform.Leaderboards.Get ( string leaderboardName )
Gets the information for a single leaderboard Parameters leaderboardName The name of the leaderboard to return.

static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetEntries ( string leaderboardName, int limit, LeaderboardFilterType filter, LeaderboardStartAt startAt )
Requests a block of leaderboard entries. Parameters leaderboardName The name of the leaderboard whose entries to return. limit Defines the maximum number of entries to return. filter By using ovrLeaderboard_FilterFriends, this allows you to filter the returned values to bidirectional followers. startAt Defines whether to center the query on the user or start at the top of the leaderboard. Error codes 100: Parameter {parameter}: invalid user id: {user_id} 100: Something went wrong. 12074: You're not yet ranked on this leaderboard.

static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetEntries
( string leaderboardName,
int limit,
LeaderboardFilterType filter,
LeaderboardStartAt startAt )

Requests a block of leaderboard entries.

Parameters

leaderboardName

The name of the leaderboard whose entries to return.

limit

Defines the maximum number of entries to return.

filter

By using ovrLeaderboard_FilterFriends, this allows you to filter the returned values to bidirectional followers.

startAt

Defines whether to center the query on the user or start at the top of the leaderboard.

Error codes

100: Parameter {parameter}: invalid user id: {user_id}
100: Something went wrong.
12074: You're not yet ranked on this leaderboard.

static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetEntriesAfterRank ( string leaderboardName, int limit, ulong afterRank )
Requests a block of leaderboard entries. Parameters leaderboardName The name of the leaderboard. limit The maximum number of entries to return. afterRank The position after which to start. For example, 10 returns leaderboard results starting with the 11th user.

static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetEntriesByIds ( string leaderboardName, int limit, LeaderboardStartAt startAt, UInt64 [] userIDs )
Requests a block of leaderboard entries. Will return only entries matching the user IDs passed in. Parameters leaderboardName The name of the leaderboard whose entries to return. limit Defines the maximum number of entries to return. startAt 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 Defines a list of user ids to get entries for.

static Request<Models.LeaderboardEntryList> Oculus.Platform.Leaderboards.GetEntriesByIds
( string leaderboardName,
int limit,
LeaderboardStartAt startAt,
UInt64 [] userIDs )

Requests a block of leaderboard entries. Will return only entries matching the user IDs passed in.

Parameters

leaderboardName

The name of the leaderboard whose entries to return.

limit

Defines the maximum number of entries to return.

startAt

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

Defines a list of user ids to get entries for.

static Request<bool> Oculus.Platform.Leaderboards.WriteEntry ( string leaderboardName, long score, byte [] extraData, bool forceUpdate )
Writes a single entry to a leaderboard. Parameters leaderboardName The leaderboard for which to write the entry. score The score to write. extraData 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 If true, the score always updates. This happens even if it is not the user's best score. 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.

static Request<bool> Oculus.Platform.Leaderboards.WriteEntry
( string leaderboardName,
long score,
byte [] extraData,
bool forceUpdate )

Writes a single entry to a leaderboard.

Parameters

leaderboardName

The leaderboard for which to write the entry.

score

The score to write.

extraData

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

If true, the score always updates. This happens even if it is not the user's best score.

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.

static Request<bool> Oculus.Platform.Leaderboards.WriteEntryWithSupplementaryMetric ( string leaderboardName, long score, long supplementaryMetric, byte [] extraData, bool forceUpdate )
Writes a single entry to a leaderboard, can include supplementary metrics Parameters leaderboardName The leaderboard for which to write the entry. score The score to write. supplementaryMetric A metric that can be used for tiebreakers. extraData 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 If true, the score always updates. This happens ecen if it is not the user's best score. 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.

static Request<bool> Oculus.Platform.Leaderboards.WriteEntryWithSupplementaryMetric
( string leaderboardName,
long score,
long supplementaryMetric,
byte [] extraData,
bool forceUpdate )

Writes a single entry to a leaderboard, can include supplementary metrics

Parameters

leaderboardName

The leaderboard for which to write the entry.

score

The score to write.

supplementaryMetric

A metric that can be used for tiebreakers.

extraData

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

If true, the score always updates. This happens ecen if it is not the user's best score.

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.