Package net.minestom.server.world.biomes.particle

Record Class DustOption

java.lang.Object
java.lang.Record
net.minestom.server.world.biomes.particle.DustOption
Record Components:
red - can between 0 and 1 and is divided by 255
green - can between 0 and 1 and is divided by 255
blue - can between 0 and 1 and is divided by 255
scale - can between 0.01 to 4
All Implemented Interfaces:
BiomeOption
@Experimental public record DustOption(float red, float green, float blue, float scale) extends Record implements BiomeOption
Particle effect which used based on the color values.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DustOption(float red, float green, float blue, float scale)
    Creates an instance of a DustOption record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    blue()
    Returns the value of the blue record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull Particle
    getType()
     
    float
    green()
    Returns the value of the green record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    float
    red()
    Returns the value of the red record component.
    float
    scale()
    Returns the value of the scale record component.
    @NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound
    toNbt()
     
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DustOption

      public DustOption(float red, float green, float blue, float scale)
      Creates an instance of a DustOption record class.
      Parameters:
      red - the value for the red record component
      green - the value for the green record component
      blue - the value for the blue record component
      scale - the value for the scale record component

  • Method Details

    • toNbt

      @NotNull public @NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound toNbt()
      Specified by:
      toNbt in interface BiomeOption

    • getType

      @NotNull public @NotNull Particle getType()
      Specified by:
      getType in interface BiomeOption

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

    • red

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

    • green

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

    • blue

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

    • scale

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