Class ItemStack

Method Details

• getType

  @NotNull public @NotNull Material getType()

  Gets the type of this item

  Returns:

  Type of the items in this stack

• setType

  @Deprecated public void setType(@NotNull @NotNull Material type)

  Deprecated.

  Setting the material type of ItemStacks is no longer supported.

  This method is deprecated due to potential illegal behavior that may occur during the context of which this ItemStack is being used, allowing for certain item validation to be bypassed. It is recommended to instead create a new ItemStack object with the desired Material type, and if possible, set it in the appropriate context. Using this method in ItemStacks passed in events will result in undefined behavior.

  Sets the type of this item

  Note that in doing so you will reset the MaterialData for this stack.

  IMPORTANT: An ItemStack is only designed to contain items. Do not use this class to encapsulate Materials for which Material.isItem() returns false.

  Parameters:

  type - New type to set the items in this stack to

  See Also:

  • withType(Material)

• withType

  @NotNull @Contract(value="_ -> new", pure=true) public @NotNull ItemStack withType(@NotNull @NotNull Material type)

  Creates a new ItemStack with the specified Material type, where the item count and item meta is preserved.

  Parameters:

  type - The Material type of the new ItemStack.

  Returns:

  A new ItemStack instance with the specified Material type.

• getAmount

  public int getAmount()

  Gets the amount of items in this stack

  Returns:

  Amount of items in this stack

• setAmount

  public void setAmount(int amount)

  Sets the amount of items in this stack

  Parameters:

  amount - New amount of items in this stack

• getData

  @Nullable @Deprecated public @Nullable MaterialData getData()

  Deprecated.

  cast to BlockDataMeta and use BlockDataMeta.getBlockData(Material)

  Gets the MaterialData for this stack of items

  Returns:

  MaterialData for this item

• setData

  @Deprecated public void setData(@Nullable @Nullable MaterialData data)

  Deprecated.

  cast to BlockDataMeta and use BlockDataMeta.setBlockData(org.bukkit.block.data.BlockData)

  Sets the MaterialData for this stack of items

  Parameters:

  data - New MaterialData for this item

• setDurability

  @Deprecated public void setDurability(short durability)

  Deprecated.

  durability is now part of ItemMeta. To avoid confusion and misuse, getItemMeta(), setItemMeta(ItemMeta) and Damageable.setDamage(int) should be used instead. This is because any call to this method will be overwritten by subsequent setting of ItemMeta which was created before this call.

  Sets the durability of this item

  Parameters:

  durability - Durability of this item

• getDurability

  @Deprecated public short getDurability()

  Deprecated.

  see setDurability(short)

  Gets the durability of this item

  Returns:

  Durability of this item

• getMaxStackSize

  public int getMaxStackSize()

  Get the maximum stacksize for the material hold in this ItemStack. (Returns -1 if it has no idea)

  Returns:

  The maximum you can stack this material to.

• toString

  public String toString()

  Overrides:

  toString in class Object

• equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object

• isSimilar

  public boolean isSimilar(@Nullable @Nullable ItemStack stack)

  This method is the same as equals, but does not consider stack size (amount).

  Parameters:

  stack - the item stack to compare to

  Returns:

  true if the two stacks are equal, ignoring the amount

• clone

  @NotNull public @NotNull ItemStack clone()

  Overrides:

  clone in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object

• containsEnchantment

  public boolean containsEnchantment(@NotNull @NotNull Enchantment ench)

  Checks if this ItemStack contains the given Enchantment

  Parameters:

  ench - Enchantment to test

  Returns:

  True if this has the given enchantment

• getEnchantmentLevel

  public int getEnchantmentLevel(@NotNull @NotNull Enchantment ench)

  Gets the level of the specified enchantment on this item stack

  Parameters:

  ench - Enchantment to check

  Returns:

  Level of the enchantment, or 0

• getEnchantments

  @NotNull public @NotNull Map<Enchantment,Integer> getEnchantments()

  Gets a map containing all enchantments and their levels on this item.

  Returns:

  Map of enchantments.

