Record Class AmbientParticle

java.lang.Object
java.lang.Record
net.minestom.server.world.attribute.AmbientParticle
public record AmbientParticle(Particle particle, float probability) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Codec<AmbientParticle>
    CODEC
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AmbientParticle(Particle particle, float probability)
    Creates an instance of a AmbientParticle record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    Particle
    particle()
    Returns the value of the particle record component.
    float
    probability()
    Returns the value of the probability 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

  • Field Details

  • Constructor Details

    • AmbientParticle

      public AmbientParticle(Particle particle, float probability)
      Creates an instance of a AmbientParticle record class.
      Parameters:
      particle - the value for the particle record component
      probability - the value for the probability record component

  • Method Details

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

    • particle

      public Particle particle()
      Returns the value of the particle record component.
      Returns:
      the value of the particle record component

    • probability

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