Record Class AmbientParticle

java.lang.Object
java.lang.Record
fr.fidorial.world.environment.AmbientParticle
Record Components:
type - the minecraft:particle_type key, e.g. minecraft:ash
probability - chance, per random tick of an empty space, that the particle spawns; must be in [0, 1]
public record AmbientParticle(Key type, float probability) extends Record
One entry of the minecraft:visual/ambient_particles environment attribute: a particle randomly spawned around the camera.
Since:
0.1.0

  • Constructor Summary

    Constructors
    Constructor
    Description
    AmbientParticle(Key type, 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.
    static AmbientParticle
    of(Key type, float probability)
    Creates an ambient particle.
    float
    probability()
    Returns the value of the probability record component.
    final String
    toString()
    Returns a string representation of this record class.
    Key
    type()
    Returns the value of the type record component.

    Methods inherited from class Object

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

  • Constructor Details

    • AmbientParticle

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

  • Method Details

    • of

      public static AmbientParticle of(Key type, float probability)
      Creates an ambient particle.
      Parameters:
      type - the particle type key
      probability - spawn probability
      Returns:
      the particle

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

    • type

      public Key type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • probability

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