• addEnchantments

  public void addEnchantments(@NotNull @NotNull Map<Enchantment,Integer> enchantments)

  Adds the specified enchantments to this item stack.

  This method is the same as calling addEnchantment(org.bukkit.enchantments.Enchantment, int) for each element of the map.

  Parameters:

  enchantments - Enchantments to add

  Throws:

  IllegalArgumentException - if the specified enchantments is null

  IllegalArgumentException - if any specific enchantment or level is null. Warning: Some enchantments may be added before this exception is thrown.

• addEnchantment

  public void addEnchantment(@NotNull @NotNull Enchantment ench, int level)

  Adds the specified Enchantment to this item stack.

  If this item stack already contained the given enchantment (at any level), it will be replaced.

  Parameters:

  ench - Enchantment to add

  level - Level of the enchantment

  Throws:

  IllegalArgumentException - if enchantment null, or enchantment is not applicable

• addUnsafeEnchantments

  public void addUnsafeEnchantments(@NotNull @NotNull Map<Enchantment,Integer> enchantments)

  Adds the specified enchantments to this item stack in an unsafe manner.

  This method is the same as calling addUnsafeEnchantment(org.bukkit.enchantments.Enchantment, int) for each element of the map.

  Parameters:

  enchantments - Enchantments to add

• addUnsafeEnchantment

  public void addUnsafeEnchantment(@NotNull @NotNull Enchantment ench, int level)

  Adds the specified Enchantment to this item stack.

  If this item stack already contained the given enchantment (at any level), it will be replaced.

  This method is unsafe and will ignore level restrictions or item type. Use at your own discretion.

  Parameters:

  ench - Enchantment to add

  level - Level of the enchantment

• removeEnchantment

  public int removeEnchantment(@NotNull @NotNull Enchantment ench)

  Removes the specified Enchantment if it exists on this ItemStack

  Parameters:

  ench - Enchantment to remove

  Returns:

  Previous level, or 0

• removeEnchantments

  public void removeEnchantments()

  Removes all enchantments on this ItemStack.

• serialize

  @NotNull public @NotNull Map<String,Object> serialize()

  Description copied from interface: ConfigurationSerializable

  Creates a Map representation of this class.

  This class must provide a method to restore this class, as defined in the ConfigurationSerializable interface javadocs.

  Specified by:

  serialize in interface ConfigurationSerializable

  Returns:

  Map containing the current state of this class

• deserialize

  @NotNull public static @NotNull ItemStack deserialize(@NotNull @NotNull Map<String,Object> args)

  Required method for configuration serialization

  Parameters:

  args - map to deserialize

  Returns:

  deserialized item stack

  See Also:

  • ConfigurationSerializable

• editMeta

  public boolean editMeta(@NotNull Consumer<? super ItemMeta> consumer)

  Edits the ItemMeta of this stack.

  The Consumer must only interact with this stack's ItemMeta through the provided ItemMeta instance. Calling this method or any other meta-related method of the ItemStack class (such as getItemMeta(), addItemFlags(ItemFlag...), lore(), etc.) from inside the consumer is disallowed and will produce undefined results or exceptions.

  Parameters:

  consumer - the meta consumer

  Returns:

  true if the edit was successful, false otherwise

• editMeta

  public <M extends ItemMeta> boolean editMeta(@NotNull @NotNull Class<M> metaClass, @NotNull Consumer<@NotNull ? super M> consumer)

  Edits the ItemMeta of this stack if the meta is of the specified type.

  The Consumer must only interact with this stack's ItemMeta through the provided ItemMeta instance. Calling this method or any other meta-related method of the ItemStack class (such as getItemMeta(), addItemFlags(ItemFlag...), lore(), etc.) from inside the consumer is disallowed and will produce undefined results or exceptions.

  Type Parameters:

  M - the meta type

  Parameters:

  metaClass - the type of meta to edit

  consumer - the meta consumer

  Returns:

  true if the edit was successful, false otherwise

