Record Class VibrationParticle

java.lang.Object
java.lang.Record
dev.wyck.wrapper.environment.particle.options.VibrationParticle
Record Components:
destination - The destination of the vibration.
arrivalInTicks - The time in ticks until the vibration arrives.
All Implemented Interfaces:
ParticleData
@NullMarked @AsOf("2.0.0") public record VibrationParticle(Vibration.Destination destination, int arrivalInTicks) extends Record implements ParticleData
Particle data for vibration particles.
Since:
2.0.0

  • Constructor Details

    • VibrationParticle

      public VibrationParticle(Vibration.Destination destination, int arrivalInTicks)
      Creates an instance of a VibrationParticle record class.
      Parameters:
      destination - the value for the destination record component
      arrivalInTicks - the value for the arrivalInTicks 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 VibrationParticle of(Vibration.Destination destination, int arrivalInTicks)

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

    • destination

      public Vibration.Destination destination()
      Returns the value of the destination record component.
      Returns:
      the value of the destination record component

    • arrivalInTicks

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