Package net.minestom.server.item.metadata

Class PotionMeta

java.lang.Object
net.minestom.server.item.metadata.PotionMeta
All Implemented Interfaces:
ItemMeta
public class PotionMeta
extends java.lang.Object
implements ItemMeta
Item meta for Material.POTION, Material.LINGERING_POTION, Material.SPLASH_POTION, Material.TIPPED_ARROW.

  • Constructor Summary

    Constructors 
    Constructor Description
    PotionMeta()  

  • Method Summary

    Modifier and Type Method Description
    ItemMeta copy()
    Copies this item meta.
    java.util.List<CustomPotionEffect> getCustomPotionEffects()
    Get a list of CustomPotionEffect.
    PotionType getPotionType()
    Gets the potion type.
    boolean hasNbt()
    Gets if this meta object contains any useful data to send to the client.
    boolean isSimilar​(ItemMeta itemMeta)
    Gets if the two ItemMeta are similar.
    void read​(org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
    Reads nbt data from a compound.
    void setColor​(ChatColor color)
    Changes the color of the potion.
    void setPotionType​(PotionType potionType)
    Changes the potion type.
    void write​(org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
    Writes nbt data to a compound.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • getPotionType

      public PotionType getPotionType()
      Gets the potion type.
      Returns:
      the potion type

    • setPotionType

      public void setPotionType​(PotionType potionType)
      Changes the potion type.
      Parameters:
      potionType - the new potion type

    • getCustomPotionEffects

      public java.util.List<CustomPotionEffect> getCustomPotionEffects()
      Get a list of CustomPotionEffect.
      Returns:
      the custom potion effects

    • setColor

      public void setColor​(ChatColor color)
      Changes the color of the potion.
      Parameters:
      color - the new color of the potion

    • hasNbt

      public boolean hasNbt()
      Description copied from interface: ItemMeta
      Gets if this meta object contains any useful data to send to the client.
      Specified by:
      hasNbt in interface ItemMeta
      Returns:
      true if this item has nbt data, false otherwise

    • isSimilar

      public boolean isSimilar​(@NotNull ItemMeta itemMeta)
      Description copied from interface: ItemMeta
      Gets if the two ItemMeta are similar.

      It is used by ItemStack.isSimilar(ItemStack).

      Specified by:
      isSimilar in interface ItemMeta
      Parameters:
      itemMeta - the second item meta to check
      Returns:
      true if the two meta are similar, false otherwise

    • read

      public void read​(@NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
      Description copied from interface: ItemMeta
      Reads nbt data from a compound.

      WARNING: it is possible that it contains no useful data, it has to be checked before getting anything.

      Specified by:
      read in interface ItemMeta
      Parameters:
      compound - the compound containing the data

    • write

      public void write​(@NotNull org.jglrxavpok.hephaistos.nbt.NBTCompound compound)
      Description copied from interface: ItemMeta
      Writes nbt data to a compound.
      Specified by:
      write in interface ItemMeta
      Parameters:
      compound - the compound receiving the item meta data

    • copy

      @NotNull public ItemMeta copy()
      Description copied from interface: ItemMeta
      Copies this item meta.

      Used by ItemStack.copy().

      Specified by:
      copy in interface ItemMeta
      Returns:
      the cloned item meta