Package io.papermc.paper.datacomponent.item

Interface ItemEnchantments

All Superinterfaces:

ShownInTooltip<ItemEnchantments>

@NullMarked
@Experimental
@NonExtendable
public interface ItemEnchantments
extends ShownInTooltip<ItemEnchantments>

Stores a list of enchantments and their levels on an item.

See Also:

• DataComponentTypes.ENCHANTMENTS
• DataComponentTypes.STORED_ENCHANTMENTS

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ItemEnchantments.Builder	Builder for ItemEnchantments.

Method Summary

Modifier and Type	Method	Description
@Unmodifiable Map<Enchantment,@IntRange(from=1L,to=255L) Integer>	enchantments()	Enchantments currently present on this item.
static ItemEnchantments.Builder	itemEnchantments()
static ItemEnchantments	itemEnchantments(Map<Enchantment,@IntRange(from=1L,to=255L) Integer> enchantments, boolean showInTooltip)

Methods inherited from interface io.papermc.paper.datacomponent.item.ShownInTooltip

showInTooltip, showInTooltip

Method Details

itemEnchantments

@Contract(value="_, _ -> new",
          pure=true)
static ItemEnchantments itemEnchantments(Map<Enchantment,@IntRange(from=1L,to=255L) Integer> enchantments,
 boolean showInTooltip)

itemEnchantments

@Contract(value="-> new",
          pure=true)
static ItemEnchantments.Builder itemEnchantments()

enchantments

@Contract(pure=true)
@Unmodifiable Map<Enchantment,@IntRange(from=1L,to=255L) Integer> enchantments()

Enchantments currently present on this item.

Returns:

enchantments