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

FOvrLeaderboardEntry Struct

An leaderboard entry object contains information about a user in the leaderboard.

Constructors

FOvrLeaderboardEntry ()
Signature
FOvrLeaderboardEntry::FOvrLeaderboardEntry()
FOvrLeaderboardEntry ( OvrHandle , MessageHandlePtr )
Signature
FOvrLeaderboardEntry::FOvrLeaderboardEntry(ovrLeaderboardEntryHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters

Fields

DisplayScore : FString
The score displayed in the leaderboard of this entry.
Signature
FString FOvrLeaderboardEntry::DisplayScore
ExtraData : TArray< uint8 >
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: Leaderboard_WriteEntry() and Leaderboard_WriteEntryWithSupplementaryMetric()
Signature
TArray<uint8> FOvrLeaderboardEntry::ExtraData
ID : FOvrId
The ID of this leaderboard entry.
Signature
FOvrId FOvrLeaderboardEntry::ID
Rank : int32
The rank of this leaderboard entry in the leaderboard.
Signature
int32 FOvrLeaderboardEntry::Rank
Score : int64
The raw underlying value of the leaderboard entry score.
Signature
int64 FOvrLeaderboardEntry::Score
SupplementaryMetric : FOvrSupplementaryMetric
A metric that can be used for tiebreakers by Leaderboard_WriteEntryWithSupplementaryMetric().
Signature
FOvrSupplementaryMetric FOvrLeaderboardEntry::SupplementaryMetric
Timestamp : FDateTime
The timestamp of this entry being created in the leaderboard.
Signature
FDateTime FOvrLeaderboardEntry::Timestamp
User : FOvrUser
User of this leaderboard entry.
Signature
FOvrUser FOvrLeaderboardEntry::User

Member Functions

Clear ()
Signature
void FOvrLeaderboardEntry::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Signature
void FOvrLeaderboardEntry::Update(ovrLeaderboardEntryHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
Returns
void