javadoc

FabricMC · Sep 1, 2023 · 1ef4a6b · 1ef4a6b
1 parent 54ec62e
commit 1ef4a6b
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/fabric-item-api-v1/src/main/java/net/fabricmc/fabric/api/item/v1/FabricItem.java b/fabric-item-api-v1/src/main/java/net/fabricmc/fabric/api/item/v1/FabricItem.java
@@ -120,6 +120,12 @@ default ItemStack getRecipeRemainder(ItemStack stack) {
         return ((Item) this).hasRecipeRemainder() ? ((Item) this).getRecipeRemainder().getDefaultStack() : ItemStack.EMPTY;
     }
 
+    /**
+     * This is a stack-aware version of {@link Item#getFoodComponent()}.
+     * Note that simple item remainders can also be set via {@link Item.Settings#food(FoodComponent)}.
+     * If you want to get a remainder for a stack, is <b>recommended</b> to use the stack version of this method: {@link FabricItemStack#getFoodComponent()}.
+     * @return this item's {@link FoodComponent}, or {@code null} if none was set.
+     */
     default @Nullable FoodComponent getFoodComponent(ItemStack stack) {
         return ((Item) this).getFoodComponent();
     }

diff --git a/fabric-item-api-v1/src/main/java/net/fabricmc/fabric/api/item/v1/FabricItemStack.java b/fabric-item-api-v1/src/main/java/net/fabricmc/fabric/api/item/v1/FabricItemStack.java
@@ -39,6 +39,11 @@ default ItemStack getRecipeRemainder() {
 		return ((ItemStack) this).getItem().getRecipeRemainder((ItemStack) this);
 	}
 
+	/**
+	 * Stack-aware version of {@link Item#getFoodComponent()}.
+	 * See {@link FabricItem#getFoodComponent(ItemStack)} for a more in depth description.
+	 * @return this itemStack's {@link FoodComponent}, or {@code null} if none was set.
+	 */
 	default @Nullable FoodComponent getFoodComponent() {
 		return ((ItemStack) this).getItem().getFoodComponent(((ItemStack) this));
 	}