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

FOvrLeaderboardEntry Struct

A leaderboard entry object contains information about the FOvrUser 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 UOvrRequestsBlueprintLibrary::Leaderboard_WriteEntry(). A block of leaderboard entries can be retrieved using UOvrRequestsBlueprintLibrary::Leaderboard_GetEntries(). Visit our website for more information about the leaderboard entry.

Fields

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: UOvrRequestsBlueprintLibrary::Leaderboard_WriteEntry() and UOvrRequestsBlueprintLibrary::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 UOvrRequestsBlueprintLibrary::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.
FOvrSupplementaryMetric is a supplemental piece of data that can be used for tiebreakers by UOvrRequestsBlueprintLibrary::Leaderboard_WriteEntryWithSupplementaryMetric().
The timestamp of this entry being created in the leaderboard.
User of this leaderboard entry. It is of type FOvrUser. You can request a block of leaderboard entries for the specified user ID(s) by UOvrRequestsBlueprintLibrary::Leaderboard_GetEntriesByIds().

Member Functions

This is the default constructor for the struct, which initializes the ::ovrLeaderboardEntryHandle and TOvrMessageHandlePtr to their default values.
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Setting all values to their defaults, effectively clearing the struct.
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon