Merge branch 'Blacksmith-an-stuff' into Blacksmith-an-stuff3

Author: The-Code-Monkey

src/client/java/com/tcm/MineTale/MineTaleDataGen.java

@@ -8,10 +8,10 @@
 public class MineTaleDataGen implements DataGeneratorEntrypoint {
 
     /**
-     * Initialize a data pack and register the mod's data providers for data generation.
+     * Initialises the data pack and registers the mod's data providers for data generation.
      *
-     * Registers language, model, recipe, block tag, and loot table providers so they
-     * will run as part of the Fabric data generation pack created from the given generator.
+     * Registers language, model, recipe, block tag, item tag and loot table providers
+     * so they run as part of the Fabric data generation pack created from the provided generator.
      *
      * @param fabricDataGenerator the Fabric data generator used to create the data pack
      */

src/client/java/com/tcm/MineTale/block/workbenches/screen/ArmorersWorkbenchScreen.java

@@ -88,11 +88,12 @@ private static MineTaleRecipeBookComponent createRecipeBookComponent(ArmorersWor
     }
 
     /**
-     * Initialises the screen size and adds the three crafting buttons.
+     * Initialises the screen size and creates three crafting buttons.
      *
-     * Sets the GUI image dimensions, delegates further initialisation to the superclass,
-     * and creates/registers three buttons wired to craft one, ten or all items
-     * (they invoke handleCraftRequest with 1, 10 and -1 respectively; -1 signifies "All").
+     * Sets the GUI image dimensions, performs superclass initialisation, and adds
+     * three buttons that request crafting of 1, 10 or all items. Each button calls
+     * {@code handleCraftRequest} with arguments 1, 10 and -1 respectively; -1
+     * signifies "craft all".
      */
     @Override
     protected void init() {

src/client/java/com/tcm/MineTale/block/workbenches/screen/BlacksmithsWorkbenchScreen.java

@@ -58,12 +58,12 @@ public BlacksmithsWorkbenchScreen(BlacksmithsWorkbenchMenu menu, Inventory inven
     }
 
     /**
-     * Creates a WorkbenchWorkbenchScreen bound to the given menu, player inventory, title, and recipe book component.
+     * Initialise a BlacksmithsWorkbenchScreen bound to the provided menu, player inventory, title and recipe book.
      *
-     * @param menu        the menu backing this screen
-     * @param inventory   the player's inventory shown in the screen
-     * @param title       the screen title component
-     * @param recipeBook  the MineTaleRecipeBookComponent used to display and manage recipes in this screen
+     * @param menu       the workbench menu backing this screen
+     * @param inventory  the player's inventory to display
+     * @param title      the screen title component
+     * @param recipeBook the MineTaleRecipeBookComponent used to display and manage recipes for this screen
      */
     private BlacksmithsWorkbenchScreen(BlacksmithsWorkbenchMenu menu, Inventory inventory, Component title, MineTaleRecipeBookComponent recipeBook) {
         super(menu, recipeBook, inventory, title);
@@ -87,13 +87,12 @@ private static MineTaleRecipeBookComponent createRecipeBookComponent(Blacksmiths
     }
 
     /**
-     * Initialises the workbench screen's GUI size and interactive widgets.
+     * Initialises the screen's GUI size and adds the craft control buttons.
      *
-     * Sets the screen image dimensions, delegates remaining setup to the superclass,
-     * computes default button positions and creates three craft buttons:
-     * - "Craft" (requests 1),
-     * - "x10" (requests 10),
-     * - "All" (requests -1 to indicate all).
+     * Sets the screen image dimensions before delegating to the superclass, computes
+     * default positions relative to the current GUI origin and adds three buttons:
+     * "Craft" requests a single item, "x10" requests ten items and "All" requests
+     * the full possible amount (represented by -1).
      */
     @Override
     protected void init() {
@@ -160,11 +159,17 @@ protected void renderBg(GuiGraphics guiGraphics, float f, int i, int j) {
    }
 
     /**
-     * Render the screen, remember the current recipe selection and update craft-button availability.
+     * Render the screen, preserve the recipe book selection and update craft-button enabled state
+     * according to whether the player has sufficient ingredients for different craft counts.
      *
-     * Remembers the recipe selected in the recipe book, resolves that selection against the client's known recipes when possible,
-     * sets the craft buttons active or inactive according to whether the player has sufficient ingredients for counts of 1, 2 and 10,
-     * renders the background, the superclass UI and any tooltips.
+     * The method draws the screen background and base UI, remembers the currently selected recipe
+     * from the recipe book for later resolution, enables or disables the craft buttons for
+     * counts of 1, 2 and 10 based on ingredient availability, and renders any tooltips.
+     *
+     * @param graphics the graphics context to render with
+     * @param mouseX   the current mouse X coordinate relative to the window
+     * @param mouseY   the current mouse Y coordinate relative to the window
+     * @param delta    the frame delta time (partial tick) for the current render frame
      */
     @Override
     public void render(GuiGraphics graphics, int mouseX, int mouseY, float delta) {
@@ -206,13 +211,13 @@ public void render(GuiGraphics graphics, int mouseX, int mouseY, float delta) {
     }
 
     /**
-     * Determines whether the player has enough ingredients to craft the given recipe the specified number of times.
-     *
-     * @param player     the player whose inventory (and networked nearby items) will be checked; may be null
-     * @param entry      the recipe display entry providing crafting requirements; may be null
-     * @param craftCount the multiplier for required ingredient quantities (e.g., 1, 10, or -1 is not specially handled here)
-     * @return `true` if the player has at least the required quantity of each ingredient multiplied by `craftCount`, `false` otherwise (also returns `false` if `player` or `entry` is null or the recipe has no requirements)
-     */
+         * Determine whether the player has sufficient ingredients to craft the given recipe the specified number of times.
+         *
+         * Returns `false` if `player` or `entry` is null or if the recipe has no crafting requirements.
+         *
+         * @param craftCount the number of times to craft the recipe; ingredient requirements are multiplied by this value
+         * @return `true` if the player has at least the required quantity of each ingredient multiplied by `craftCount`, `false` otherwise
+         */
     private boolean canCraft(Player player, RecipeDisplayEntry entry, int craftCount) {
         if (player == null || entry == null) return false;
 
@@ -253,6 +258,16 @@ private boolean canCraft(Player player, RecipeDisplayEntry entry, int craftCount
         return true;
     }
 
+    /**
+     * Checks whether the player inventory combined with the workbench's networked nearby items
+     * contains at least the specified total quantity of the given ingredient.
+     *
+     * @param inventory     the inventory to search (player inventory)
+     * @param ingredient    the ingredient matcher used to test ItemStacks
+     * @param totalRequired the total number of matching items required
+     * @return              `true` if the combined count from inventory and nearby networked items
+     *                      is greater than or equal to `totalRequired`, `false` otherwise
+     */
     private boolean hasIngredientAmount(Inventory inventory, Ingredient ingredient, int totalRequired) {
         System.out.println("DEBUG: Searching inventory + nearby for " + totalRequired + "...");
         if (totalRequired <= 0) return true;

src/client/java/com/tcm/MineTale/block/workbenches/screen/BuildersWorkbenchScreen.java

@@ -88,12 +88,11 @@ private static MineTaleRecipeBookComponent createRecipeBookComponent(BuildersWor
     }
 
     /**
-         * Configure the screen's GUI dimensions and initialize widgets.
-         *
-         * Sets the layout size (imageWidth = 176, imageHeight = 166), delegates remaining
-         * layout initialization to the superclass, and creates the three craft buttons
-         * ("1", "10", "All") wired to their respective handlers.
-         */
+     * Initialise the screen layout and widgets for the Builders Workbench.
+     *
+     * Sets the GUI dimensions, delegates remaining initialisation to the superclass,
+     * and creates three craft buttons that request crafting of 1, 10 or all available items.
+     */
     @Override
     protected void init() {
         // Important: Set your GUI size before super.init()

src/client/java/com/tcm/MineTale/block/workbenches/screen/FarmersWorkbenchScreen.java

@@ -88,12 +88,12 @@ private static MineTaleRecipeBookComponent createRecipeBookComponent(FarmersWork
     }
 
     /**
-     * Initialises the screen layout and registers the crafting controls.
+     * Initialises the screen size and adds three craft buttons to the GUI.
      *
-     * Sets the GUI dimensions to 176×166 and adds three buttons wired to craft requests:
-     * - "Craft" requests 1,
-     * - "x10" requests 10,
-     * - "All" requests all (represented by -1).
+     * Configures the GUI dimensions to 176×166 and creates three buttons wired to craft requests:
+     * - the first button requests 1 item;
+     * - the second button requests 10 items;
+     * - the third button requests all items (represented by -1).
      */
     @Override
     protected void init() {

src/client/java/com/tcm/MineTale/block/workbenches/screen/FurnitureWorkbenchScreen.java

@@ -48,23 +48,20 @@ public class FurnitureWorkbenchScreen extends AbstractRecipeBookScreen<Furniture
     private Button craftAllBtn;
 
     /**
-     * Initialize a workbench GUI screen using the provided container menu, player inventory, and title.
+     * Initialises the furniture workbench GUI screen with the given container menu, player inventory and title.
      *
-     * @param menu      the menu supplying slots and synchronized state for this screen
+     * @param menu      the menu providing slots and synchronized state for this screen
      * @param inventory the player's inventory to display and interact with
-     * @param title     the title component shown at the top of the screen
+     * @param title     the title component displayed at the top of the screen
      */
     public FurnitureWorkbenchScreen(FurnitureWorkbenchMenu menu, Inventory inventory, Component title) {
         this(menu, inventory, title, createRecipeBookComponent(menu));
     }
 
     /**
-     * Creates a WorkbenchWorkbenchScreen bound to the given menu, player inventory, title, and recipe book component.
+     * Initialise a FurnitureWorkbenchScreen bound to the given menu, player inventory, title and recipe book.
      *
-     * @param menu        the menu backing this screen
-     * @param inventory   the player's inventory shown in the screen
-     * @param title       the screen title component
-     * @param recipeBook  the MineTaleRecipeBookComponent used to display and manage recipes in this screen
+     * @param recipeBook the MineTaleRecipeBookComponent used to display and manage recipes in this screen
      */
     private FurnitureWorkbenchScreen(FurnitureWorkbenchMenu menu, Inventory inventory, Component title, MineTaleRecipeBookComponent recipeBook) {
         super(menu, recipeBook, inventory, title);
@@ -88,13 +85,11 @@ private static MineTaleRecipeBookComponent createRecipeBookComponent(FurnitureWo
     }
 
     /**
-     * Initialises the workbench screen's GUI size and interactive widgets.
+     * Initialises the screen's GUI dimensions and adds the three craft buttons.
      *
-     * Sets the screen image dimensions, delegates remaining setup to the superclass,
-     * computes default button positions and creates three craft buttons:
-     * - "Craft" (requests 1),
-     * - "x10" (requests 10),
-     * - "All" (requests -1 to indicate all).
+     * Sets the screen image width and height, invokes superclass initialisation,
+     * computes default button positions and creates the "Craft" (requests 1),
+     * "x10" (requests 10) and "All" (requests all) buttons.
      */
     @Override
     protected void init() {
@@ -161,11 +156,11 @@ protected void renderBg(GuiGraphics guiGraphics, float f, int i, int j) {
    }
 
     /**
-     * Render the screen, remember the current recipe selection and update craft-button availability.
+     * Render the screen and update craft-button availability based on the current recipe selection.
      *
-     * Remembers the recipe selected in the recipe book, resolves that selection against the client's known recipes when possible,
-     * sets the craft buttons active or inactive according to whether the player has sufficient ingredients for counts of 1, 2 and 10,
-     * renders the background, the superclass UI and any tooltips.
+     * Remembers the recipe selected in the recipe book and resolves it against the client's known recipes;
+     * enables or disables the craft buttons for counts of 1, 2 and 10 according to whether the player has
+     * sufficient ingredients; renders the background, superclass UI and any tooltips.
      */
     @Override
     public void render(GuiGraphics graphics, int mouseX, int mouseY, float delta) {
@@ -207,13 +202,13 @@ public void render(GuiGraphics graphics, int mouseX, int mouseY, float delta) {
     }
 
     /**
-     * Determines whether the player has enough ingredients to craft the given recipe the specified number of times.
-     *
-     * @param player     the player whose inventory (and networked nearby items) will be checked; may be null
-     * @param entry      the recipe display entry providing crafting requirements; may be null
-     * @param craftCount the multiplier for required ingredient quantities (e.g., 1, 10, or -1 is not specially handled here)
-     * @return `true` if the player has at least the required quantity of each ingredient multiplied by `craftCount`, `false` otherwise (also returns `false` if `player` or `entry` is null or the recipe has no requirements)
-     */
+         * Determine whether the player has sufficient ingredients to craft the given recipe the specified number of times.
+         *
+         * @param player     the player whose inventory and any networked nearby items will be checked; may be null
+         * @param entry      the recipe display entry that provides crafting requirements; may be null
+         * @param craftCount the multiplier applied to each ingredient's required quantity
+         * @return `true` if `player` and `entry` are non-null and the player has at least each ingredient's required quantity multiplied by `craftCount`; `false` otherwise (also `false` if the recipe has no requirements)
+         */
     private boolean canCraft(Player player, RecipeDisplayEntry entry, int craftCount) {
         if (player == null || entry == null) return false;
 
@@ -254,6 +249,14 @@ private boolean canCraft(Player player, RecipeDisplayEntry entry, int craftCount
         return true;
     }
 
+    /**
+     * Checks whether the player's inventory and nearby networked items contain at least the specified quantity of an ingredient.
+     *
+     * @param inventory     the player's inventory to search
+     * @param ingredient    the ingredient to match against item stacks
+     * @param totalRequired the total quantity required
+     * @return `true` if the combined quantity found in the inventory and any networked nearby items is greater than or equal to `totalRequired`, `false` otherwise
+     */
     private boolean hasIngredientAmount(Inventory inventory, Ingredient ingredient, int totalRequired) {
         System.out.println("DEBUG: Searching inventory + nearby for " + totalRequired + "...");
         if (totalRequired <= 0) return true;

src/client/java/com/tcm/MineTale/datagen/ModItemTagProvider.java

@@ -12,10 +12,26 @@
 import java.util.concurrent.CompletableFuture;
 
 public class ModItemTagProvider extends FabricTagProvider.ItemTagProvider {
+    /**
+     * Create a ModItemTagProvider used to generate item tag mappings for the mod during data generation.
+     *
+     * @param output           the Fabric data output used to write generated data
+     * @param registriesFuture a future supplying a {@link HolderLookup.Provider} for resolving registries needed while building tags
+     */
     public ModItemTagProvider(FabricDataOutput output, CompletableFuture<HolderLookup.Provider> registriesFuture) {
         super(output, registriesFuture);
     }
 
+    /**
+     * Populate item tag mappings used during data generation.
+     *
+     * Adds entries for the mod's item tags, including:
+     * - `ModTags.Items.WOOD_REPAIR` (adds `Items.STICK`)
+     * - `ModTags.Items.MOSS` (adds the moss block item and various moss variant items resolved from `ModBlocks`)
+     * - `ModTags.Items.MILK_BUCKETS` (adds `Items.MILK_BUCKET`)
+     *
+     * @param provider the registry provider used to resolve item lookups when building tags
+     */
     @Override
     protected void addTags(HolderLookup.Provider provider) {
         valueLookupBuilder(ModTags.Items.WOOD_REPAIR)

src/client/java/com/tcm/MineTale/datagen/ModLangProvider.java

@@ -12,6 +12,15 @@ public ModLangProvider(FabricDataOutput dataOutput, CompletableFuture<HolderLook
         super(dataOutput, registryLookup);
     }
 
+    /**
+     * Provides English translations for MineTale mod content.
+     *
+     * Populates the given TranslationBuilder with translation keys and their English text for blocks,
+     * items and GUI elements used by the mod (e.g. workbenches, ores, natural materials, crops, armour and buttons).
+     *
+     * @param wrapperLookup      registry lookup provider for obtaining registries if needed
+     * @param translationBuilder builder used to register translation key → text pairs
+     */
     @Override
     public void generateTranslations(HolderLookup.Provider wrapperLookup, TranslationBuilder translationBuilder) {
         translationBuilder.add("minetale.creative_tab.title", "MineTale Stuffs");

src/client/java/com/tcm/MineTale/datagen/ModModelProvider.java

@@ -106,10 +106,13 @@ private void registerFurnaceWorkbench(BlockModelGenerators generator, Block bloc
     }
 
     /**
-     * Registers item models for the mod; currently left empty (no item models are generated).
-     *
-     * @param itemModelGenerators generator used to register item models
-     */
+         * Register item models for mod items that require custom or non-default models.
+         *
+         * <p>Registers models for shields, trimmable armour pieces, a handheld mace template,
+         * and various flat handheld item templates used for food and small items.</p>
+         *
+         * @param itemModelGenerators the generator used to create and register item models
+         */
     @Override
     public void generateItemModels(ItemModelGenerators itemModelGenerators) {
         itemModelGenerators.generateShield(ModItems.COPPER_SHIELD);

src/client/java/com/tcm/MineTale/datagen/recipes/AlchemistRecipes.java

@@ -10,6 +10,16 @@
 import net.minecraft.data.recipes.RecipeProvider;
 
 public class AlchemistRecipes {
+    /**
+     * Registers alchemist workbench recipes and writes them to the provided exporter.
+     *
+     * Uses the provider to determine unlock conditions and the lookup to resolve holders required
+     * during recipe generation.
+     *
+     * @param provider the RecipeProvider used to query registered items/blocks for unlock conditions
+     * @param exporter the RecipeOutput target to which generated recipes will be saved
+     * @param lookup   the HolderLookup.Provider used to resolve registry holders during generation
+     */
     public static void buildRecipes(RecipeProvider provider, RecipeOutput exporter, HolderLookup.Provider lookup) {
          new WorkbenchRecipeBuilder(ModRecipes.ALCHEMISTS_TYPE, ModRecipes.ALCHEMISTS_SERIALIZER)
              .input(ModItems.EMPTY_POTION_BOTTLE)