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

@@ -25,6 +25,8 @@
 
 package org.geysermc.geyser.api.item.custom;
 
+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.GeyserApi;
@@ -114,6 +116,88 @@ public interface CustomItemData {
      */
     @NonNull Set<String> tags();
 
+    /**
+     * Gets the stack size of the item.
+     *
+     * <p>Returns 0 if not set. When not set, Geyser defaults to the stack count of the Java item when based on a vanilla item, or 64 when registering a non-vanilla item.</p>
+     *
+     * <p>Note that, to copy Java behaviour, setting the stack size of an item to a value above 1 will set the max damage to 0. If a max damage value above 0 was explicitly set, an exception will be thrown.</p>
+     *
+     * @return the stack size of the item
+     */
+    @NonNegative int stackSize();
+
+    /**
+     * Gets the max damage of the item.
+     *
+     * <p>Returns -1 if not set. When not set, Geyser defaults to the maximum damage of the Java item when based on a vanilla item, or uses 0 when registering a non-vanilla item.</p>
+     *
+     * <p>Note that, to copy Java behaviour, setting the max damage value of an item to a value above 0 will set the stack size to 1. If a stack size above 1 was explicitly set, an exception will be thrown.</p>
+     *
+     * @return the max damage of the item
+     */
+    int maxDamage();
+
+    /**
+     * Gets the attack damage of the item.
+     * This is purely visual, and only applied to tools
+     *
+     * <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
+     */
+    int attackDamage();
+
+    /**
+     * Gets the armor type of the item.
+     *
+     * <p>This can be "boots", "leggings", "chestplate", or "helmet", and makes the item able to be equipped into its respective equipment slot.
+     * This should only be set if the Java item can be placed into the specified equipment slot.</p>
+     *
+     * @return the armor type of the item
+     */
+    @Nullable String armorType();
+
+    /**
+     * Gets the armor protection value of the item.
+     *
+     * <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
+     */
+    int protectionValue();
+
+    /**
+     * Gets if the item is a hat. This is used to determine if the item should be rendered on the player's head, and
+     * normally allow the player to equip it. This is not meant for armor.
+     *
+     * @return if the item is a hat
+     */
+    boolean isHat();
+
+    /**
+     * Gets if the item is a foil. This is used to determine if the item should be rendered with an enchantment glint effect.
+     *
+     * @return if the item is a foil
+     */
+    boolean isFoil();
+
+    /**
+     * Gets if the item is edible.
+     *
+     * @return if the item is edible
+     */
+    boolean isEdible();
+
+    /**
+     * Gets if the food item can always be eaten.
+     *
+     * @return if the item is allowed to be eaten all the time
+     */
+    boolean canAlwaysEat();
+
     static CustomItemData.Builder builder() {
         return GeyserApi.api().provider(CustomItemData.Builder.class);
     }
@@ -144,6 +228,24 @@ interface Builder {
 
         Builder tags(@Nullable Set<String> tags);
 
+        Builder stackSize(@Positive int stackSize);
+
+        Builder maxDamage(@NonNegative int maxDamage);
+
+        Builder attackDamage(@NonNegative int attackDamage);
+
+        Builder armorType(@Nullable String armorType);
+
+        Builder protectionValue(@NonNegative int protectionValue);
+
+        Builder hat(boolean isHat);
+
+        Builder foil(boolean isFoil);
+
+        Builder edible(boolean isEdible);
+
+        Builder canAlwaysEat(boolean canAlwaysEat);
+
         CustomItemData build();
     }
 }

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

@@ -26,6 +26,7 @@
 package org.geysermc.geyser.api.item.custom;
 
 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.GeyserApi;