• getItemMeta

  @UndefinedNullability public ItemMeta getItemMeta()

  Get a copy of this ItemStack's ItemMeta.

  Returns:

  a copy of the current ItemStack's ItemData

• hasItemMeta

  public boolean hasItemMeta()

  Checks to see if any meta data has been defined.

  Returns:

  Returns true if some meta data has been set for this item

• setItemMeta

  public boolean setItemMeta(@Nullable @Nullable ItemMeta itemMeta)

  Set the ItemMeta of this ItemStack.

  Parameters:

  itemMeta - new ItemMeta, or null to indicate meta data be cleared.

  Returns:

  True if successfully applied ItemMeta, see ItemFactory.isApplicable(ItemMeta, ItemStack)

  Throws:

  IllegalArgumentException - if the item meta was not created by the ItemFactory

• getTranslationKey

  @NotNull @Deprecated(forRemoval=true) public @NotNull String getTranslationKey()

  Deprecated, for removal: This API element is subject to removal in a future version.

  Description copied from interface: Translatable

  Get the translation key, suitable for use in a translation component.

  Specified by:

  getTranslationKey in interface Translatable

  Returns:

  the translation key

• enchantWithLevels

  @NotNull public @NotNull ItemStack enchantWithLevels(@org.jetbrains.annotations.Range(from=1L, to=30L) int levels, boolean allowTreasure, @NotNull Random random)

  Randomly enchants a copy of this ItemStack using the given experience levels.

  If this ItemStack is already enchanted, the existing enchants will be removed before enchanting.

  Levels must be in range [1, 30].

  Parameters:

  levels - levels to use for enchanting

  allowTreasure - whether to allow enchantments where Enchantment.isTreasure() returns true

  random - Random instance to use for enchanting

  Returns:

  enchanted copy of the provided ItemStack

  Throws:

  IllegalArgumentException - on bad arguments

• asHoverEvent

  @NotNull public HoverEvent<HoverEvent.ShowItem> asHoverEvent(@NotNull UnaryOperator<HoverEvent.ShowItem> op)

  Description copied from interface: net.kyori.adventure.text.event.HoverEventSource

  Creates a hover event with value derived from this object.

  The event value will be passed through the provided callback to allow transforming the original value of the event.

  Specified by:

  asHoverEvent in interface HoverEventSource<HoverEvent.ShowItem>

  Parameters:

  op - transformation on value

  Returns:

  a hover event

• displayName

  public @NotNull Component displayName()

  Get the formatted display name of the ItemStack.

  Returns:

  display name of the ItemStack

• ensureServerConversions

  @NotNull public @NotNull ItemStack ensureServerConversions()

  Minecraft updates are converting simple item stacks into more complex NBT oriented Item Stacks. Use this method to ensure any desired data conversions are processed. The input itemstack will not be the same as the returned itemstack.

  Returns:

  A potentially Data Converted ItemStack

• deserializeBytes

  @NotNull public static @NotNull ItemStack deserializeBytes(@NotNull @org.jetbrains.annotations.NotNull byte[] bytes)

  Deserializes this itemstack from raw NBT bytes. NBT is safer for data migrations as it will use the built in data converter instead of bukkits dangerous serialization system. This expects that the DataVersion was stored on the root of the Compound, as saved from the serializeAsBytes() API returned.

  Parameters:

  bytes - bytes representing an item in NBT

  Returns:

  ItemStack migrated to this version of Minecraft if needed.

• serializeAsBytes

  @NotNull public @org.jetbrains.annotations.NotNull byte[] serializeAsBytes()

  Serializes this itemstack to raw bytes in NBT. NBT is safer for data migrations as it will use the built in data converter instead of bukkits dangerous serialization system.

  Returns:

  bytes representing this item in NBT.

