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

LeaderboardEntry Class

A leaderboard entry object contains information about the com.meta.horizon.platform.ovr.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 [com.meta.horizon.platform.ovr.requests.Leaderboards#writeEntry(String leaderboardName, long score, byte[] extraData, boolean forceUpdate)](classcom_1_1meta_1_1horizon_1_1platform_1_1ovr_1_1requests_1_1_leaderboards_1af4ca5d92acd4c1adc37daa338de90aeb). A block of leaderboard entries can be retrieved using com.meta.horizon.platform.ovr.requests.Leaderboards#getEntries(String leaderboardName, int limit, LeaderboardFilterType filter, LeaderboardStartAt startAt). Visit our website for more information about the leaderboard entry.

Constructors

LeaderboardEntry ( ptr )
Signature
com.meta.horizon.platform.ovr.models.LeaderboardEntry.LeaderboardEntry(final long ptr)
Parameters
ptr: final long

Methods

getDisplayScore ()
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
String com.meta.horizon.platform.ovr.models.LeaderboardEntry.getDisplayScore()
Returns
String  String
getExtraData ()
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: [com.meta.horizon.platform.ovr.requests.Leaderboards#writeEntry(String leaderboardName, long score, byte[] extraData, boolean forceUpdate)](classcom_1_1meta_1_1horizon_1_1platform_1_1ovr_1_1requests_1_1_leaderboards_1af4ca5d92acd4c1adc37daa338de90aeb) and [com.meta.horizon.platform.ovr.requests.Leaderboards#writeEntryWithSupplementaryMetric(String leaderboardName, long score, long supplementaryMetric, byte[] extraData, boolean forceUpdate)](classcom_1_1meta_1_1horizon_1_1platform_1_1ovr_1_1requests_1_1_leaderboards_1ac28b9008ffad885e3730e485a0bb2afc)
Signature
byte [] com.meta.horizon.platform.ovr.models.LeaderboardEntry.getExtraData()
Returns
byte []  byte[]
getID ()
This is a unique identifier for the leaderboard entry. It is of type id and is optional.
Signature
long com.meta.horizon.platform.ovr.models.LeaderboardEntry.getID()
Returns
long  long
getRank ()
The rank of this leaderboard entry in the leaderboard. It is of type int. It can be used in com.meta.horizon.platform.ovr.requests.Leaderboards#getEntriesAfterRank(String leaderboardName, int limit, long afterRank) to retrieve leaderboard entries starting from a specified rank.
Signature
int com.meta.horizon.platform.ovr.models.LeaderboardEntry.getRank()
Returns
int  int
getScore ()
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
long com.meta.horizon.platform.ovr.models.LeaderboardEntry.getScore()
Returns
long  long
getSupplementaryMetric ()
com.meta.horizon.platform.ovr.models.SupplementaryMetric is a supplemental piece of data that can be used for tiebreakers by [com.meta.horizon.platform.ovr.requests.Leaderboards#writeEntryWithSupplementaryMetric(String leaderboardName, long score, long supplementaryMetric, byte[] extraData, boolean forceUpdate)](classcom_1_1meta_1_1horizon_1_1platform_1_1ovr_1_1requests_1_1_leaderboards_1ac28b9008ffad885e3730e485a0bb2afc).
Signature
SupplementaryMetric com.meta.horizon.platform.ovr.models.LeaderboardEntry.getSupplementaryMetric()
getTimestamp ()
The timestamp of this entry being created in the leaderboard.
Signature
LocalDateTime com.meta.horizon.platform.ovr.models.LeaderboardEntry.getTimestamp()
Returns
LocalDateTime  LocalDateTime
getUser ()
User of this leaderboard entry. It is of type com.meta.horizon.platform.ovr.models.User. You can request a block of leaderboard entries for the specified user ID(s) by [com.meta.horizon.platform.ovr.requests.Leaderboards#getEntriesByIds(String leaderboardName, int limit, LeaderboardStartAt startAt, long[] userIDs)](classcom_1_1meta_1_1horizon_1_1platform_1_1ovr_1_1requests_1_1_leaderboards_1a00db9de52ef423d2e27707aec94723cb).
Signature
User com.meta.horizon.platform.ovr.models.LeaderboardEntry.getUser()
Returns
User User