Package org.bukkit.inventory.meta

Interface ItemMeta

All Superinterfaces:
Cloneable, ConfigurationSerializable, PersistentDataHolder
All Known Subinterfaces:
ArmorMeta, AxolotlBucketMeta, BannerMeta, BlockDataMeta, BlockStateMeta, BookMeta, BundleMeta, ColorableArmorMeta, CompassMeta, CrossbowMeta, Damageable, EnchantmentStorageMeta, FireworkEffectMeta, FireworkMeta, KnowledgeBookMeta, LeatherArmorMeta, MapMeta, MusicInstrumentMeta, OminousBottleMeta, PotionMeta, Repairable, ShieldMeta, SkullMeta, SpawnEggMeta, SuspiciousStewMeta, TropicalFishBucketMeta, WritableBookMeta
public interface ItemMeta extends Cloneable, ConfigurationSerializable, PersistentDataHolder
This type represents the storage mechanism for auxiliary item data.

An implementation will handle the creation and application for ItemMeta. This class should not be implemented by a plugin in a live environment.

  • Method Details

    • hasDisplayName

      boolean hasDisplayName()
      Checks for existence of a display name.
      Returns:
      true if this has a display name

    • getDisplayName

      @NotNull String getDisplayName()
      Gets the display name that is set.

      Plugins should check that hasDisplayName() returns true before calling this method.

      Returns:
      the display name that is set

    • setDisplayName

      void setDisplayName(@Nullable String name)
      Sets the display name.
      Parameters:
      name - the name to set

    • hasItemName

      boolean hasItemName()
      Checks for existence of an item name.
      Item name differs from display name in that it is cannot be edited by an anvil, is not styled with italics, and does not show labels.
      Returns:
      true if this has an item name

    • getItemName

      @NotNull String getItemName()
      Gets the item name that is set.
      Item name differs from display name in that it is cannot be edited by an anvil, is not styled with italics, and does not show labels.

      Plugins should check that hasItemName() returns true before calling this method.

      Returns:
      the item name that is set

    • setItemName

      void setItemName(@Nullable String name)
      Sets the item name.
      Item name differs from display name in that it is cannot be edited by an anvil, is not styled with italics, and does not show labels.
      Parameters:
      name - the name to set

    • hasLocalizedName

      @Deprecated(since="1.20.5", forRemoval=true) boolean hasLocalizedName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      meta no longer exists
      Checks for existence of a localized name.
      Returns:
      true if this has a localized name

    • getLocalizedName

      @NotNull @Deprecated(since="1.20.5", forRemoval=true) String getLocalizedName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      meta no longer exists
      Gets the localized display name that is set.

      Plugins should check that hasLocalizedName() returns true before calling this method.

      Returns:
      the localized name that is set

    • setLocalizedName

      @Deprecated(since="1.20.5", forRemoval=true) void setLocalizedName(@Nullable String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      meta no longer exists
      Sets the localized name.
      Parameters:
      name - the name to set

    • hasLore

      boolean hasLore()
      Checks for existence of lore.
      Returns:
      true if this has lore

    • getLore

      @Nullable List<String> getLore()
      Gets the lore that is set.

      Plugins should check if hasLore() returns true before calling this method.

      Returns:
      a list of lore that is set

    • setLore

      void setLore(@Nullable List<String> lore)
      Sets the lore for this item. Removes lore when given null.
      Parameters:
      lore - the lore that will be set

    • hasCustomModelData

      boolean hasCustomModelData()
      Checks for existence of custom model data.

      CustomModelData is an integer that may be associated client side with a custom item model.

      Returns:
      true if this has custom model data

    • getCustomModelData

      int getCustomModelData()
      Gets the custom model data that is set.

      CustomModelData is an integer that may be associated client side with a custom item model.

      Plugins should check that hasCustomModelData() returns true before calling this method.

      Returns:
      the custom model data that is set

    • getCustomModelDataComponent

      @NotNull CustomModelDataComponent getCustomModelDataComponent()
      Gets the custom model data set on this item, or creates an empty custom model data instance.

      The returned component is a snapshot of its current state and does not reflect a live view of what is on an item. After changing any value on this component, it must be set with setCustomModelDataComponent(CustomModelDataComponent) to apply the changes.

      Returns:
      component

    • setCustomModelData

      void setCustomModelData(@Nullable Integer data)
      Sets the custom model data.

      CustomModelData is an integer that may be associated client side with a custom item model.

      Parameters:
      data - the data to set, or null to clear

    • setCustomModelDataComponent

      void setCustomModelDataComponent(@Nullable CustomModelDataComponent customModelData)
      Sets the custom model data component.
      Parameters:
      customModelData - new component

    • hasEnchantable

      boolean hasEnchantable()
      Gets if the enchantable component is set.
      Returns:
      if an enchantable is set.

    • getEnchantable

      int getEnchantable()
      Gets the enchantable component. Higher values allow higher enchantments.
      Returns:
      max_stack_size

    • setEnchantable

      void setEnchantable(@Nullable Integer enchantable)
      Sets the enchantable. Higher values allow higher enchantments.
      Parameters:
      enchantable - enchantable value

    • hasEnchants

      boolean hasEnchants()
      Checks for the existence of any enchantments.
      Returns:
      true if an enchantment exists on this meta

    • hasEnchant

      boolean hasEnchant(@NotNull Enchantment ench)
      Checks for existence of the specified enchantment.
      Parameters:
      ench - enchantment to check
      Returns:
      true if this enchantment exists for this meta

    • getEnchantLevel

      int getEnchantLevel(@NotNull Enchantment ench)
      Checks for the level of the specified enchantment.
      Parameters:
      ench - enchantment to check
      Returns:
      The level that the specified enchantment has, or 0 if none

    • getEnchants

      @NotNull Map<Enchantment,Integer> getEnchants()
      Returns a copy the enchantments in this ItemMeta.
      Returns an empty map if none.
      Returns:
      An immutable copy of the enchantments

    • addEnchant

      boolean addEnchant(@NotNull Enchantment ench, int level, boolean ignoreLevelRestriction)
      Adds the specified enchantment to this item meta.
      Parameters:
      ench - Enchantment to add
      level - Level for the enchantment
      ignoreLevelRestriction - this indicates the enchantment should be applied, ignoring the level limit
      Returns:
      true if the item meta changed as a result of this call, false otherwise

    • removeEnchant

      boolean removeEnchant(@NotNull Enchantment ench)
      Removes the specified enchantment from this item meta.
      Parameters:
      ench - Enchantment to remove
      Returns:
      true if the item meta changed as a result of this call, false otherwise

    • removeEnchantments

      void removeEnchantments()
      Removes all enchantments from this item meta.

    • hasConflictingEnchant

      boolean hasConflictingEnchant(@NotNull Enchantment ench)
      Checks if the specified enchantment conflicts with any enchantments in this ItemMeta.
      Parameters:
      ench - enchantment to test
      Returns:
      true if the enchantment conflicts, false otherwise

    • addItemFlags

      void addItemFlags(@NotNull ItemFlag... itemFlags)
      Set itemflags which should be ignored when rendering a ItemStack in the Client. This Method does silently ignore double set itemFlags.
      Parameters:
      itemFlags - The hideflags which shouldn't be rendered

    • removeItemFlags

      void removeItemFlags(@NotNull ItemFlag... itemFlags)
      Remove specific set of itemFlags. This tells the Client it should render it again. This Method does silently ignore double removed itemFlags.
      Parameters:
      itemFlags - Hideflags which should be removed

    • getItemFlags

      @NotNull Set<ItemFlag> getItemFlags()
      Get current set itemFlags. The collection returned is unmodifiable.
      Returns:
      A set of all itemFlags set

    • hasItemFlag

      boolean hasItemFlag(@NotNull ItemFlag flag)
      Check if the specified flag is present on this item.
      Parameters:
      flag - the flag to check
      Returns:
      if it is present

    • isHideTooltip

      boolean isHideTooltip()
      Gets if this item has hide_tooltip set. An item with this set will not show any tooltip whatsoever.
      Returns:
      hide_tooltip

    • setHideTooltip

      void setHideTooltip(boolean hideTooltip)
      Sets if this item has hide_tooltip set. An item with this set will not show any tooltip whatsoever.
      Parameters:
      hideTooltip - new hide_tooltip

    • hasTooltipStyle

      boolean hasTooltipStyle()
      Gets if this item has a custom tooltip style.
      Returns:
      if a tooltip_style is set

    • getTooltipStyle

      @Nullable NamespacedKey getTooltipStyle()
      Gets the custom tooltip style.
      Returns:
      the tooltip style

    • setTooltipStyle

      void setTooltipStyle(@Nullable NamespacedKey tooltipStyle)
      Sets the custom tooltip style.
      Parameters:
      tooltipStyle - the new style

    • hasItemModel

      boolean hasItemModel()
      Gets if this item has a custom item model.
      Returns:
      if a item_model is set

    • getItemModel

      @Nullable NamespacedKey getItemModel()
      Gets the custom item model.
      Returns:
      the item model

    • setItemModel

      void setItemModel(@Nullable NamespacedKey itemModel)
      Sets the custom item model.
      Parameters:
      itemModel - the new model

    • isUnbreakable

      boolean isUnbreakable()
      Return if the unbreakable tag is true. An unbreakable item will not lose durability.
      Returns:
      true if the unbreakable tag is true

    • setUnbreakable

      void setUnbreakable(boolean unbreakable)
      Sets the unbreakable tag. An unbreakable item will not lose durability.
      Parameters:
      unbreakable - true if set unbreakable

    • hasEnchantmentGlintOverride

      boolean hasEnchantmentGlintOverride()
      Gets if an enchantment_glint_override is set.
      Returns:
      if an enchantment_glint_override is set

    • getEnchantmentGlintOverride

      @NotNull Boolean getEnchantmentGlintOverride()
      Sets the enchantment_glint_override. If true, the item will glint, even without enchantments; if false, the item will not glint, even with enchantments. Plugins should check hasEnchantmentGlintOverride() before calling this method.
      Returns:
      enchantment_glint_override

    • setEnchantmentGlintOverride

      void setEnchantmentGlintOverride(@Nullable Boolean override)
      Sets the enchantment_glint_override. If true, the item will glint, even without enchantments; if false, the item will not glint, even with enchantments. If null, the override will be cleared.
      Parameters:
      override - new enchantment_glint_override

    • isGlider

      boolean isGlider()
      Checks if this item is a glider. If true, this item will allow players to glide when it is equipped.
      Returns:
      glider

    • setGlider

      void setGlider(boolean glider)
      Sets if this item is a glider. If true, this item will allow players to glide when it is equipped.
      Parameters:
      glider - glider

    • isFireResistant

      @Deprecated(since="1.21.2") boolean isFireResistant()
      Deprecated.
      use getDamageResistant() and DamageTypeTags.IS_FIRE
      Checks if this item is fire_resistant. If true, it will not burn in fire or lava.
      Returns:
      fire_resistant

    • setFireResistant

      @Deprecated(since="1.21.2") void setFireResistant(boolean fireResistant)
      Deprecated.
      use setDamageResistant(org.bukkit.Tag) and DamageTypeTags.IS_FIRE
      Sets if this item is fire_resistant. If true, it will not burn in fire or lava.
      Parameters:
      fireResistant - fire_resistant

    • hasDamageResistant

      boolean hasDamageResistant()
      Gets if this item is resistant to certain types of damage.
      Returns:
      true if a resistance is set

    • getDamageResistant

      @Nullable Tag<DamageType> getDamageResistant()
      Gets the type of damage this item will be resistant to when in entity form. Plugins should check hasDamageResistant() before calling this method.
      Returns:
      damage type

    • setDamageResistant

      void setDamageResistant(@Nullable Tag<DamageType> tag)
      Sets the type of damage this item will be resistant to when in entity form.
      Parameters:
      tag - the tag, or null to clear

    • hasMaxStackSize

      boolean hasMaxStackSize()
      Gets if the max_stack_size is set.
      Returns:
      if a max_stack_size is set.

    • getMaxStackSize

      int getMaxStackSize()
      Gets the max_stack_size. This is the maximum amount which an item will stack.
      Returns:
      max_stack_size

    • setMaxStackSize

      void setMaxStackSize(@Nullable Integer max)
      Sets the max_stack_size. This is the maximum amount which an item will stack.
      Parameters:
      max - max_stack_size, between 1 and 99 (inclusive)

    • hasRarity

      boolean hasRarity()
      Gets if the rarity is set.
      Returns:
      rarity

    • getRarity

      @NotNull ItemRarity getRarity()
      Gets the item rarity. Plugins should check hasRarity() before calling this method.
      Returns:
      rarity

    • setRarity

      void setRarity(@Nullable ItemRarity rarity)
      Sets the item rarity.
      Parameters:
      rarity - new rarity

    • hasUseRemainder

      boolean hasUseRemainder()
      Checks if the use remainder is set.
      Returns:
      if a use remainder item is set

    • getUseRemainder

      @Nullable ItemStack getUseRemainder()
      Gets the item which this item will convert to when used.

      The returned component is a snapshot of its current state and does not reflect a live view of what is on an item. After changing any value on this component, it must be set with setUseRemainder(ItemStack) to apply the changes.

      Returns:
      remainder

    • setUseRemainder

      void setUseRemainder(@Nullable ItemStack remainder)
      Sets the item which this item will convert to when used.
      Parameters:
      remainder - new item

    • hasUseCooldown

      boolean hasUseCooldown()
      Checks if the use cooldown is set.
      Returns:
      if a use cooldown is set

    • getUseCooldown

      @NotNull UseCooldownComponent getUseCooldown()
      Gets the use cooldown set on this item, or creates an empty cooldown instance.

      The returned component is a snapshot of its current state and does not reflect a live view of what is on an item. After changing any value on this component, it must be set with setUseCooldown(UseCooldownComponent) to apply the changes.

      Returns:
      cooldown

    • setUseCooldown

      void setUseCooldown(@Nullable UseCooldownComponent cooldown)
      Sets the item use cooldown.
      Parameters:
      cooldown - new cooldown

    • hasFood

      boolean hasFood()
      Checks if the food is set.
      Returns:
      if a food is set

    • getFood

      @NotNull FoodComponent getFood()
      Gets the food set on this item, or creates an empty food instance.

      The returned component is a snapshot of its current state and does not reflect a live view of what is on an item. After changing any value on this component, it must be set with setFood(FoodComponent) to apply the changes.

      Returns:
      food

    • setFood

      void setFood(@Nullable FoodComponent food)
      Sets the item food.
      Parameters:
      food - new food

    • hasTool

      boolean hasTool()
      Checks if the tool is set.
      Returns:
      if a tool is set

    • getTool

      @NotNull ToolComponent getTool()
      Gets the tool set on this item, or creates an empty tool instance.

      The returned component is a snapshot of its current state and does not reflect a live view of what is on an item. After changing any value on this component, it must be set with setTool(ToolComponent) to apply the changes.

      Returns:
      tool

    • setTool

      void setTool(@Nullable ToolComponent tool)
      Sets the item tool.
      Parameters:
      tool - new tool

    • hasEquippable

      boolean hasEquippable()
      Checks if the equippable is set.
      Returns:
      if a equippable is set

    • getEquippable

      @NotNull EquippableComponent getEquippable()
      Gets the equippable set on this item, or creates an empty equippable instance.

      The returned component is a snapshot of its current state and does not reflect a live view of what is on an item. After changing any value on this component, it must be set with setEquippable(EquippableComponent) to apply the changes.

      Returns:
      equippable

    • setEquippable

      void setEquippable(@Nullable EquippableComponent equippable)
      Sets the equippable tool.
      Parameters:
      equippable - new equippable

    • hasJukeboxPlayable

      boolean hasJukeboxPlayable()
      Checks if the jukebox playable is set.
      Returns:
      if a jukebox playable is set

    • getJukeboxPlayable

      @Nullable JukeboxPlayableComponent getJukeboxPlayable()
      Gets the jukebox playable component set on this item.

      The returned component is a snapshot of its current state and does not reflect a live view of what is on an item. After changing any value on this component, it must be set with setJukeboxPlayable(org.bukkit.inventory.meta.components.JukeboxComponent) to apply the changes.

      Returns:
      component

    • setJukeboxPlayable

      void setJukeboxPlayable(@Nullable JukeboxPlayableComponent jukeboxPlayable)
      Sets the item tool.
      Parameters:
      jukeboxPlayable - new component

    • hasAttributeModifiers

      boolean hasAttributeModifiers()
      Checks for the existence of any AttributeModifiers.
      Returns:
      true if any AttributeModifiers exist

    • getAttributeModifiers

      @Nullable Multimap<Attribute,AttributeModifier> getAttributeModifiers()
      Return an immutable copy of all Attributes and their modifiers in this ItemMeta.
      Returns null if none exist.
      Returns:
      an immutable Multimap of Attributes and their AttributeModifiers, or null if none exist

    • getAttributeModifiers

      @NotNull Multimap<Attribute,AttributeModifier> getAttributeModifiers(@NotNull EquipmentSlot slot)
      Return an immutable copy of all Attributes and their AttributeModifiers for a given EquipmentSlot.
      Any AttributeModifier that does have have a given EquipmentSlot will be returned. This is because AttributeModifiers without a slot are active in any slot.
      If there are no attributes set for the given slot, an empty map will be returned.
      Parameters:
      slot - the EquipmentSlot to check
      Returns:
      the immutable Multimap with the respective Attributes and modifiers, or an empty map if no attributes are set.

    • getAttributeModifiers

      @Nullable Collection<AttributeModifier> getAttributeModifiers(@NotNull Attribute attribute)
      Return an immutable copy of all AttributeModifiers for a given Attribute
      Parameters:
      attribute - the Attribute
      Returns:
      an immutable collection of AttributeModifiers or null if no AttributeModifiers exist for the Attribute.
      Throws:
      NullPointerException - if Attribute is null

    • addAttributeModifier

      boolean addAttributeModifier(@NotNull Attribute attribute, @NotNull AttributeModifier modifier)
      Add an Attribute and it's Modifier. AttributeModifiers can now support EquipmentSlots. If not set, the AttributeModifier will be active in ALL slots.
      Two AttributeModifiers that have the same UUID cannot exist on the same Attribute.
      Parameters:
      attribute - the Attribute to modify
      modifier - the AttributeModifier specifying the modification
      Returns:
      true if the Attribute and AttributeModifier were successfully added
      Throws:
      NullPointerException - if Attribute is null
      NullPointerException - if AttributeModifier is null
      IllegalArgumentException - if AttributeModifier already exists

    • setAttributeModifiers

      void setAttributeModifiers(@Nullable Multimap<Attribute,AttributeModifier> attributeModifiers)
      Set all Attributes and their AttributeModifiers. To clear all currently set Attributes and AttributeModifiers use null or an empty Multimap. If not null nor empty, this will filter all entries that are not-null and add them to the ItemStack.
      Parameters:
      attributeModifiers - the new Multimap containing the Attributes and their AttributeModifiers

    • removeAttributeModifier

      boolean removeAttributeModifier(@NotNull Attribute attribute)
      Remove all AttributeModifiers associated with the given Attribute. This will return false if nothing was removed.
      Parameters:
      attribute - attribute to remove
      Returns:
      true if all modifiers were removed from a given Attribute. Returns false if no attributes were removed.
      Throws:
      NullPointerException - if Attribute is null

    • removeAttributeModifier

      boolean removeAttributeModifier(@NotNull EquipmentSlot slot)
      Remove all Attributes and AttributeModifiers for a given EquipmentSlot.
      If the given EquipmentSlot is null, this will remove all AttributeModifiers that do not have an EquipmentSlot set.
      Parameters:
      slot - the EquipmentSlot to clear all Attributes and their modifiers for
      Returns:
      true if all modifiers were removed that match the given EquipmentSlot.

    • removeAttributeModifier

      boolean removeAttributeModifier(@NotNull Attribute attribute, @NotNull AttributeModifier modifier)
      Remove a specific Attribute and AttributeModifier. AttributeModifiers are matched according to their UUID.
      Parameters:
      attribute - the Attribute to remove
      modifier - the AttributeModifier to remove
      Returns:
      if any attribute modifiers were remove
      Throws:
      NullPointerException - if the Attribute is null
      NullPointerException - if the AttributeModifier is null
      See Also:

    • getAsString

      @NotNull String getAsString()
      Get this ItemMeta as an NBT string. If this ItemMeta does not have any NBT, then "{}" will be returned.

      This string should NEVER be relied upon as a serializable value. If serialization is desired, the ConfigurationSerializable API should be used instead.

      Returns:
      the NBT string

    • getAsComponentString

      @NotNull String getAsComponentString()
      Get this ItemMeta as a component-compliant string. If this ItemMeta does not contain any components, then "[]" will be returned.

      The result of this method should yield a string representing the components altered by this ItemMeta instance. When passed to ItemFactory.createItemStack(String) with a prepended item type, it will create an ItemStack that has an ItemMeta matching this ItemMeta instance exactly. Note that this method returns ONLY the components and cannot be passed to createItemStack() alone. An example may look something like this: 

       ItemStack itemStack = // ... an item stack obtained from somewhere
 ItemMeta itemMeta = itemStack.getItemMeta();

 String components = itemMeta.getAsComponentString(); // example: "[minecraft:damage=53]"
 String itemTypeKey = itemStack.getType().getKey().toString(); // example: "minecraft:diamond_sword"
 String itemAsString = itemTypeKey + components; // results in: "minecraft:diamond_sword[minecraft:damage=53]"

 ItemStack recreatedItemStack = Bukkit.getItemFactory().createItemStack(itemAsString);
 assert itemStack.isSimilar(recreatedItemStack); // Should be true*

      *Components not represented or explicitly overridden by this ItemMeta instance will not be included in the resulting string and therefore may result in ItemStacks that do not match exactly. For example, if setDisplayName(String) is not set, then the custom name component will not be included. Or if this ItemMeta is a PotionMeta, it will not include any components related to lodestone compasses, banners, or books, etc., only components modifiable by a PotionMeta instance.

      This string should NEVER be relied upon as a serializable value. If serialization is desired, the ConfigurationSerializable API should be used instead.

      Returns:
      the component-compliant string

    • getCustomTagContainer

      @NotNull @Deprecated(since="1.14") CustomItemTagContainer getCustomTagContainer()
      Deprecated.
      this API part has been replaced by the PersistentDataHolder API. Please use PersistentDataHolder.getPersistentDataContainer() instead of this.
      Returns a public custom tag container capable of storing tags on the item. Those tags will be sent to the client with all of their content, so the client is capable of reading them. This will result in the player seeing a NBT Tag notification on the item. These tags can also be modified by the client once in creative mode
      Returns:
      the custom tag container

    • setVersion

      @Internal void setVersion(int version)
      Internal use only! Do not use under any circumstances!
      Parameters:
      version - version
      API Note:
      internal use only

    • clone

      @NotNull ItemMeta clone()