• getI18NDisplayName

  @Nullable @Deprecated public @Nullable String getI18NDisplayName()

  Deprecated.

  ItemStack implements Translatable; use that and Component.translatable(net.kyori.adventure.translation.Translatable) instead.

  Gets the Display name as seen in the Client. Currently the server only supports the English language. To override this, You must replace the language file embedded in the server jar.

  Returns:

  Display name of Item

• getMaxItemUseDuration

  public int getMaxItemUseDuration()

• asOne

  @NotNull public @NotNull ItemStack asOne()

  Clones the itemstack and returns it a single quantity.

  Returns:

  The new itemstack with 1 quantity

• asQuantity

  @NotNull public @NotNull ItemStack asQuantity(int qty)

  Clones the itemstack and returns it as the specified quantity

  Parameters:

  qty - The quantity of the cloned item

  Returns:

  The new itemstack with specified quantity

• add

  @NotNull public @NotNull ItemStack add()

  Adds 1 to this itemstack. Will not go over the items max stack size.

  Returns:

  The same item (not a clone)

• add

  @NotNull public @NotNull ItemStack add(int qty)

  Adds quantity to this itemstack. Will not go over the items max stack size.

  Parameters:

  qty - The amount to add

  Returns:

  The same item (not a clone)

• subtract

  @NotNull public @NotNull ItemStack subtract()

  Subtracts 1 to this itemstack. Going to 0 or less will invalidate the item.

  Returns:

  The same item (not a clone)

• subtract

  @NotNull public @NotNull ItemStack subtract(int qty)

  Subtracts quantity to this itemstack. Going to 0 or less will invalidate the item.

  Parameters:

  qty - The amount to add

  Returns:

  The same item (not a clone)

• getLore

  @Deprecated @Nullable public @Nullable List<String> getLore()

  Deprecated.

  in favor of lore()

  If the item has lore, returns it, else it will return null

  Returns:

  The lore, or null

• lore

  @Nullable public @Nullable List<Component> lore()

  If the item has lore, returns it, else it will return null

  Returns:

  The lore, or null

• setLore

  @Deprecated public void setLore(@Nullable @Nullable List<String> lore)

  Deprecated.

  in favour of lore(List)

  Sets the lore for this item. Removes lore when given null.

  Parameters:

  lore - the lore that will be set

• lore

  public void lore(@Nullable @Nullable List<? extends Component> lore)

  Sets the lore for this item. Removes lore when given null.

  Parameters:

  lore - the lore that will be set

