Package com.viaversion.viaversion.api.minecraft.item.data

Record Class PotionEffectData

java.lang.Object
java.lang.Record
com.viaversion.viaversion.api.minecraft.item.data.PotionEffectData
public record PotionEffectData(int amplifier, int duration, boolean ambient, boolean showParticles, boolean showIcon, @Nullable PotionEffectData hiddenEffect) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Type<PotionEffectData>
    OPTIONAL_TYPE
     
    static final Type<PotionEffectData>
    TYPE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    PotionEffectData(int amplifier, int duration, boolean ambient, boolean showParticles, boolean showIcon, @Nullable PotionEffectData hiddenEffect)
    Creates an instance of a PotionEffectData record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    ambient()
    Returns the value of the ambient record component.
    int
    amplifier()
    Returns the value of the amplifier record component.
    int
    duration()
    Returns the value of the duration record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    @Nullable PotionEffectData
    hiddenEffect()
    Returns the value of the hiddenEffect record component.
    boolean
    showIcon()
    Returns the value of the showIcon record component.
    boolean
    showParticles()
    Returns the value of the showParticles 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

  • Field Details

  • Constructor Details

    • PotionEffectData

      public PotionEffectData(int amplifier, int duration, boolean ambient, boolean showParticles, boolean showIcon, @Nullable PotionEffectData hiddenEffect)
      Creates an instance of a PotionEffectData record class.
      Parameters:
      amplifier - the value for the amplifier record component
      duration - the value for the duration record component
      ambient - the value for the ambient record component
      showParticles - the value for the showParticles record component
      showIcon - the value for the showIcon record component
      hiddenEffect - the value for the hiddenEffect record component

  • Method Details

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

    • amplifier

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

    • duration

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

    • ambient

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

    • showParticles

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

    • showIcon

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

    • hiddenEffect

      public @Nullable PotionEffectData hiddenEffect()
      Returns the value of the hiddenEffect record component.
      Returns:
      the value of the hiddenEffect record component