feat: recipe input helpers

simplify menu creation and initial synchronization

Author: marcus8448

src/main/java/dev/galacticraft/machinelib/api/block/BaseBlock.java

@@ -23,10 +23,16 @@
 package dev.galacticraft.machinelib.api.block;
 
 import dev.galacticraft.machinelib.api.block.entity.BaseBlockEntity;
+import dev.galacticraft.machinelib.api.menu.SynchronizedMenu;
 import dev.galacticraft.machinelib.impl.block.entity.BaseBlockEntityTicker;
+import net.fabricmc.fabric.api.screenhandler.v1.ExtendedScreenHandlerFactory;
 import net.minecraft.core.BlockPos;
+import net.minecraft.network.chat.Component;
+import net.minecraft.server.level.ServerPlayer;
 import net.minecraft.world.InteractionResult;
+import net.minecraft.world.entity.player.Inventory;
 import net.minecraft.world.entity.player.Player;
+import net.minecraft.world.inventory.AbstractContainerMenu;
 import net.minecraft.world.level.Level;
 import net.minecraft.world.level.block.BaseEntityBlock;
 import net.minecraft.world.level.block.RenderShape;
@@ -65,8 +71,34 @@ public BaseBlock(Properties settings) {
         if (!level.isClientSide) {
             BlockEntity entity = level.getBlockEntity(pos);
             if (entity instanceof BaseBlockEntity be) {
-                player.openMenu(be);
-                return InteractionResult.CONSUME;
+                player.openMenu(new ExtendedScreenHandlerFactory<>() {
+                    @Nullable
+                    @Override
+                    public AbstractContainerMenu createMenu(int syncId, Inventory inventory, Player player) {
+                        assert player.getInventory() == inventory;
+
+                        SynchronizedMenu<?> menu = be.createMenu(syncId, inventory, player);
+                        if (menu != null) {
+                            menu.registerData(menu.getData());
+                        }
+                        return menu;
+                    }
+
+                    @Override
+                    public @NotNull Component getDisplayName() {
+                        return be.getDisplayName();
+                    }
+
+                    @Override
+                    public Object getScreenOpeningData(ServerPlayer player) {
+                        return be.getScreenOpeningData(player);
+                    }
+
+                    @Override
+                    public boolean shouldCloseCurrentScreen() {
+                        return be.shouldCloseCurrentScreen();
+                    }
+                });
             }
         }
 

src/main/java/dev/galacticraft/machinelib/api/block/MachineBlock.java

@@ -229,8 +229,7 @@ public void appendHoverText(ItemStack stack, TooltipContext context, List<Compon
 
                 security.tryUpdate(player);
                 if (security.hasAccess(player)) {
-                    player.openMenu(machine);
-                    return InteractionResult.CONSUME;
+                    return super.useWithoutItem(state, level, pos, player, hit);
                 }
             }
         }

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

@@ -22,15 +22,12 @@
 
 package dev.galacticraft.machinelib.api.block.entity;
 
-import dev.galacticraft.machinelib.api.menu.MachineMenu;
 import dev.galacticraft.machinelib.api.menu.SynchronizedMenu;
-import io.netty.buffer.Unpooled;
 import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
 import net.fabricmc.fabric.api.screenhandler.v1.ExtendedScreenHandlerFactory;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.HolderLookup;
 import net.minecraft.nbt.CompoundTag;
-import net.minecraft.network.RegistryFriendlyByteBuf;
 import net.minecraft.network.chat.Component;
 import net.minecraft.network.protocol.Packet;
 import net.minecraft.network.protocol.common.ClientboundCustomPayloadPacket;
@@ -41,7 +38,6 @@
 import net.minecraft.util.profiling.ProfilerFiller;
 import net.minecraft.world.entity.player.Inventory;
 import net.minecraft.world.entity.player.Player;
-import net.minecraft.world.inventory.AbstractContainerMenu;
 import net.minecraft.world.level.ChunkPos;
 import net.minecraft.world.level.block.entity.BlockEntity;
 import net.minecraft.world.level.block.entity.BlockEntityType;
@@ -54,7 +50,7 @@
  *
  * @see SynchronizedMenu
  */
