Interface EnchantmentRegistryEntry.Builder

Method Details

• description

  @Contract(value="_ -> this", mutates="this") @NonNull EnchantmentRegistryEntry.Builder description(@NonNull Component description)

  Configures the description of this enchantment entry as displayed to the client, e.g. "Sharpness" for the sharpness enchantment.

  Parameters:

  description - the description component.

  Returns:

  this builder.

• supportedItems

  @Contract(value="_ -> this", mutates="this") @NonNull EnchantmentRegistryEntry.Builder supportedItems(@NonNull RegistryKeySet<ItemType> supportedItems)

  Configures the set of supported items this enchantment can be applied on. This can be a RegistryKeySet created via RegistrySet.keySet(io.papermc.paper.registry.RegistryKey, Iterable) or a tag obtained via RegistryFreezeEvent.getOrCreateTag(TagKey) with tag keys found in ItemTypeTagKeys such as ItemTypeTagKeys.ENCHANTABLE_ARMOR and ItemTypeTagKeys.ENCHANTABLE_SWORD.

  Parameters:

  supportedItems - the registry key set representing the supported items.

  Returns:

  this builder.

  See Also:

  • RegistrySet.keySet(RegistryKey, TypedKey[])
  • RegistryFreezeEvent.getOrCreateTag(TagKey)

• primaryItems

  @Contract(value="_ -> this", mutates="this") @NonNull EnchantmentRegistryEntry.Builder primaryItems(@Nullable RegistryKeySet<ItemType> primaryItems)

  Configures a set of item types this enchantment can naturally be applied to, when enchanting in an enchantment table.This can be a RegistryKeySet created via RegistrySet.keySet(io.papermc.paper.registry.RegistryKey, Iterable) or a tag obtained via RegistryFreezeEvent.getOrCreateTag(TagKey) with tag keys found in ItemTypeTagKeys such as ItemTypeTagKeys.ENCHANTABLE_ARMOR and ItemTypeTagKeys.ENCHANTABLE_SWORD.

  Defaults to null which means all EnchantmentRegistryEntry.supportedItems() are considered primary items. Additionally, the tag EnchantmentTagKeys.IN_ENCHANTING_TABLE defines which enchantments can even show up in an enchantment table.

  Parameters:

  primaryItems - the registry key set representing the primary items.

  Returns:

  this builder.

  See Also:

  • RegistrySet.keySet(RegistryKey, TypedKey[])
  • RegistryFreezeEvent.getOrCreateTag(TagKey)

• weight

  @Contract(value="_ -> this", mutates="this") @NonNull EnchantmentRegistryEntry.Builder weight(@org.jetbrains.annotations.Range(from=1L, to=1024L) int weight)

  Configures the weight of this enchantment used by the weighted random when selecting enchantments.

  Parameters:

  weight - the weight value.

  Returns:

  this builder.

  See Also:

  • https://minecraft.wiki/w/Enchanting for examplary weights.

• maxLevel

  @Contract(value="_ -> this", mutates="this") @NonNull EnchantmentRegistryEntry.Builder maxLevel(@org.jetbrains.annotations.Range(from=1L, to=255L) int maxLevel)

  Configures the maximum level this enchantment can have when applied.

  Parameters:

  maxLevel - the maximum level.

  Returns:

  this builder.

• minimumCost

  @Contract(value="_ -> this", mutates="this") @NonNull EnchantmentRegistryEntry.Builder minimumCost(@NotNull @NotNull EnchantmentRegistryEntry.EnchantmentCost minimumCost)

  Configures the minimum cost needed to enchant an item with this enchantment.

  Note that a cost is not directly related to the consumed xp.

  Parameters:

  minimumCost - the enchantment cost.

  Returns:

  this builder.

  See Also:

  • https://minecraft.wiki/w/Enchanting/Levels for examplary costs.

• maximumCost

  @Contract(value="_ -> this", mutates="this") @NonNull EnchantmentRegistryEntry.Builder maximumCost(@NotNull @NotNull EnchantmentRegistryEntry.EnchantmentCost maximumCost)

  Configures the maximum cost to enchant an item with this enchantment.

  Note that a cost is not directly related to the consumed xp.

  Parameters:

  maximumCost - the enchantment cost.

  Returns:

  this builder.

  See Also:

  • https://minecraft.wiki/w/Enchanting/Levels for examplary costs.

• anvilCost

  @Contract(value="_ -> this", mutates="this") @NonNull EnchantmentRegistryEntry.Builder anvilCost(@org.jetbrains.annotations.Range(from=0L, to=2147483647L) int anvilCost)

  Configures the cost of applying this enchantment using an anvil.

  Note that this is halved when using an enchantment book, and is multiplied by the level of the enchantment. See https://minecraft.wiki/w/Anvil_mechanics for more information.

  Parameters:

  anvilCost - the anvil cost of this enchantment

  Returns:

  this builder.

  See Also:

  • Enchantment.getAnvilCost()

• activeSlots

  @Contract(value="_ -> this", mutates="this") default @NonNull EnchantmentRegistryEntry.Builder activeSlots(@NonNull EquipmentSlotGroup @NonNull ... activeSlots)

  Configures the list of slot groups this enchantment may be active in.

  If the item enchanted with this enchantment is equipped in a slot not covered by the returned list and its groups, the enchantment's effects, like attribute modifiers, will not activate.

  Parameters:

  activeSlots - a list of equipment slot groups.

  Returns:

  this builder.

  See Also:

  • Enchantment.getActiveSlotGroups()

• activeSlots

  @Contract(value="_ -> this", mutates="this") @NonNull EnchantmentRegistryEntry.Builder activeSlots(@NonNull Iterable<@NonNull EquipmentSlotGroup> activeSlots)

  Configures the list of slot groups this enchantment may be active in.

  If the item enchanted with this enchantment is equipped in a slot not covered by the returned list and its groups, the enchantment's effects, like attribute modifiers, will not activate.

  Parameters:

  activeSlots - a list of equipment slot groups.

  Returns:

  this builder.

  See Also:

  • Enchantment.getActiveSlotGroups()

• exclusiveWith

  @Contract(value="_ -> this", mutates="this") @NonNull EnchantmentRegistryEntry.Builder exclusiveWith(@NonNull RegistryKeySet<Enchantment> exclusiveWith)

  Configures the registry key set of enchantments that this enchantment is exclusive with.

  Exclusive enchantments prohibit the application of this enchantment to an item if they are already present on said item.

  Defaults to an empty set allowing this enchantment to be applied regardless of other enchantments.

  Parameters:

  exclusiveWith - a registry set of enchantments exclusive to this one.

  Returns:

  this builder.

  See Also:

  • RegistrySet.keySet(RegistryKey, TypedKey[])
  • RegistryFreezeEvent.getOrCreateTag(TagKey)