Add enchantWithLevels with tag specification (#11438)

* Add enchantWithLevels with tag specification

* Finalise

---------

Co-authored-by: Bjarne Koll <[email protected]>

3 files changed, 119 insertions, 13 deletions

diff --git a/patches/api/0490-Add-enchantWithLevels-with-enchantment-registry-set.patch b/patches/api/0490-Add-enchantWithLevels-with-enchantment-registry-set.patch
new file mode 100644
index 0000000000..41f106e80f
--- /dev/null
+++ b/patches/api/0490-Add-enchantWithLevels-with-enchantment-registry-set.patch
@@ -0,0 +1,60 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: masmc05 <[email protected]>
+Date: Wed, 25 Sep 2024 16:26:04 +0300
+Subject: [PATCH] Add enchantWithLevels with enchantment registry set
+
+
+diff --git a/src/main/java/org/bukkit/inventory/ItemFactory.java b/src/main/java/org/bukkit/inventory/ItemFactory.java
+index bd0e55562f1cabef3078573182e0cf9fbc844585..2669d783088b9f63f0edd6d0384c3a307ddccac7 100644
+--- a/src/main/java/org/bukkit/inventory/ItemFactory.java
++++ b/src/main/java/org/bukkit/inventory/ItemFactory.java
+@@ -338,4 +338,21 @@ public interface ItemFactory {
+      */
+     @NotNull ItemStack enchantWithLevels(@NotNull ItemStack itemStack, @org.jetbrains.annotations.Range(from = 1, to = 30) int levels, boolean allowTreasure, @NotNull java.util.Random random);
+     // Paper end - enchantWithLevels API
++    // Paper start - enchantWithLevels with tag specification
++    /**
++     * Randomly enchants a copy of the provided {@link ItemStack} using the given experience levels.
++     *
++     * <p>If the provided ItemStack is already enchanted, the existing enchants will be removed before enchanting.</p>
++     *
++     * <p>Levels must be in range {@code [1, 30]}.</p>
++     *
++     * @param itemStack ItemStack to enchant
++     * @param levels levels to use for enchanting
++     * @param keySet registry key set defining the set of possible enchantments, e.g. {@link io.papermc.paper.registry.keys.tags.EnchantmentTagKeys#IN_ENCHANTING_TABLE}.
++     * @param random {@link java.util.Random} instance to use for enchanting
++     * @return enchanted copy of the provided ItemStack
++     * @throws IllegalArgumentException on bad arguments
++     */
++    @NotNull ItemStack enchantWithLevels(@NotNull ItemStack itemStack, @org.jetbrains.annotations.Range(from = 1, to = 30) int levels, @NotNull io.papermc.paper.registry.set.RegistryKeySet<@NotNull Enchantment> keySet, @NotNull java.util.Random random);
++    // Paper end - enchantWithLevels with tag specification
+ }
+diff --git a/src/main/java/org/bukkit/inventory/ItemStack.java b/src/main/java/org/bukkit/inventory/ItemStack.java
+index 7f63a3a37eb06049bd5de10466c6dd96cb5dd4ee..b59222b8c262545d100a9fd28b3bf1d2a4cf4eb0 100644
+--- a/src/main/java/org/bukkit/inventory/ItemStack.java
++++ b/src/main/java/org/bukkit/inventory/ItemStack.java
+@@ -678,6 +678,23 @@ public class ItemStack implements Cloneable, ConfigurationSerializable, Translat
+         return Bukkit.getServer().getItemFactory().enchantWithLevels(this, levels, allowTreasure, random);
+     }
+ 
++    /**
++     * Randomly enchants a copy of this {@link ItemStack} using the given experience levels.
++     *
++     * <p>If the provided ItemStack is already enchanted, the existing enchants will be removed before enchanting.</p>
++     *
++     * <p>Levels must be in range {@code [1, 30]}.</p>
++     *
++     * @param levels levels to use for enchanting
++     * @param keySet registry key set defining the set of possible enchantments, e.g. {@link io.papermc.paper.registry.keys.tags.EnchantmentTagKeys#IN_ENCHANTING_TABLE}.
++     * @param random {@link java.util.Random} instance to use for enchanting
++     * @return enchanted copy of the provided ItemStack
++     * @throws IllegalArgumentException on bad arguments
++     */
++    public @NotNull ItemStack enchantWithLevels(final @org.jetbrains.annotations.Range(from = 1, to = 30) int levels, final @NotNull io.papermc.paper.registry.set.RegistryKeySet<@NotNull Enchantment> keySet, final @NotNull java.util.Random random) {
++        return Bukkit.getItemFactory().enchantWithLevels(this, levels, keySet, random);
++    }
++
+     @NotNull
+     @Override
+     public net.kyori.adventure.text.event.HoverEvent<net.kyori.adventure.text.event.HoverEvent.ShowItem> asHoverEvent(final @NotNull java.util.function.UnaryOperator<net.kyori.adventure.text.event.HoverEvent.ShowItem> op) {
diff --git a/patches/server/0679-Implement-enchantWithLevels-API.patch b/patches/server/0679-Implement-enchantWithLevels-API.patch
index 7bf61f04ba..23f8df7503 100644
--- a/patches/server/0679-Implement-enchantWithLevels-API.patch
+++ b/patches/server/0679-Implement-enchantWithLevels-API.patch
@@ -5,39 +5,52 @@ Subject: [PATCH] Implement enchantWithLevels API
 
 
 diff --git a/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemFactory.java b/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemFactory.java
-index 803a19063c03627dbea79cb1c395ae35aaef2834..317af98f8bd166a5a534f74e6ba177be9afb6a8f 100644
+index 803a19063c03627dbea79cb1c395ae35aaef2834..fef91dbede067f1ab99a9c7d463a2c55cc6cae3a 100644
 --- a/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemFactory.java
 +++ b/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemFactory.java
-@@ -302,4 +302,34 @@ public final class CraftItemFactory implements ItemFactory {
+@@ -302,4 +302,47 @@ public final class CraftItemFactory implements ItemFactory {
          return eggItem == null ? null : new net.minecraft.world.item.ItemStack(eggItem).asBukkitMirror();
      }
      // Paper end - old getSpawnEgg API
 +    // Paper start - enchantWithLevels API
 +    @Override
 +    public ItemStack enchantWithLevels(ItemStack itemStack, int levels, boolean allowTreasure, java.util.Random random) {
++        return enchantWithLevels(
++            itemStack,
++            levels,
++            allowTreasure
++                ? Optional.empty()
++                // While IN_ENCHANTING_TABLE is not logically the same as all but TREASURE, the tag is defined as
++                // NON_TREASURE, which does contain all enchantments not in the treasure tag.
++                // Additionally, the allowTreasure boolean is more intended to configure this method to behave like
++                // an enchanting table.
++                : net.minecraft.server.MinecraftServer.getServer().registryAccess().registryOrThrow(Registries.ENCHANTMENT).getTag(EnchantmentTags.IN_ENCHANTING_TABLE),
++            random
++        );
++    }
++
++    @SuppressWarnings("OptionalUsedAsFieldOrParameterType")
++    private ItemStack enchantWithLevels(
++        ItemStack itemStack,
++        int levels,
++        Optional<? extends net.minecraft.core.HolderSet<net.minecraft.world.item.enchantment.Enchantment>> possibleEnchantments,
++        java.util.Random random
++    ) {
 +        Preconditions.checkArgument(itemStack != null, "Argument 'itemStack' must not be null");
-+        Preconditions.checkArgument(itemStack.getType() != Material.AIR, "Argument 'itemStack' must not be of type AIR");
-+        Preconditions.checkArgument(itemStack.getAmount() > 0, "Argument 'itemStack' amount must be greater than 0");
++        Preconditions.checkArgument(!itemStack.isEmpty(), "Argument 'itemStack' cannot be empty");
 +        Preconditions.checkArgument(levels > 0 && levels <= 30, "Argument 'levels' must be in range [1, 30] (attempted " + levels + ")");
 +        Preconditions.checkArgument(random != null, "Argument 'random' must not be null");
 +        final net.minecraft.world.item.ItemStack internalStack = CraftItemStack.asNMSCopy(itemStack);
 +        if (internalStack.isEnchanted()) {
-+            internalStack.set(net.minecraft.core.component.DataComponents.ENCHANTMENTS, null);
++            internalStack.set(net.minecraft.core.component.DataComponents.ENCHANTMENTS, net.minecraft.world.item.enchantment.ItemEnchantments.EMPTY);
 +        }
 +        final net.minecraft.core.RegistryAccess registryAccess = net.minecraft.server.MinecraftServer.getServer().registryAccess();
-+        final net.minecraft.core.Registry<Enchantment> enchantments = registryAccess.registryOrThrow(Registries.ENCHANTMENT);
 +        final net.minecraft.world.item.ItemStack enchanted = net.minecraft.world.item.enchantment.EnchantmentHelper.enchantItem(
 +            new org.bukkit.craftbukkit.util.RandomSourceWrapper(random),
 +            internalStack,
 +            levels,
 +            registryAccess,
-+            allowTreasure
-+                ? Optional.empty()
-+                // While IN_ENCHANTING_TABLE is not logically the same as all but TREASURE, the tag is defined as
-+                // NON_TREASURE, which does contain all enchantments not in the treasure tag.
-+                // Additionally, the allowTreasure boolean is more intended to configure this method to behave like
-+                // an enchanting table.
-+                : registryAccess.registryOrThrow(Registries.ENCHANTMENT).getTag(EnchantmentTags.IN_ENCHANTING_TABLE)
++            possibleEnchantments
 +        );
 +        return CraftItemStack.asCraftMirror(enchanted);
 +    }
diff --git a/patches/server/1059-Add-enchantWithLevels-with-enchantment-registry-set.patch b/patches/server/1059-Add-enchantWithLevels-with-enchantment-registry-set.patch
new file mode 100644
index 0000000000..bdca715a0d
--- /dev/null
+++ b/patches/server/1059-Add-enchantWithLevels-with-enchantment-registry-set.patch
@@ -0,0 +1,33 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: masmc05 <[email protected]>
+Date: Wed, 25 Sep 2024 16:26:04 +0300
+Subject: [PATCH] Add enchantWithLevels with enchantment registry set
+
+
+diff --git a/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemFactory.java b/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemFactory.java
+index fef91dbede067f1ab99a9c7d463a2c55cc6cae3a..4abd939223a9d5a0c52a64e22c29fe1de85500e9 100644
+--- a/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemFactory.java
++++ b/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemFactory.java
+@@ -319,6 +319,22 @@ public final class CraftItemFactory implements ItemFactory {
+         );
+     }
+ 
++    @Override
++    public ItemStack enchantWithLevels(ItemStack itemStack, int levels, io.papermc.paper.registry.set.RegistryKeySet<org.bukkit.enchantments.Enchantment> keySet, java.util.Random random) {
++        return enchantWithLevels(
++            itemStack,
++            levels,
++            Optional.of(
++                io.papermc.paper.registry.set.PaperRegistrySets.convertToNms(
++                    Registries.ENCHANTMENT,
++                    net.minecraft.server.MinecraftServer.getServer().registryAccess().createSerializationContext(net.minecraft.nbt.NbtOps.INSTANCE).lookupProvider,
++                    keySet
++                )
++            ),
++            random
++        );
++    }
++
+     @SuppressWarnings("OptionalUsedAsFieldOrParameterType")
+     private ItemStack enchantWithLevels(
+         ItemStack itemStack,