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

FOvrChallengeEntry Struct

A challenge entry object contains information about an individual entry within a challenge such as the user who made the entry, the score achieved, and other relevant details. It's the array element type of FOvrChallengeEntryArray and can be retrieved using UOvrRequestsBlueprintLibrary::Challenges_GetEntries().

Constructors

FOvrChallengeEntry ()
This is the default constructor for the struct, which initializes the ::ovrChallengeEntryHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrChallengeEntry::FOvrChallengeEntry()
FOvrChallengeEntry ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrChallengeEntry::FOvrChallengeEntry(ovrChallengeEntryHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrChallengeEntryHandle
MessageHandlePtr: TOvrMessageHandlePtr

Fields

DisplayScore : FString
A displayable score for this challenge entry. The score is formatted with thousands separators and the relevant units are appended based on the associated leaderboard's score type.
Signature
FString FOvrChallengeEntry::DisplayScore
ExtraData : TArray< uint8 >
A 2KB custom data field that is associated with the challenge entry.
Signature
TArray<uint8> FOvrChallengeEntry::ExtraData
ID : FOvrId
The unique identifier of this challenge entry which can be used by UOvrRequestsBlueprintLibrary::Challenges_GetEntriesByIds() and UOvrRequestsBlueprintLibrary::Challenges_GetEntries().
Signature
FOvrId FOvrChallengeEntry::ID
Rank : int32
Challenges can be ranked by highest or lowest scores within a time period. This indicates the position of this challenge entry.
Signature
int32 FOvrChallengeEntry::Rank
Score : int64
The raw underlying value of the challenge entry score. It is a type of string that is returned by a long integer.
Signature
int64 FOvrChallengeEntry::Score
Timestamp : FDateTime
The timestamp of the creation of this entry in the challenge.
Signature
FDateTime FOvrChallengeEntry::Timestamp
User : FOvrUser
The user corresponding to this entry within the challenge.
Signature
FOvrUser FOvrChallengeEntry::User

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrChallengeEntry::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrChallengeEntry::Update(ovrChallengeEntryHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrChallengeEntryHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void