Record Class GeyserParticle

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    GeyserParticle(int waterBlocks)
    Creates an instance of a GeyserParticle 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.
    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 GeyserParticle
    of(int waterBlocks)
    Creates a new GeyserParticle with the given amount of water blocks.
    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

    • GeyserParticle

      public GeyserParticle(int waterBlocks)
      Creates an instance of a GeyserParticle record class.
      Parameters:
      waterBlocks - the value for the waterBlocks 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 GeyserParticle of(int waterBlocks)
      Creates a new GeyserParticle with the given amount of water blocks.
      Parameters:
      waterBlocks - the amount of water blocks
      Returns:
      a new GeyserParticle
      Since:
      3.0.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.

    • waterBlocks

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