Record Class SculkChargeParticle

java.lang.Object
java.lang.Record
dev.wyck.wrapper.environment.particle.options.SculkChargeParticle
Record Components:
roll - The roll of the sculk charge.
All Implemented Interfaces:
ParticleData
@NullMarked @AsOf("2.0.0") public record SculkChargeParticle(float roll) extends Record implements ParticleData
Particle data for sculk charge particles.
Since:
2.0.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    SculkChargeParticle(float roll)
    Creates an instance of a SculkChargeParticle 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 SculkChargeParticle
    of(float roll)
     
    float
    roll()
    Returns the value of the roll record component.
    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

    • SculkChargeParticle

      public SculkChargeParticle(float roll)
      Creates an instance of a SculkChargeParticle record class.
      Parameters:
      roll - the value for the roll record component

  • Method Details

    • apply

      @AsOf("2.0.0") 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("2.0.0") public static SculkChargeParticle of(float roll)

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

    • roll

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