-public abstract class BaseBlockEntity extends BlockEntity implements ExtendedScreenHandlerFactory<RegistryFriendlyByteBuf> {
+public abstract class BaseBlockEntity extends BlockEntity implements ExtendedScreenHandlerFactory<BlockPos> {
     /**
      * Constructs a new base block entity.
      *
@@ -82,23 +78,9 @@ protected BaseBlockEntity(BlockEntityType<? extends BaseBlockEntity> type, Block
      */
     public abstract @Nullable CustomPacketPayload createUpdatePayload();
 
-    /**
-     * {@return a newly created menu}
-     *
-     * @param syncId
-     * @param inventory
-     * @param player
-     * @return
-     */
-    @Nullable
-    public abstract SynchronizedMenu<? extends BaseBlockEntity> openMenu(int syncId, Inventory inventory, Player player);
-
     @Override
-    public RegistryFriendlyByteBuf getScreenOpeningData(ServerPlayer player) {
-        RegistryFriendlyByteBuf buf = new RegistryFriendlyByteBuf(Unpooled.buffer(), player.server.registryAccess());
-        buf.writeBlockPos(this.getBlockPos());
-        ((MachineMenu<?>) player.containerMenu).getData().synchronizeInitial(buf);
-        return buf;
+    public BlockPos getScreenOpeningData(ServerPlayer player) {
+        return this.getBlockPos();
     }
 
     // we override the update packet to circumvent nbt serialization
@@ -116,15 +98,16 @@ public RegistryFriendlyByteBuf getScreenOpeningData(ServerPlayer player) {
         return payload == null ? null : (Packet) new ClientboundCustomPayloadPacket(payload);
     }
 
+    /**
+     * {@return a newly created menu}
+     *
+     * @param syncId the synchronization id of the menu
+     * @param inventory the player's inventory
+     * @param player the player opening the menu
+     */
     @Nullable
     @Override
-    public final AbstractContainerMenu createMenu(int syncId, Inventory inventory, Player player) {
-        SynchronizedMenu<?> menu = this.openMenu(syncId, inventory, player);
-        if (menu != null) {
-            menu.registerData(menu.getData());
-        }
-        return menu;
-    }
+    public abstract SynchronizedMenu<? extends BaseBlockEntity> createMenu(int syncId, Inventory inventory, Player player);
 
     @Override
     public @NotNull Component getDisplayName() {

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

@@ -102,7 +102,7 @@ protected MachineBlockEntity(BlockEntityType<? extends MachineBlockEntity> type,
         this.energyStorage = spec.createEnergyStorage();
     }
 
-    public static <T extends MachineBlockEntity> void registerProviders(@NotNull BlockEntityType<T> type) {
+    public static <T extends MachineBlockEntity> void registerProviders(@NotNull BlockEntityType<? extends T> type) {
         EnergyStorage.SIDED.registerForBlockEntity((blockEntity, direction) -> {
             if (direction == null) return blockEntity.energyStorage().getExposedStorage(ResourceFlow.BOTH);
             return blockEntity.energyStorage().getExposedStorage(blockEntity.getIOConfig().get(Objects.requireNonNull(BlockFace.from(blockEntity.getBlockState(), direction))).getFlow());
@@ -118,8 +118,8 @@ public static <T extends MachineBlockEntity> void registerProviders(@NotNull Blo
     }
 
     @SafeVarargs
-    public static <T extends MachineBlockEntity> void registerProviders(BlockEntityType<T> @NotNull ... types) {
-        for (BlockEntityType<T> type : types) {
+    public static <T extends MachineBlockEntity> void registerProviders(BlockEntityType<? extends T> @NotNull ... types) {
+        for (BlockEntityType<? extends T> type : types) {
             registerProviders(type);
         }
     }
@@ -128,7 +128,7 @@ public static <T extends MachineBlockEntity> void registerProviders(BlockEntityT
     protected abstract @NotNull MachineStatus tick(@NotNull ServerLevel level, @NotNull BlockPos pos, @NotNull BlockState state, @NotNull ProfilerFiller profiler);
 
     @Override
-    public abstract @Nullable MachineMenu<? extends MachineBlockEntity> openMenu(int syncId, Inventory inventory, Player player);
+    public abstract @Nullable MachineMenu<? extends MachineBlockEntity> createMenu(int syncId, Inventory inventory, Player player);
 
     /**
      * {@return the item storage of this machine}
@@ -256,10 +256,10 @@ protected void saveAdditional(CompoundTag tag, HolderLookup.Provider lookup) {
             tag.put(Constant.Nbt.ITEM_STORAGE, this.itemStorage.createTag());
         }
         if (this.fluidStorage.size() > 0) {
-            tag.put(Constant.Nbt.FLUID_STORAGE, this.itemStorage.createTag());
+            tag.put(Constant.Nbt.FLUID_STORAGE, this.fluidStorage.createTag());
         }
         if (this.energyStorage.getCapacity() > 0) {
-            tag.put(Constant.Nbt.ENERGY_STORAGE, this.itemStorage.createTag());
+            tag.put(Constant.Nbt.ENERGY_STORAGE, this.energyStorage.createTag());
         }
     }
 

src/main/java/dev/galacticraft/machinelib/api/compat/vanilla/CraftingRecipeTestContainer.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2021-2024 Team Galacticraft
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package dev.galacticraft.machinelib.api.compat.vanilla;
+
+import dev.galacticraft.machinelib.api.storage.slot.ItemResourceSlot;
+import dev.galacticraft.machinelib.api.util.ItemStackUtil;
+import net.minecraft.world.item.ItemStack;
+
+import java.util.AbstractList;
+
+public class ItemList extends AbstractList<ItemStack> {
+    private final ItemResourceSlot[] slots;
+
+    public ItemList(ItemResourceSlot[] slots) {
+        this.slots = slots;
+    }
+
+    @Override
+    public ItemStack get(int index) {
+        return ItemStackUtil.create(this.slots[index]);
+    }
+
+    @Override
+    public int size() {
+        return this.slots.length;
+    }
+}