Record Class GeyserBaseParticle

java.lang.Object
java.lang.Record
dev.wyck.environment.particle.options.GeyserBaseParticle
Record Components:
waterBlocks - The number of water blocks.
burstImpulseBase - The base impulse for the burst effect.
All Implemented Interfaces:
ParticleData
@NullMarked @AsOf("3.0.0") public record GeyserBaseParticle(int waterBlocks, float burstImpulseBase) extends Record implements ParticleData
Particle data for geyser base particles.
Since:
3.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    GeyserBaseParticle(int waterBlocks, float burstImpulseBase)
    Creates an instance of a GeyserBaseParticle 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.
    float
    burstImpulseBase()
    Returns the value of the burstImpulseBase 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 GeyserBaseParticle
    of(int waterBlocks, float burstImpulseBase)
    Creates a new GeyserBaseParticle with the given water blocks and burst impulse base.
    final String
    toString()
    Returns a string representation of this record class.
    int
    waterBlocks()
    Returns the value of the waterBlocks record component.

    Methods inherited from class Object

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

  • Constructor Details

    • GeyserBaseParticle

      public GeyserBaseParticle(int waterBlocks, float burstImpulseBase)
      Creates an instance of a GeyserBaseParticle record class.
      Parameters:
      waterBlocks - the value for the waterBlocks record component
      burstImpulseBase - the value for the burstImpulseBase 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.0.0") public static GeyserBaseParticle of(int waterBlocks, float burstImpulseBase)
      Creates a new GeyserBaseParticle with the given water blocks and burst impulse base.
      Parameters:
      waterBlocks - The number of water blocks.
      burstImpulseBase - The base impulse for the burst effect.
      Returns:
      A new GeyserBaseParticle.

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

    • waterBlocks

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

    • burstImpulseBase

      public float burstImpulseBase()
      Returns the value of the burstImpulseBase record component.
      Returns:
      the value of the burstImpulseBase record component