@@ -43,35 +44,6 @@ public interface NonVanillaCustomItemData extends CustomItemData {
      */
     @NonNull String identifier();
 
-    /**
-     * Gets the java item id of the item.
-     *
-     * @return the java item id of the item
-     */
-    @NonNegative int javaId();
-
-    /**
-     * Gets the stack size of the item.
-     *
-     * @return the stack size of the item
-     */
-    @NonNegative int stackSize();
-
-    /**
-     * Gets the max damage of the item.
-     *
-     * @return the max damage of the item
-     */
-    int maxDamage();
-
-    /**
-     * Gets the attack damage of the item.
-     * This is purely visual, and only applied to tools
-     *
-     * @return the attack damage of the item
-     */
-    int attackDamage();
-
     /**
      * Gets the tool type of the item.
      *
@@ -87,18 +59,11 @@ public interface NonVanillaCustomItemData extends CustomItemData {
     @Nullable String toolTier();
 
     /**
-     * Gets the armor type of the item.
-     *
-     * @return the armor type of the item
-     */
-    @Nullable String armorType();
-
-    /**
-     * Gets the armor protection value of the item.
+     * Gets the java item id of the item.
      *
-     * @return the armor protection value of the item
+     * @return the java item id of the item
      */
-    int protectionValue();
+    @NonNegative int javaId();
 
     /**
      * Gets the item's translation string.
@@ -115,40 +80,18 @@ public interface NonVanillaCustomItemData extends CustomItemData {
     @Nullable Set<String> repairMaterials();
 
     /**
-     * Gets if the item is a hat. This is used to determine if the item should be rendered on the player's head, and
-     * normally allow the player to equip it. This is not meant for armor.
-     *
-     * @return if the item is a hat
-     */
-    boolean isHat();
-
-    /**
-     * Gets if the item is a foil. This is used to determine if the item should be rendered with an enchantment glint effect.
-     *
-     * @return if the item is a foil
-     */
-    boolean isFoil();
-
-    /**
-     * Gets if the item is edible.
-     *
-     * @return if the item is edible
-     */
-    boolean isEdible();
-
-    /**
-     * Gets if the food item can always be eaten.
+     * Gets if the item is chargable, like a bow.
      *
-     * @return if the item is allowed to be eaten all the time
+     * @return if the item should act like a chargable item
      */
-    boolean canAlwaysEat();
+    boolean isChargeable();
 
     /**
-     * Gets if the item is chargable, like a bow.
+     * Gets the block the item places.
      *
-     * @return if the item should act like a chargable item
+     * @return the block the item places
      */
-    boolean isChargeable();
+    String block();
 
     /**
      * @deprecated Use {@link #displayHandheld()} instead.
@@ -161,13 +104,6 @@ default boolean isTool() {
         return displayHandheld();
     }
 
-    /**
-     * Gets the block the item places.
-     *
-     * @return the block the item places
-     */
-    String block();
-
     static NonVanillaCustomItemData.Builder builder() {
         return GeyserApi.api().provider(NonVanillaCustomItemData.Builder.class);
     }
@@ -176,40 +112,63 @@ interface Builder extends CustomItemData.Builder {
         @Override
         Builder name(@NonNull String name);
 
-        Builder identifier(@NonNull String identifier);
+        @Override
+        Builder customItemOptions(@NonNull CustomItemOptions customItemOptions);
 
-        Builder javaId(@NonNegative int javaId);
+        @Override
+        Builder displayName(@NonNull String displayName);
 
-        Builder stackSize(@NonNegative int stackSize);
+        @Override
+        Builder icon(@NonNull String icon);
 
-        Builder maxDamage(int maxDamage);
+        @Override
+        Builder allowOffhand(boolean allowOffhand);
 
-        Builder attackDamage(int attackDamage);
+        @Override
+        Builder displayHandheld(boolean displayHandheld);
 
-        Builder toolType(@Nullable String toolType);
+        @Override
+        Builder creativeCategory(int creativeCategory);
 
-        Builder toolTier(@Nullable String toolTier);
+        @Override
+        Builder creativeGroup(@Nullable String creativeGroup);
 
-        Builder armorType(@Nullable String armorType);
+        @Override
+        Builder textureSize(int textureSize);
 
-        Builder protectionValue(int protectionValue);
+        @Override
+        Builder renderOffsets(@Nullable CustomRenderOffsets renderOffsets);
 
-        Builder translationString(@Nullable String translationString);
+        @Override
+        Builder tags(@Nullable Set<String> tags);
 
-        Builder repairMaterials(@Nullable Set<String> repairMaterials);
+        @Override
+        Builder stackSize(@Positive int stackSize);
+
+        @Override
+        Builder maxDamage(@NonNegative int maxDamage);
+
+        @Override
+        Builder attackDamage(@NonNegative int attackDamage);
+
+        @Override
+        Builder armorType(@Nullable String armorType);
 
+        @Override
+        Builder protectionValue(@NonNegative int protectionValue);
+
+        @Override
         Builder hat(boolean isHat);
 
+        @Override
         Builder foil(boolean isFoil);
 
+        @Override
         Builder edible(boolean isEdible);
 
+        @Override
         Builder canAlwaysEat(boolean canAlwaysEat);
 
-        Builder chargeable(boolean isChargeable);
-
-        Builder block(String block);
-
         /**
          * @deprecated Use {@link #displayHandheld(boolean)} instead.
          */
@@ -218,35 +177,21 @@ default Builder tool(boolean isTool) {
             return displayHandheld(isTool);
         }
 
-        @Override
-        Builder creativeCategory(int creativeCategory);
-
-        @Override
-        Builder creativeGroup(@Nullable String creativeGroup);
-
-        @Override
-        Builder customItemOptions(@NonNull CustomItemOptions customItemOptions);
+        Builder identifier(@NonNull String identifier);
 
-        @Override
-        Builder displayName(@NonNull String displayName);
+        Builder javaId(@NonNegative int javaId);
 
-        @Override
-        Builder icon(@NonNull String icon);
+        Builder toolType(@Nullable String toolType);
 
-        @Override
-        Builder allowOffhand(boolean allowOffhand);
+        Builder toolTier(@Nullable String toolTier);
 
-        @Override
-        Builder displayHandheld(boolean displayHandheld);
+        Builder translationString(@Nullable String translationString);
 
-        @Override
-        Builder textureSize(int textureSize);
+        Builder repairMaterials(@Nullable Set<String> repairMaterials);
 
-        @Override
-        Builder renderOffsets(@Nullable CustomRenderOffsets renderOffsets);
+        Builder chargeable(boolean isChargeable);
 
-        @Override
-        Builder tags(@Nullable Set<String> tags);
+        Builder block(String block);
 
         NonVanillaCustomItemData build();
     }