Make turtle tools a little more flexible

Turtle tools now accept two additional JSON fields

 - allowEnchantments: Whether items with enchantments (or any
   non-standard NBT) can be equipped.
 - consumesDurability: Whether durability will be consumed. This can be
   "never" (the current and default behaviour), "always", and
   "when_enchanted".

Closes #1501.

projects/common-api/src/main/java/dan200/computercraft/api/turtle/TurtleToolDurability.java

@@ -0,0 +1,48 @@
+// SPDX-FileCopyrightText: 2023 The CC: Tweaked Developers
+//
+// SPDX-License-Identifier: MPL-2.0
+
+package dan200.computercraft.api.turtle;
+
+import net.minecraft.util.StringRepresentable;
+import net.minecraft.world.entity.EquipmentSlot;
+import net.minecraft.world.item.ItemStack;
+
+/**
+ * Indicates if an equipped turtle item will consume durability.
+ *
+ * @see TurtleUpgradeDataProvider.ToolBuilder#consumesDurability(TurtleToolDurability)
+ */
+public enum TurtleToolDurability implements StringRepresentable {
+    /**
+     * The equipped tool always consumes durability when using.
+     */
+    ALWAYS("always"),
+
+    /**
+     * The equipped tool consumes durability if it is {@linkplain ItemStack#isEnchanted() enchanted} or has
+     * {@linkplain ItemStack#getAttributeModifiers(EquipmentSlot) custom attribute modifiers}.
+     */
+    WHEN_ENCHANTED("when_enchanted"),
+
+    /**
+     * The equipped tool never consumes durability. Tools which have been damaged cannot be used as upgrades.
+     */
+    NEVER("never");
+
+    private final String serialisedName;
+
+    /**
+     * The codec which may be used for serialising/deserialising {@link TurtleToolDurability}s.
+     */
+    public static final StringRepresentable.EnumCodec<TurtleToolDurability> CODEC = StringRepresentable.fromEnum(TurtleToolDurability::values);
+
+    TurtleToolDurability(String serialisedName) {
+        this.serialisedName = serialisedName;
+    }
+
+    @Override
+    public String getSerializedName() {
+        return serialisedName;
+    }
+}

projects/common-api/src/main/java/dan200/computercraft/api/turtle/TurtleUpgradeDataProvider.java

@@ -13,8 +13,10 @@ import net.minecraft.data.DataGenerator;
 import net.minecraft.data.PackOutput;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.tags.TagKey;
+import net.minecraft.world.entity.EquipmentSlot;
 import net.minecraft.world.entity.ai.attributes.Attributes;
 import net.minecraft.world.item.Item;
+import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.level.block.Block;
 
 import javax.annotation.Nullable;
@@ -61,6 +63,8 @@ public abstract class TurtleUpgradeDataProvider extends UpgradeDataProvider<ITur
         private @Nullable Item craftingItem;
         private @Nullable Float damageMultiplier = null;
         private @Nullable TagKey<Block> breakable;
+        private boolean allowEnchantments = false;
+        private TurtleToolDurability consumesDurability = TurtleToolDurability.NEVER;
 
         ToolBuilder(ResourceLocation id, TurtleUpgradeSerialiser<?> serialiser, Item toolItem) {
             this.id = id;
@@ -104,6 +108,28 @@ public abstract class TurtleUpgradeDataProvider extends UpgradeDataProvider<ITur
             return this;
         }
 
+        /**
+         * Indicate that this upgrade allows items which have been {@linkplain ItemStack#isEnchanted() enchanted} or have
+         * {@linkplain ItemStack#getAttributeModifiers(EquipmentSlot) custom attribute modifiers}.
+         *
+         * @return The tool builder, for further use.
+         */
+        public ToolBuilder allowEnchantments() {
+            allowEnchantments = true;
+            return this;
+        }
+
+        /**
+         * Set when the tool will consume durability.
+         *
+         * @param durability The durability predicate.
+         * @return The tool builder, for further use.
+         */
+        public ToolBuilder consumesDurability(TurtleToolDurability durability) {
+            consumesDurability = durability;
+            return this;
+        }
+
         /**
          * Provide a list of breakable blocks. If not given, the tool can break all blocks. If given, only blocks
          * in this tag, those in {@link ComputerCraftTags.Blocks#TURTLE_ALWAYS_BREAKABLE} and "insta-mine" ones can
@@ -132,6 +158,10 @@ public abstract class TurtleUpgradeDataProvider extends UpgradeDataProvider<ITur
                 }
                 if (damageMultiplier != null) s.addProperty("damageMultiplier", damageMultiplier);
                 if (breakable != null) s.addProperty("breakable", breakable.location().toString());
+                if (allowEnchantments) s.addProperty("allowEnchantments", true);
+                if (consumesDurability != TurtleToolDurability.NEVER) {
+                    s.addProperty("consumesDurability", consumesDurability.getSerializedName());
+                }
             }));
         }
     }