API reference

OVR_LeaderboardEntry.h File

Typedefs

struct ovrLeaderboardEntry * ovrLeaderboardEntryHandle

Functions

const char * ovr_LeaderboardEntry_GetDisplayScore

( const ovrLeaderboardEntryHandle obj )

The score displayed in the leaderboard of this entry.

const char * ovr_LeaderboardEntry_GetExtraData

( const ovrLeaderboardEntryHandle obj )

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: ovr_Leaderboard_WriteEntry() and ovr_Leaderboard_WriteEntryWithSupplementaryMetric()

ovrID ovr_LeaderboardEntry_GetID

( const ovrLeaderboardEntryHandle obj )

The ID of this leaderboard entry.

int ovr_LeaderboardEntry_GetRank

( const ovrLeaderboardEntryHandle obj )

The rank of this leaderboard entry in the leaderboard.

long long ovr_LeaderboardEntry_GetScore

( const ovrLeaderboardEntryHandle obj )

The raw underlying value of the leaderboard entry score.

ovrSupplementaryMetricHandle ovr_LeaderboardEntry_GetSupplementaryMetric

( const ovrLeaderboardEntryHandle obj )

A metric that can be used for tiebreakers by ovr_Leaderboard_WriteEntryWithSupplementaryMetric(). This method may return null. This indicates that the value is not present or that the curent app or user is not permitted to access it.

unsigned long long ovr_LeaderboardEntry_GetTimestamp

( const ovrLeaderboardEntryHandle obj )

The timestamp of this entry being created in the leaderboard.

ovrUserHandle ovr_LeaderboardEntry_GetUser

( const ovrLeaderboardEntryHandle obj )

User of this leaderboard entry.

unsigned int ovr_LeaderboardEntry_GetExtraDataLength

( const ovrLeaderboardEntryHandle obj )