Package host.anzo.eossdk.eos.sdk.achievements

Class EOS_Achievements_DefinitionV2

java.lang.Object

com.sun.jna.Structure

host.anzo.eossdk.eos.sdk.achievements.EOS_Achievements_DefinitionV2

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

EOS_Achievements_DefinitionV2.ByReference, EOS_Achievements_DefinitionV2.ByValue

@FieldOrder({"ApiVersion","AchievementId","UnlockedDisplayName","UnlockedDescription","LockedDisplayName","LockedDescription","FlavorText","UnlockedIconURL","LockedIconURL","IsHidden","StatThresholdsCount","StatThresholds"})
public class EOS_Achievements_DefinitionV2
extends com.sun.jna.Structure
implements AutoCloseable

Contains information about a single achievement definition with localized text.

Since:

8/19/2023

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EOS_Achievements_DefinitionV2.ByReference
static class	EOS_Achievements_DefinitionV2.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.FieldOrder, com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field	Description
String	AchievementId	Achievement ID that can be used to uniquely identify the achievement.
int	ApiVersion	API Version: Set this to EOS_ACHIEVEMENTS_DEFINITIONV2_API_LATEST.
static final int	EOS_ACHIEVEMENTS_DEFINITIONV2_API_LATEST	The most recent version of the EOS_Achievements_DefinitionV2 struct.
String	FlavorText	Localized flavor text that can be used by the game in an arbitrary manner.
EOS_Bool	IsHidden	EOS_Bool.EOS_TRUE if the achievement is hidden; EOS_Bool.EOS_FALSE otherwise.
String	LockedDescription	Localized description for the achievement when it is locked or hidden.
String	LockedDisplayName	Localized display name for the achievement when it is locked or hidden.
String	LockedIconURL	URL of an icon to display for the achievement when it is locked or hidden.
EOS_Achievements_StatThresholds.ByReference[]	StatThresholds	Array of `EOS_Achievements_StatThresholds` that need to be satisfied to unlock this achievement.
int	StatThresholdsCount	The number of stat thresholds used to monitor progress towards this achievement.
String	UnlockedDescription	Localized description for the achievement when it has been unlocked.
String	UnlockedDisplayName	Localized display name for the achievement when it has been unlocked.
String	UnlockedIconURL	URL of an icon to display for the achievement when it is unlocked.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor	Description
EOS_Achievements_DefinitionV2()
EOS_Achievements_DefinitionV2(com.sun.jna.Pointer peer)

Method Summary

Modifier and Type	Method	Description
void	close()
void	release()	Release the memory associated with EOS_Achievements_DefinitionV2.

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EOS_ACHIEVEMENTS_DEFINITIONV2_API_LATEST

public static final int EOS_ACHIEVEMENTS_DEFINITIONV2_API_LATEST

The most recent version of the EOS_Achievements_DefinitionV2 struct.

See Also:

• Constant Field Values

ApiVersion

public int ApiVersion

API Version: Set this to EOS_ACHIEVEMENTS_DEFINITIONV2_API_LATEST.

AchievementId

public String AchievementId

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

UnlockedDisplayName

public String UnlockedDisplayName

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

UnlockedDescription

public String UnlockedDescription

Localized description for the achievement when it has been unlocked.

LockedDisplayName

public String LockedDisplayName

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

LockedDescription

public String LockedDescription

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

FlavorText

public 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.

UnlockedIconURL

public 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.

LockedIconURL

public 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.

IsHidden

public EOS_Bool IsHidden

EOS_Bool.EOS_TRUE if the achievement is hidden; EOS_Bool.EOS_FALSE otherwise.

StatThresholdsCount

public int StatThresholdsCount

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

StatThresholds

public EOS_Achievements_StatThresholds.ByReference[] StatThresholds

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

Constructor Details

EOS_Achievements_DefinitionV2

public EOS_Achievements_DefinitionV2()

EOS_Achievements_DefinitionV2

public EOS_Achievements_DefinitionV2(com.sun.jna.Pointer peer)

Method Details

release

public void release()

Release the memory associated with EOS_Achievements_DefinitionV2. This must be called on data retrieved from EOS_Achievements_CopyAchievementDefinitionV2ByIndex or EOS_Achievements_CopyAchievementDefinitionV2ByAchievementId.

See Also:

• EOS_Achievements_DefinitionV2
• EOS_Achievements_Interface.copyAchievementDefinitionV2ByIndex(EOS_Achievements_CopyAchievementDefinitionV2ByIndexOptions)
• EOS_Achievements_Interface.copyAchievementDefinitionV2ByAchievementId(EOS_Achievements_CopyAchievementDefinitionV2ByAchievementIdOptions)

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception