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

FOvrLeaderboardUpdateStatus Struct

This object is a response from the server that contains information about the status of the request to update the leaderboard. It can be retrieved using two different API requests: UOvrRequestsBlueprintLibrary::Leaderboard_WriteEntry() and UOvrRequestsBlueprintLibrary::Leaderboard_WriteEntryWithSupplementaryMetric().

Constructors

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

Fields

DidUpdate : bool
A boolean indicates whether the leaderboard was updated.
Signature
bool FOvrLeaderboardUpdateStatus::DidUpdate
UpdatedChallengeIds : TArray< FOvrId >
If the leaderboard is updated, this represents the updated challenge IDs. The updated challenge IDs can be used by UOvrRequestsBlueprintLibrary::Challenges_GetEntries(), UOvrRequestsBlueprintLibrary::Challenges_GetEntriesAfterRank(), or UOvrRequestsBlueprintLibrary::Challenges_GetEntriesByIds() APIs.
Signature
TArray<FOvrId> FOvrLeaderboardUpdateStatus::UpdatedChallengeIds

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrLeaderboardUpdateStatus::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 FOvrLeaderboardUpdateStatus::Update(ovrLeaderboardUpdateStatusHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrLeaderboardUpdateStatusHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void