Move various settings from NonVanillaCustomItemData to CustomItemData and allow use in JSON mappings

api/src/main/java/org/geysermc/geyser/api/item/custom/CustomItemData.java

@@ -125,8 +125,7 @@ public interface CustomItemData {
      *
      * @return the stack size of the item
      */
-    @NonNegative
-    int stackSize();
+    @NonNegative int stackSize();
 
     /**
      * Gets the max damage of the item.
@@ -143,7 +142,7 @@ public interface CustomItemData {
      * Gets the attack damage of the item.
      * This is purely visual, and only applied to tools
      *
-     * <p>Returns 0 if not set. When 0, Geyser takes the Java item attack damage when based on a vanilla item, or uses 0 when porting a modded item.</p>
+     * <p>Returns -1 if not set. When not set, Geyser takes the Java item attack damage when based on a vanilla item, or uses 0 when porting a modded item.</p>
      *
      * @return the attack damage of the item
      */
@@ -162,7 +161,9 @@ public interface CustomItemData {
     /**
      * Gets the armor protection value of the item.
      *
-     * <p>Only has a function when {@link CustomItemData#armorType} is set.</p>
+     * <p>Only has a function when {@link CustomItemData#armorType} is set, or when the Java item is an armor item (when based on a vanilla item).</p>
+     *
+     * <p>Returns -1 if not set. When not set, Geyser takes the Java item protection value when based on a vanilla item, or uses 0 when porting a modded item.</p>
      *
      * @return the armor protection value of the item
      */
@@ -231,11 +232,11 @@ interface Builder {
 
         Builder maxDamage(@NonNegative int maxDamage);
 
-        Builder attackDamage(int attackDamage);
+        Builder attackDamage(@NonNegative int attackDamage);
 
         Builder armorType(@Nullable String armorType);
 
-        Builder protectionValue(int protectionValue);
+        Builder protectionValue(@NonNegative int protectionValue);
 
         Builder hat(boolean isHat);
 

api/src/main/java/org/geysermc/geyser/api/item/custom/NonVanillaCustomItemData.java

@@ -149,13 +149,13 @@ interface Builder extends CustomItemData.Builder {
         Builder maxDamage(@NonNegative int maxDamage);
 
         @Override
-        Builder attackDamage(int attackDamage);
+        Builder attackDamage(@NonNegative int attackDamage);
 
         @Override
         Builder armorType(@Nullable String armorType);
 
         @Override
-        Builder protectionValue(int protectionValue);
+        Builder protectionValue(@NonNegative int protectionValue);
 
         @Override
         Builder hat(boolean isHat);

core/src/main/java/org/geysermc/geyser/item/GeyserCustomItemData.java

@@ -25,8 +25,11 @@
 
 package org.geysermc.geyser.item;
 
+import java.util.List;
 import lombok.EqualsAndHashCode;
 import lombok.ToString;
+import org.checkerframework.checker.index.qual.NonNegative;
+import org.checkerframework.checker.index.qual.Positive;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.geysermc.geyser.api.item.custom.CustomItemData;
@@ -41,6 +44,8 @@
 @EqualsAndHashCode
 @ToString
 public class GeyserCustomItemData implements CustomItemData {
+    private static final List<String> VALID_ARMOR_TYPES = List.of("boots", "leggings", "chestplate", "helmet");
+
     private final String name;
     private final CustomItemOptions customItemOptions;
     private final String displayName;
@@ -199,9 +204,9 @@ public static class Builder implements CustomItemData.Builder {
         protected Set<String> tags = new HashSet<>();
         private int stackSize = 0;
         private int maxDamage = -1;
-        private int attackDamage = 0;
+        private int attackDamage = -1;
         private String armorType = null;
-        private int protectionValue = 0;
+        private int protectionValue = -1;
         private boolean hat = false;
         private boolean foil = false;
         private boolean edible = false;
@@ -274,7 +279,7 @@ public Builder tags(@Nullable Set<String> tags) {
         }
 
         @Override
-        public Builder stackSize(int stackSize) {
+        public Builder stackSize(@Positive int stackSize) {
             if (stackSize < 1) {
                 throw new IllegalArgumentException("Stack size cannot be below 1 (" + stackSize + " was given)");
             } else if (stackSize > 1) {
@@ -290,7 +295,7 @@ public Builder stackSize(int stackSize) {
         }
 
         @Override
-        public Builder maxDamage(int maxDamage) {
+        public Builder maxDamage(@NonNegative int maxDamage) {
             if (maxDamage < 0) {
                 throw new IllegalArgumentException("Max damage cannot be below 0 (" + maxDamage + " was given)");
             } else if (maxDamage > 0) {
@@ -306,19 +311,28 @@ public Builder maxDamage(int maxDamage) {
         }
 
         @Override
-        public Builder attackDamage(int attackDamage) {
+        public Builder attackDamage(@NonNegative int attackDamage) {
+            if (attackDamage < 0) {
+                throw new IllegalArgumentException("Protection value cannot be below 0 (" + attackDamage + " was given)");
+            }
             this.attackDamage = attackDamage;
             return this;
         }
 
         @Override
         public Builder armorType(@Nullable String armorType) {
+            if (!VALID_ARMOR_TYPES.contains(armorType)) {
+                throw new IllegalArgumentException("Invalid armor type " + armorType + "! Can be \"boots\", \"leggings\", \"chestplate\", or \"helmet\"");
+            }
             this.armorType = armorType;
             return this;
         }
 
         @Override
-        public Builder protectionValue(int protectionValue) {
+        public Builder protectionValue(@NonNegative int protectionValue) {
+            if (protectionValue < 0) {
+                throw new IllegalArgumentException("Protection value cannot be below 0 (" + protectionValue + " was given)");
+            }
             this.protectionValue = protectionValue;
             return this;
         }

core/src/main/java/org/geysermc/geyser/item/GeyserNonVanillaCustomItemData.java

@@ -27,6 +27,8 @@
 
 import lombok.EqualsAndHashCode;
 import lombok.ToString;
+import org.checkerframework.checker.index.qual.NonNegative;
+import org.checkerframework.checker.index.qual.Positive;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.geysermc.geyser.api.item.custom.CustomItemOptions;
@@ -167,17 +169,17 @@ public Builder tags(@Nullable Set<String> tags) {
         }
 
         @Override
-        public Builder stackSize(int stackSize) {
+        public Builder stackSize(@Positive int stackSize) {
             return (Builder) super.stackSize(stackSize);
         }
 
         @Override
-        public Builder maxDamage(int maxDamage) {
+        public Builder maxDamage(@NonNegative int maxDamage) {
             return (Builder) super.maxDamage(maxDamage);
         }
 
         @Override
-        public Builder attackDamage(int attackDamage) {
+        public Builder attackDamage(@NonNegative int attackDamage) {
             return (Builder) super.attackDamage(attackDamage);
         }
 
@@ -187,7 +189,7 @@ public Builder armorType(@Nullable String armorType) {
         }
 
         @Override
-        public Builder protectionValue(int protectionValue) {
+        public Builder protectionValue(@NonNegative int protectionValue) {
             return (Builder) super.protectionValue(protectionValue);
         }
 

core/src/main/java/org/geysermc/geyser/registry/populator/CustomItemRegistryPopulator.java

@@ -182,10 +182,11 @@ private static NbtMapBuilder createComponentNbt(CustomItemData customItemData, I
         int protectionValue = 0;
         if (mapping.getArmorType() != null) {
             armorType = mapping.getArmorType();
-            protectionValue = mapping.getProtectionValue();
+            protectionValue = customItemData.protectionValue() == -1 ? mapping.getProtectionValue() : customItemData.protectionValue();
         } else if (customItemData.armorType() != null) {
             armorType = customItemData.armorType();
-            protectionValue = customItemData.protectionValue();
+            // Using 0 as fallback here because the Java item doesn't have an armor type - so its protection value would be 0
+            protectionValue = customItemData.protectionValue() == -1 ? 0 : customItemData.protectionValue();
         }
 
         if (armorType != null) {
@@ -244,13 +245,13 @@ private static NbtMapBuilder createComponentNbt(NonVanillaCustomItemData customI
 
         boolean canDestroyInCreative = true;
         if (customItemData.toolType() != null) { // This is not using the isTool boolean because it is not just a render type here.
-            canDestroyInCreative = computeToolProperties(Objects.requireNonNull(customItemData.toolType()), itemProperties, componentBuilder, customItemData.attackDamage());
+            canDestroyInCreative = computeToolProperties(Objects.requireNonNull(customItemData.toolType()), itemProperties, componentBuilder, Math.max(0, customItemData.attackDamage()));
         }
         itemProperties.putBoolean("can_destroy_in_creative", canDestroyInCreative);
 
         String armorType = customItemData.armorType();
         if (armorType != null) {
-            computeArmorProperties(armorType, customItemData.protectionValue(), itemProperties, componentBuilder);
+            computeArmorProperties(armorType, Math.max(0, customItemData.protectionValue()), itemProperties, componentBuilder);
         }
 
         if (customItemData.isEdible()) {