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

FOvrAchievementDefinition Struct

An AchievementDefinition defines an achievement; this includes its name and how it is unlocked. For an individual user's progress in unlocking an achievement, see AchievementProgress. It can be retrieved using UOvrRequestsBlueprintLibrary::Achievements_GetAllDefinitions().

Constructors

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

Fields

AchievementType : EOvrAchievementType
This is the type of achievement. There are three types of achievement: EOvrAchievementType::Simple - unlocked by completion of a single event or objective, EOvrAchievementType::Bitfield - unlocked when a number of bits in a bitfield are set, and EOvrAchievementType::Count - unlocked when a counter reaches a defined target.
Signature
EOvrAchievementType FOvrAchievementDefinition::AchievementType
ApiName : FString
A string of the api name of the achievement. It can be used to get the achievement progress by name by the function UOvrRequestsBlueprintLibrary::Achievements_GetProgressByName().
Signature
FString FOvrAchievementDefinition::ApiName
BitfieldLength : int32
It is required for bitfield achievements: EOvrAchievementType::Bitfield. This represents the size of the bitfield for this achievement.
Signature
int32 FOvrAchievementDefinition::BitfieldLength
Target : int64
Signature
int64 FOvrAchievementDefinition::Target

Member Functions

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