• addItemFlags

  public void addItemFlags(@NotNull @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

  public void removeItemFlags(@NotNull @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 public Set<ItemFlag> getItemFlags()

  Get current set itemFlags. The collection returned is unmodifiable.

  Returns:

  A set of all itemFlags set

• hasItemFlag

  public boolean hasItemFlag(@NotNull @NotNull ItemFlag flag)

  Check if the specified flag is present on this item.

  Parameters:

  flag - the flag to check

  Returns:

  if it is present

• translationKey

  @NotNull public @NotNull String translationKey()

  Gets the translation key.

  This is not the same as getting the translation key for the material of this itemstack.

  Specified by:

  translationKey in interface Translatable

  Returns:

  the translation key

• getRarity

  @NotNull public ItemRarity getRarity()

  Gets the item rarity of the itemstack. The rarity can change based on enchantements.

  Returns:

  the itemstack rarity

• isRepairableBy

  public boolean isRepairableBy(@NotNull @NotNull ItemStack repairMaterial)

  Checks if an itemstack can repair this itemstack. Returns false if this or repairMaterial's type is not an item (Material.isItem()).

  Parameters:

  repairMaterial - the repair material

  Returns:

  true if it is repairable by, false if not

• canRepair

  public boolean canRepair(@NotNull @NotNull ItemStack toBeRepaired)

  Checks if this itemstack can repair another. Returns false if this or toBeRepaired's type is not an item (Material.isItem()).

  Parameters:

  toBeRepaired - the itemstack to be repaired

  Returns:

  true if it can repair, false if not

• damage

  @NotNull public @NotNull ItemStack damage(int amount, @NotNull LivingEntity livingEntity)

  Damages this itemstack by the specified amount. This runs all logic associated with damaging an itemstack like events and stat changes.

  Parameters:

  amount - the amount of damage to do

  livingEntity - the entity related to the damage

  Returns:

  the damaged itemstack or an empty one if it broke. May return the same instance of ItemStack

  See Also:

  • to damage itemstacks in equipment slots

• empty

  @NotNull public static @NotNull ItemStack empty()

  Returns an empty item stack, consists of an air material and a stack size of 0. Any item stack with a material of air or a stack size of 0 is seen as being empty by isEmpty().

• isEmpty

  public boolean isEmpty()

  Returns whether this item stack is empty and contains no item. This means it is either air or the stack has a size of 0.

• computeTooltipLines

  @NotNull public @NotNull @Unmodifiable List<Component> computeTooltipLines(@NotNull TooltipContext tooltipContext, @Nullable Player player)

  Computes the tooltip lines for this stack.

  Disclaimer: Tooltip contents are not guaranteed to be consistent across different Minecraft versions.

  Parameters:

  tooltipContext - the tooltip context

  player - a player for player-specific tooltip lines

  Returns:

  an immutable list of components (can be empty)

• getDisplayName

  @NotNull public @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

  public void setDisplayName(@Nullable @Nullable String name)

  Sets the display name.

  Parameters:

  name - the name to set

• hasDisplayName

  public boolean hasDisplayName()

  Checks for existence of a display name.

  Returns:

  true if this has a display name

• getLocalizedName

  @NotNull public @NotNull String getLocalizedName()

  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

  public void setLocalizedName(@Nullable @Nullable String name)

  Sets the localized name.

  Parameters:

  name - the name to set

• hasLocalizedName

  public boolean hasLocalizedName()

  Checks for existence of a localized name.

  Returns:

  true if this has a localized name

• hasLore

  public boolean hasLore()

  Checks for existence of lore.

  Returns:

  true if this has lore

• hasEnchant

  public boolean hasEnchant(@NotNull @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

  public int getEnchantLevel(@NotNull @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 public @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

  public boolean addEnchant(@NotNull @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

  public boolean removeEnchant(@NotNull @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

• hasEnchants

  public boolean hasEnchants()

  Checks for the existence of any enchantments.

  Returns:

  true if an enchantment exists on this meta

• hasConflictingEnchant

  public boolean hasConflictingEnchant(@NotNull @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

• setCustomModelData

  public void setCustomModelData(@Nullable @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

• getCustomModelData

  public 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 localized name that is set

• hasCustomModelData

  public 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

• hasBlockData

  public boolean hasBlockData()

  Returns whether the item has block data currently attached to it.

  Returns:

  whether block data is already attached

• getBlockData

  @NotNull public @NotNull BlockData getBlockData(@NotNull @NotNull Material material)

  Returns the currently attached block data for this item or creates a new one if one doesn't exist. The state is a copy, it must be set back (or to another item) with setBlockData(BlockData)

  Parameters:

  material - the material we wish to get this data in the context of

  Returns:

  the attached data or new data

• setBlockData

  public void setBlockData(@NotNull @NotNull BlockData blockData)

  Attaches a copy of the passed block data to the item.

  Parameters:

  blockData - the block data to attach to the block.

  Throws:

  IllegalArgumentException - if the blockData is null or invalid for this item.

• getRepairCost

  public int getRepairCost()

  Gets the repair penalty

  Returns:

  the repair penalty

• setRepairCost

  public void setRepairCost(int cost)

  Sets the repair penalty

  Parameters:

  cost - repair penalty

• hasRepairCost

  public boolean hasRepairCost()

  Checks to see if this has a repair penalty

  Returns:

  true if this has a repair penalty

• isUnbreakable

  public 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

  public void setUnbreakable(boolean unbreakable)

  Sets the unbreakable tag. An unbreakable item will not lose durability.

  Parameters:

  unbreakable - true if set unbreakable

• hasAttributeModifiers

  public boolean hasAttributeModifiers()

  Checks for the existence of any AttributeModifiers.

  Returns:

  true if any AttributeModifiers exist

• getAttributeModifiers

  @Nullable public @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 public @NotNull Multimap<Attribute,AttributeModifier> getAttributeModifiers(@Nullable @Nullable 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 public @Nullable Collection<AttributeModifier> getAttributeModifiers(@NotNull @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

  public boolean addAttributeModifier(@NotNull @NotNull Attribute attribute, @NotNull @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

  public void setAttributeModifiers(@Nullable @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

  public boolean removeAttributeModifier(@NotNull @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

  public boolean removeAttributeModifier(@Nullable @Nullable 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

  public boolean removeAttributeModifier(@NotNull @NotNull Attribute attribute, @NotNull @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:

  • AttributeModifier.getUniqueId()

• getPersistentDataContainer

  @NotNull public @NotNull PersistentDataContainer getPersistentDataContainer()

  Returns a custom tag container capable of storing tags on the object. Note that the tags stored on this container are all stored under their own custom namespace therefore modifying default tags using this PersistentDataHolder is impossible.

  Returns:

  the persistent metadata container

• hasDamage

  public boolean hasDamage()

  Checks to see if this item has damage

  Returns:

  true if this has damage

• getDamage

  public int getDamage()

  Gets the damage

  Returns:

  the damage

• setDamage

  public void setDamage(int damage)

  Sets the damage

  Parameters:

  damage - item damage

• getDestroyableKeys

  @NotNull public Set<Namespaced> getDestroyableKeys()

  Gets the collection of namespaced keys that the item can destroy in GameMode.ADVENTURE

  Returns:

  Set of Namespaced

• setDestroyableKeys

  public void setDestroyableKeys(@NotNull @NotNull Collection<Namespaced> canDestroy)

  Sets the collection of namespaced keys that the item can destroy in GameMode.ADVENTURE

  Parameters:

  canDestroy - Collection of Namespaced

• getPlaceableKeys

  @NotNull public Set<Namespaced> getPlaceableKeys()

  Gets the collection of namespaced keys that the item can be placed on in GameMode.ADVENTURE

  Returns:

  Set of Namespaced

• setPlaceableKeys

  @NotNull public void setPlaceableKeys(@NotNull @NotNull Collection<Namespaced> canPlaceOn)

  Sets the set of namespaced keys that the item can be placed on in GameMode.ADVENTURE

  Parameters:

  canPlaceOn - Collection of Namespaced

• hasPlaceableKeys

  public boolean hasPlaceableKeys()

  Checks for the existence of any keys that the item can be placed on

  Returns:

  true if this item has placeable keys

• hasDestroyableKeys

  public boolean hasDestroyableKeys()

  Checks for the existence of any keys that the item can destroy

  Returns:

  true if this item has destroyable keys

• repair

  public void repair()

  Repairs this item by 1 durability

• damage

  public boolean damage()

  Damages this item by 1 durability

  Returns:

  True if damage broke the item

• repair

  public void repair(int amount)

  Repairs this item's durability by amount

  Parameters:

  amount - Amount of durability to repair

• damage

  public boolean damage(int amount)

  Damages this item's durability by amount

  Parameters:

  amount - Amount of durability to damage

  Returns:

  True if damage broke the item

• damage

  public boolean damage(int amount, boolean ignoreUnbreaking)

  Damages this item's durability by amount

  Parameters:

  amount - Amount of durability to damage

  ignoreUnbreaking - Ignores unbreaking enchantment

  Returns:

  True if damage broke the item

• isBroke

  public boolean isBroke(int damage)

• getHoverLines

  @NotNull public @NotNull List<@NotNull Component> getHoverLines(boolean advanced)

  Returns the lines of text shown when hovering over the item

  Parameters:

  advanced - Whether advanced tooltips are shown

  Returns:

  the list of Components