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

Record Class ItemOption

java.lang.Object
java.lang.Record
net.minestom.server.world.biomes.particle.ItemOption
Record Components:
item - to bes used
All Implemented Interfaces:
BiomeOption
@Experimental public record ItemOption(@NotNull ItemStack item) extends Record implements BiomeOption
Particle effect which used based on an item inside the biome.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ItemOption(@NotNull ItemStack item)
    Creates an instance of a ItemOption record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    @NotNull Particle
    getType()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    @NotNull ItemStack
    item()
    Returns the value of the item 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

    • ItemOption

      public ItemOption(@NotNull @NotNull ItemStack item)
      Creates an instance of a ItemOption record class.
      Parameters:
      item - the value for the item 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 Objects::equals(Object,Object).
      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.

    • item

      @NotNull public @NotNull ItemStack item()
      Returns the value of the item record component.
      Returns:
      the value of the item record component