feat: add animated progress arrow for recipe machines in WTHIT/WAILA tooltip

Author: Roelymole

src/main/java/dev/galacticraft/machinelib/api/block/entity/BasicRecipeMachineBlockEntity.java

@@ -36,6 +36,9 @@
 import net.minecraft.world.level.block.state.BlockState;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.ArrayList;
+import java.util.List;
+
 /**
  * A machine block entity that processes recipes.
  *
@@ -45,6 +48,10 @@
 public abstract class BasicRecipeMachineBlockEntity<I extends RecipeInput, R extends Recipe<I>> extends RecipeMachineBlockEntity<I, R> {
     protected final SlottedStorageAccess<Item, ItemResourceSlot> inputSlots;
     protected final SlottedStorageAccess<Item, ItemResourceSlot> outputSlots;
+    protected final int inputSlotsStart;
+    protected final int outputSlotsStart;
+    protected final int inputSlotsLen;
+    protected final int outputSlotsLen;
 
     /**
      * Constructs a new machine block entity that processes recipes.
@@ -90,11 +97,35 @@ protected BasicRecipeMachineBlockEntity(BlockEntityType<? extends BasicRecipeMac
      * @param outputSlotsLen The number of recipe output slots.
      */
     protected BasicRecipeMachineBlockEntity(BlockEntityType<? extends BasicRecipeMachineBlockEntity<I, R>> type,
-                                            BlockPos pos, BlockState state, RecipeType<R> recipeType, StorageSpec spec, int inputSlots, int inputSlotsLen, int outputSlots, int outputSlotsLen) {
+                                            BlockPos pos, BlockState state, RecipeType<R> recipeType, StorageSpec spec,
+                                            int inputSlots, int inputSlotsLen, int outputSlots, int outputSlotsLen) {
         super(type, pos, state, recipeType, spec);
 
         this.inputSlots = this.itemStorage().subStorage(inputSlots, inputSlotsLen);
         this.outputSlots = this.itemStorage().subStorage(outputSlots, outputSlotsLen);
+
+        this.inputSlotsStart = inputSlots;
+        this.inputSlotsLen = inputSlotsLen;
+        this.outputSlotsStart = outputSlots;
+        this.outputSlotsLen = outputSlotsLen;
+    }
+
+    @Override
+    public List<ItemStack> inputItemStacks() {
+        List<ItemStack> items = new ArrayList<>();
+        for (int i = 0; i < this.inputSlotsLen; i++) {
+            items.add(this.itemStorage().getItem(this.inputSlotsStart + i));
+        }
+        return items;
+    }
+
+    @Override
+    public List<ItemStack> outputItemStacks() {
+        List<ItemStack> items = new ArrayList<>();
+        for (int i = 0; i < this.outputSlotsLen; i++) {
+            items.add(this.itemStorage().getItem(this.outputSlotsStart + i));
+        }
+        return items;
     }
 
     @Override

src/main/java/dev/galacticraft/machinelib/api/block/entity/RecipeMachineBlockEntity.java

@@ -31,6 +31,7 @@
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.server.level.ServerLevel;
 import net.minecraft.util.profiling.ProfilerFiller;
+import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.crafting.Recipe;
 import net.minecraft.world.item.crafting.RecipeHolder;
 import net.minecraft.world.item.crafting.RecipeInput;
@@ -43,6 +44,8 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.util.List;
+
 /**
  * A machine block entity that processes recipes.
  *
@@ -99,6 +102,18 @@ protected RecipeMachineBlockEntity(@NotNull BlockEntityType<? extends RecipeMach
         this.recipeType = recipeType;
     }
 
+    /**
+     * {@return A list of the item stacks in the input slots.}
+     */
+    @Contract(pure = true)
+    public abstract List<ItemStack> inputItemStacks();
+
+    /**
+     * {@return A list of the item stacks in the output slots.}
+     */
+    @Contract(pure = true)
+    public abstract List<ItemStack> outputItemStacks();
+
     /**
      * An inventory for use in finding vanilla recipes for this machine.
      *
@@ -313,6 +328,14 @@ protected void setActiveRecipe(@Nullable RecipeHolder<R> recipe) {
         }
     }
 
+    /**
+     * {@return the machine's progress from 0 to 1}
+     */
+    @Contract(pure = true)
+    public float getProgressRatio() {
+        return ((float) this.getProgress()) / ((float) this.getProcessingTime(this.getActiveRecipe()));
+    }
+
     @Override
     protected void saveAdditional(CompoundTag tag, HolderLookup.Provider lookup) {
         super.saveAdditional(tag, lookup);

src/main/java/dev/galacticraft/machinelib/impl/compat/waila/MachineLibWailaPlugin.java

@@ -25,10 +25,12 @@
 import com.mojang.authlib.GameProfile;
 import dev.galacticraft.machinelib.api.block.MachineBlock;
 import dev.galacticraft.machinelib.api.block.entity.MachineBlockEntity;
+import dev.galacticraft.machinelib.api.block.entity.RecipeMachineBlockEntity;
 import dev.galacticraft.machinelib.api.machine.configuration.RedstoneMode;
 import dev.galacticraft.machinelib.api.machine.configuration.SecuritySettings;
 import dev.galacticraft.machinelib.impl.Constant;
 import mcp.mobius.waila.api.*;
+import mcp.mobius.waila.api.data.ProgressData;
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.level.block.entity.SkullBlockEntity;
 
@@ -38,8 +40,18 @@ public class MachineLibWailaPlugin implements IWailaPlugin {
     @Override
     public void register(IRegistrar registrar) {
         registrar.addBlockData((IDataProvider<MachineBlockEntity>) (data, accessor, config) -> {
-            data.raw().put("security", accessor.getTarget().getSecurity().createTag());
-            data.raw().put("redstone", accessor.getTarget().getRedstoneMode().createTag());
+            MachineBlockEntity machine = accessor.getTarget();
+            data.raw().put("security", machine.getSecurity().createTag());
+            data.raw().put("redstone", machine.getRedstoneMode().createTag());
+            if (machine instanceof RecipeMachineBlockEntity recipeMachine) {
+                if (recipeMachine.getActiveRecipe() != null) {
+                    data.add(ProgressData.TYPE, res -> {
+                        res.add(ProgressData.ratio(recipeMachine.getProgressRatio())
+                                .input(recipeMachine.inputItemStacks())
+                                .output(recipeMachine.outputItemStacks()));
+                    });
+                }
+            }
         }, MachineBlock.class);
 
         registrar.addComponent(new IBlockComponentProvider() {