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

FOvrAchievementProgress Struct

The unlock progress of a particular achievement can be retrieved using UOvrRequestsBlueprintLibrary::Achievements_GetAllProgress(). It can be used to display the progress of each achievement in your game. See the following link for more information.

Constructors

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

Fields

Bitfield : FString
If the type of the achievement is EOvrAchievementType::Bitfield it represents the current bitfield state that the achievement has reached.
Signature
FString FOvrAchievementProgress::Bitfield
Count : int64
If the type of the achievement is EOvrAchievementType::Count, it represents the current counter state that the achievement has reached.
Signature
int64 FOvrAchievementProgress::Count
IsUnlocked : bool
If the user has already unlocked this achievement.
Signature
bool FOvrAchievementProgress::IsUnlocked
Name : FString
The unique string that you use to reference the achievement in your app, as specified in the developer dashboard. It can be retrieved using field FOvrAchievementDefinition::ApiName.
Signature
FString FOvrAchievementProgress::Name
UnlockTime : FDateTime
If the achievement is unlocked, the time when it was unlocked.
Signature
FDateTime FOvrAchievementProgress::UnlockTime

Member Functions

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