OVR_LeaderboardEntry.h File

A leaderboard entry object contains information about the ovrUserHandle 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 ovr_Leaderboard_WriteEntry(). A block of leaderboard entries can be retrieved using ovr_Leaderboard_GetEntries(). Visit our website for more information about the leaderboard entry.

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.

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()

This is a unique identifier for the leaderboard entry. It is of type id and is optional.

The rank of this leaderboard entry in the leaderboard. It is of type int. It can be used in ovr_Leaderboard_GetEntriesAfterRank() to retrieve leaderboard entries starting from a specified rank.

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.

ovrSupplementaryMetricHandle is a supplemental piece of data 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.

User of this leaderboard entry. It is of type ovrUserHandle. You can request a block of leaderboard entries for the specified user ID(s) by ovr_Leaderboard_GetEntriesByIds().