Record Class ShriekParticle

java.lang.Object
java.lang.Record
dev.wyck.environment.particle.options.ShriekParticle
Record Components:
delay - the delay in ticks before the shriek particle is emitted
All Implemented Interfaces:
ParticleData
@NullMarked @AsOf("3.3.0") public record ShriekParticle(int delay) extends Record implements ParticleData
Particle data for a ParticleTypes.SHRIEK.
Since:
3.3.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    ShriekParticle(int delay)
    Creates an instance of a ShriekParticle record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    ParticleOptions
    apply(ParticleType particleType)
    Applies the particle data to the given particle type and returns the corresponding ParticleOptions.
    int
    delay()
    Returns the value of the delay 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.
    static ShriekParticle
    of(int delay)
    Creates a new ShriekParticle instance with the specified delay.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • ShriekParticle

      public ShriekParticle(int delay)
      Creates an instance of a ShriekParticle record class.
      Parameters:
      delay - the value for the delay record component

  • Method Details

    • apply

      public ParticleOptions apply(ParticleType particleType)
      Description copied from interface: ParticleData
      Applies the particle data to the given particle type and returns the corresponding ParticleOptions.
      Specified by:
      apply in interface ParticleData
      Parameters:
      particleType - The particle type to which the data will be applied.
      Returns:
      The ParticleOptions representing the applied particle data.

    • of

      @AsOf("3.3.0") public static ShriekParticle of(int delay)
      Creates a new ShriekParticle instance with the specified delay.
      Parameters:
      delay - the delay in ticks before the shriek particle is emitted
      Returns:
      a new ShriekParticle instance
      Since:
      3.3.0

    • 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. All components in this record class are compared with the compare method from their corresponding wrapper classes.
      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.

    • delay

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