EOS_Achievements_DefinitionV2

EOS API reference page for EOS_Achievements_DefinitionV2

Choose your implementation method:

C

C#

This data structure is part of the Achievements Interface.

Remarks

Contains information about a single achievement definition with localized text.

Properties

EOS_Achievements_DefinitionV2

Property

Value

int32_t ApiVersion

API Version: Set this to EOS_ACHIEVEMENTS_DEFINITIONV2_API_LATEST.

const char* AchievementId

Achievement ID that can be used to uniquely identify the achievement.

const char* UnlockedDisplayName

Localized display name for the achievement when it has been unlocked.

const char* UnlockedDescription

Localized description for the achievement when it has been unlocked.

const char* LockedDisplayName

Localized display name for the achievement when it is locked or hidden.

const char* LockedDescription

Localized description for the achievement when it is locked or hidden.

const char* FlavorText

Localized flavor text that can be used by the game in an arbitrary manner. This may be null if there is no data configured in the dev portal.

const char* UnlockedIconURL

URL of an icon to display for the achievement when it is unlocked. This may be null if there is no data configured in the dev portal.

const char* LockedIconURL

URL of an icon to display for the achievement when it is locked or hidden. This may be null if there is no data configured in the dev portal.

EOS_Bool bIsHidden

EOS_TRUE if the achievement is hidden; EOS_FALSE otherwise.

uint32_t StatThresholdsCount

The number of stat thresholds used to monitor progress towards this achievement.

const EOS_Achievements_StatThresholds* StatThresholds

Array of EOS_Achievements_StatThresholds that need to be satisfied to unlock this achievement. Consists of Name and Threshold Value.

Related API Members

This data structure is part of the Achievements Interface.

Remarks

Contains information about a single achievement definition with localized text.

Properties

Achievements.DefinitionV2

Property

Value

int ApiVersion

API Version: Set this to EOS_ACHIEVEMENTS_DEFINITIONV2_API_LATEST.

string AchievementId

Achievement ID that can be used to uniquely identify the achievement.

string UnlockedDisplayName

Localized display name for the achievement when it has been unlocked.

string UnlockedDescription

Localized description for the achievement when it has been unlocked.

string LockedDisplayName

Localized display name for the achievement when it is locked or hidden.

string LockedDescription

Localized description for the achievement when it is locked or hidden.

string FlavorText

Localized flavor text that can be used by the game in an arbitrary manner. This may be null if there is no data configured in the dev portal.

string UnlockedIconURL

URL of an icon to display for the achievement when it is unlocked. This may be null if there is no data configured in the dev portal.

string LockedIconURL

URL of an icon to display for the achievement when it is locked or hidden. This may be null if there is no data configured in the dev portal.

bool IsHidden

EOS_TRUE if the achievement is hidden; EOS_FALSE otherwise.

StatThresholds[] StatThresholds

Array of EOS_Achievements_StatThresholds that need to be satisfied to unlock this achievement. Consists of Name and Threshold Value.

Related API Members