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

Class EOS_Achievements_PlayerAchievement

java.lang.Object
com.sun.jna.Structure
host.anzo.eossdk.eos.sdk.achievements.EOS_Achievements_PlayerAchievement
All Implemented Interfaces:
AutoCloseable
Direct Known Subclasses:
EOS_Achievements_PlayerAchievement.ByReference, EOS_Achievements_PlayerAchievement.ByValue
@FieldOrder({"ApiVersion","AchievementId","Progress","UnlockTime","StatInfoCount","StatInfo","DisplayName","Description","IconURL","FlavorText"}) public class EOS_Achievements_PlayerAchievement extends com.sun.jna.Structure implements AutoCloseable
Contains information about a single player achievement.
Since:
8/19/2023

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    EOS_Achievements_PlayerAchievement.ByReference
     
    static class 
    EOS_Achievements_PlayerAchievement.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
    This achievement's unique identifier.
    int
    ApiVersion
    API Version: Set this to EOS_ACHIEVEMENTS_PLAYERACHIEVEMENT_API_LATEST.
    String
    Description
    Localized description for the achievement based on this specific player's current progress on the achievement.
    The current progress is updated when EOS_Achievements_QueryPlayerAchievements succeeds and when an achievement is unlocked.
    String
    DisplayName
    Localized display name for the achievement based on this specific player's current progress on the achievement.
    The current progress is updated when EOS_Achievements_QueryPlayerAchievements succeeds and when an achievement is unlocked.
    static final int
    EOS_ACHIEVEMENTS_ACHIEVEMENT_UNLOCKTIME_UNDEFINED
    Timestamp value representing an undefined UnlockTime for EOS_Achievements_PlayerAchievement
    static final int
    EOS_ACHIEVEMENTS_PLAYERACHIEVEMENT_API_LATEST
    The most recent version of the EOS_Achievements_PlayerAchievement struct.
    String
    FlavorText
    Localized flavor text that can be used by the game in an arbitrary manner.
    String
    IconURL
    URL of an icon to display for the achievement based on this specific player's current progress on the achievement.
    double
    Progress
    Progress towards completing this achievement (as a percentage).
    EOS_Achievements_PlayerStatInfo.ByReference[]
    StatInfo
    Array of EOS_Achievements_PlayerStatInfo structures containing information about stat thresholds used to unlock the achievement and the player's current values for those stats.
    int
    StatInfoCount
    The number of player stat info entries associated with this achievement.
    long
    UnlockTime
    The POSIX timestamp when the achievement was 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_PlayerAchievement()
     
    EOS_Achievements_PlayerAchievement(com.sun.jna.Pointer peer)
     

  • Method Summary

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

    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_ACHIEVEMENT_UNLOCKTIME_UNDEFINED

      public static final int EOS_ACHIEVEMENTS_ACHIEVEMENT_UNLOCKTIME_UNDEFINED
      Timestamp value representing an undefined UnlockTime for EOS_Achievements_PlayerAchievement
      See Also:

    • EOS_ACHIEVEMENTS_PLAYERACHIEVEMENT_API_LATEST

      public static final int EOS_ACHIEVEMENTS_PLAYERACHIEVEMENT_API_LATEST
      The most recent version of the EOS_Achievements_PlayerAchievement struct.
      See Also:

    • ApiVersion

      public int ApiVersion
      API Version: Set this to EOS_ACHIEVEMENTS_PLAYERACHIEVEMENT_API_LATEST.

    • AchievementId

      public String AchievementId
      This achievement's unique identifier.

    • Progress

      public double Progress
      Progress towards completing this achievement (as a percentage).

    • UnlockTime

      public long UnlockTime
      The POSIX timestamp when the achievement was unlocked. If the achievement has not been unlocked, this value will be EOS_ACHIEVEMENTS_ACHIEVEMENT_UNLOCKTIME_UNDEFINED.

    • StatInfoCount

      public int StatInfoCount
      The number of player stat info entries associated with this achievement.

    • StatInfo

      public EOS_Achievements_PlayerStatInfo.ByReference[] StatInfo
      Array of EOS_Achievements_PlayerStatInfo structures containing information about stat thresholds used to unlock the achievement and the player's current values for those stats.

    • DisplayName

      public String DisplayName
      Localized display name for the achievement based on this specific player's current progress on the achievement.
      The current progress is updated when EOS_Achievements_QueryPlayerAchievements succeeds and when an achievement is unlocked.

    • Description

      public String Description
      Localized description for the achievement based on this specific player's current progress on the achievement.
      The current progress is updated when EOS_Achievements_QueryPlayerAchievements succeeds and when an achievement is unlocked.

    • IconURL

      public String IconURL
      URL of an icon to display for the achievement based on this specific player's current progress on the achievement. This may be null if there is no data configured in the dev portal.
      The current progress is updated when EOS_Achievements_QueryPlayerAchievements succeeds and when an achievement is unlocked.

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

  • Constructor Details

    • EOS_Achievements_PlayerAchievement

      public EOS_Achievements_PlayerAchievement()

    • EOS_Achievements_PlayerAchievement

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

  • Method Details