Package gg.xp.xivdata.data

Record Class StatusEffectInfo

java.lang.Object
java.lang.Record
gg.xp.xivdata.data.StatusEffectInfo
public record StatusEffectInfo(long statusEffectId, long baseIconId, long maxStacks, String name, String description, boolean canDispel, boolean isPermanent, int partyListPriority, boolean isFcBuff) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    StatusEffectInfo(long statusEffectId, long baseIconId, long maxStacks, String name, String description, boolean canDispel, boolean isPermanent, int partyListPriority, boolean isFcBuff)
    Creates an instance of a StatusEffectInfo record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    baseIconId()
    Returns the value of the baseIconId record component.
    boolean
    canDispel()
    Returns the value of the canDispel record component.
    String
    description()
    Returns the value of the description record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    List<Long>
    getAllIconIds()
     
    List<StatusEffectIcon>
    getAllIcons()
     
    @Nullable StatusEffectIcon
    getIcon(long stacks)
     
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    iconIdForStackCount(long stacks)
     
    boolean
    isFcBuff()
    Returns the value of the isFcBuff record component.
    boolean
    isPermanent()
    Returns the value of the isPermanent record component.
    long
    maxStacks()
    Returns the value of the maxStacks record component.
    String
    name()
    Returns the value of the name record component.
    int
    partyListPriority()
    Returns the value of the partyListPriority record component.
    long
    statusEffectId()
    Returns the value of the statusEffectId record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • StatusEffectInfo

      public StatusEffectInfo(long statusEffectId, long baseIconId, long maxStacks, String name, String description, boolean canDispel, boolean isPermanent, int partyListPriority, boolean isFcBuff)
      Creates an instance of a StatusEffectInfo record class.
      Parameters:
      statusEffectId - the value for the statusEffectId record component
      baseIconId - the value for the baseIconId record component
      maxStacks - the value for the maxStacks record component
      name - the value for the name record component
      description - the value for the description record component
      canDispel - the value for the canDispel record component
      isPermanent - the value for the isPermanent record component
      partyListPriority - the value for the partyListPriority record component
      isFcBuff - the value for the isFcBuff record component

  • Method Details

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • getAllIconIds

      public List<Long> getAllIconIds()

    • iconIdForStackCount

      public long iconIdForStackCount(long stacks)

    • getIcon

      @Nullable public @Nullable StatusEffectIcon getIcon(long stacks)

    • getAllIcons

      public List<StatusEffectIcon> getAllIcons()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • statusEffectId

      public long statusEffectId()
      Returns the value of the statusEffectId record component.
      Returns:
      the value of the statusEffectId record component

    • baseIconId

      public long baseIconId()
      Returns the value of the baseIconId record component.
      Returns:
      the value of the baseIconId record component

    • maxStacks

      public long maxStacks()
      Returns the value of the maxStacks record component.
      Returns:
      the value of the maxStacks record component

    • canDispel

      public boolean canDispel()
      Returns the value of the canDispel record component.
      Returns:
      the value of the canDispel record component

    • isPermanent

      public boolean isPermanent()
      Returns the value of the isPermanent record component.
      Returns:
      the value of the isPermanent record component

    • partyListPriority

      public int partyListPriority()
      Returns the value of the partyListPriority record component.
      Returns:
      the value of the partyListPriority record component

    • isFcBuff

      public boolean isFcBuff()
      Returns the value of the isFcBuff record component.
      Returns:
      the value of the isFcBuff record component