feat: utilize menu data to do the initial machine sync

remove slot/range item storage methods

Author: marcus8448

build.gradle.kts

@@ -47,7 +47,7 @@ plugins {
     id("fabric-loom") version("1.7-SNAPSHOT")
     id("org.cadixdev.licenser") version("0.6.1")
     id("org.ajoberstar.grgit") version("5.2.2")
-    id("dev.galacticraft.mojarn") version("0.3.0+8")
+    id("dev.galacticraft.mojarn") version("0.4.0+9")
 }
 
 group = "dev.galacticraft"

settings.gradle.kts

@@ -1,5 +1,11 @@
 pluginManagement {
     repositories {
+        mavenLocal {
+            content {
+                includeGroup("dev.galacticraft")
+                includeGroup("dev.galacticraft.mojarn")
+            }
+        }
         maven("https://maven.fabricmc.net/") {
             name = "Fabric"
             content {

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

@@ -366,7 +366,6 @@ public boolean areDropsDisabled() {
         return this.disableDrops;
     }
 
-
     /**
      * {@return whether the current machine is enabled}
      * @see RedstoneMode
@@ -475,7 +474,7 @@ public boolean isActive() {
      */
     @ApiStatus.Internal
     private @Nullable EnergyStorage getExposedEnergyStorage(@Nullable BlockFace face) {
-        if (face == null) return this.energyStorage.getExposedStorage(ResourceFlow.BOTH);
+        if (face == null) return this.energyStorage.createExposedStorage(ResourceFlow.BOTH);
         return this.configuration.get(face).getExposedEnergyStorage(this.energyStorage);
     }
 
@@ -529,14 +528,14 @@ protected void saveAdditional(CompoundTag tag, HolderLookup.Provider lookup) {
     @Override
     public void loadAdditional(CompoundTag tag, HolderLookup.Provider lookup) {
         super.loadAdditional(tag, lookup);
-        if (tag.contains(Constant.Nbt.CONFIGURATION, Tag.TAG_COMPOUND))
-            this.configuration.readTag(tag.getList(Constant.Nbt.CONFIGURATION, Tag.TAG_COMPOUND));
+        if (tag.contains(Constant.Nbt.CONFIGURATION, Tag.TAG_LIST))
+            this.configuration.readTag(tag.getList(Constant.Nbt.CONFIGURATION, Tag.TAG_BYTE));
         if (tag.contains(Constant.Nbt.SECURITY, Tag.TAG_COMPOUND))
             this.security.readTag(tag.getCompound(Constant.Nbt.SECURITY));
         if (tag.contains(Constant.Nbt.REDSTONE_MODE, Tag.TAG_BYTE))
             this.redstone = RedstoneMode.readTag(tag.get(Constant.Nbt.REDSTONE_MODE));
-        if (tag.contains(Constant.Nbt.STATE, Tag.TAG_COMPOUND))
-            this.state.readTag(tag.getCompound(Constant.Nbt.STATE));
+        if (tag.contains(Constant.Nbt.STATE, Tag.TAG_BYTE))
+            this.state.readTag((ByteTag) tag.get(Constant.Nbt.STATE));
         if (tag.contains(Constant.Nbt.ENERGY_STORAGE, Tag.TAG_LONG))
             this.energyStorage.readTag(Objects.requireNonNull(((LongTag) tag.get(Constant.Nbt.ENERGY_STORAGE))));
         if (tag.contains(Constant.Nbt.ITEM_STORAGE, Tag.TAG_LIST))
@@ -546,7 +545,7 @@ public void loadAdditional(CompoundTag tag, HolderLookup.Provider lookup) {
         this.disableDrops = tag.getBoolean(Constant.Nbt.DISABLE_DROPS);
 
         if (this.level != null && this.level.isClientSide()) {
-            this.level.sendBlockUpdated(worldPosition, Blocks.AIR.defaultBlockState(), this.getBlockState(), Block.UPDATE_IMMEDIATE);
+            this.level.sendBlockUpdated(this.worldPosition, Blocks.AIR.defaultBlockState(), this.getBlockState(), Block.UPDATE_IMMEDIATE);
         }
     }
 
@@ -694,14 +693,7 @@ public RegistryFriendlyByteBuf getScreenOpeningData(ServerPlayer player) {
         }
 
         buf.writeBlockPos(this.getBlockPos());
-        this.configuration.writePacket(buf);
-        this.security.writePacket(buf);
-        this.redstone.writePacket(buf);
-        this.state.writePacket(buf);
-        this.energyStorage.writePacket(buf);
-        this.itemStorage.writePacket(buf);
-        this.fluidStorage.writePacket(buf);
-
+        ((MachineMenu<?>) player.containerMenu).getData().synchronizeInitial(buf);
         return buf;
     }
 
@@ -871,7 +863,7 @@ public void setOption(@NotNull ResourceType type, @NotNull ResourceFlow flow) {
         public @Nullable EnergyStorage getExposedEnergyStorage(@NotNull MachineEnergyStorage storage) {
             if (this.type.willAcceptResource(ResourceType.ENERGY)) {
                 if (this.cachedEnergyStorage == null) {
-                    this.cachedEnergyStorage = storage.getExposedStorage(this.flow);
+                    this.cachedEnergyStorage = storage.createExposedStorage(this.flow);
                 }
                 return this.cachedEnergyStorage;
             }

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

@@ -30,9 +30,7 @@
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.HolderLookup;
 import net.minecraft.nbt.CompoundTag;
-import net.minecraft.network.RegistryFriendlyByteBuf;
 import net.minecraft.server.level.ServerLevel;
-import net.minecraft.server.level.ServerPlayer;
 import net.minecraft.util.profiling.ProfilerFiller;
 import net.minecraft.world.Container;
 import net.minecraft.world.item.crafting.Recipe;
@@ -251,19 +249,6 @@ protected void craft(@NotNull ProfilerFiller profiler, @NotNull RecipeHolder<R>
         return level.getRecipeManager().getRecipeFor(this.getRecipeType(), this.craftingInv(), level).orElse(null);
     }
 
-    @Override
-    public RegistryFriendlyByteBuf getScreenOpeningData(ServerPlayer player) {
-        RegistryFriendlyByteBuf buf = super.getScreenOpeningData(player);
-        if (this.activeRecipe != null) {
-            buf.writeInt(this.getProcessingTime(this.activeRecipe));
-            buf.writeInt(this.progress);
-        } else {
-            buf.writeInt(0);
-        }
-
-        return buf;
-    }
-
     /**
      * {@return the processing time of the given recipe}
      *

src/main/java/dev/galacticraft/machinelib/api/machine/MachineState.java

@@ -27,7 +27,7 @@
 import dev.galacticraft.machinelib.api.misc.Serializable;
 import dev.galacticraft.machinelib.impl.Constant;
 import net.minecraft.ChatFormatting;
-import net.minecraft.nbt.CompoundTag;
+import net.minecraft.nbt.ByteTag;
 import net.minecraft.network.RegistryFriendlyByteBuf;
 import net.minecraft.network.chat.Component;
 import org.jetbrains.annotations.ApiStatus;
@@ -39,7 +39,7 @@
 /**
  * Stores the state of a machine.
  */
-public class MachineState implements Serializable<CompoundTag>, DeltaPacketSerializable<RegistryFriendlyByteBuf, MachineState> {
+public class MachineState implements Serializable<ByteTag>, DeltaPacketSerializable<RegistryFriendlyByteBuf, MachineState> {
     /**
      * The current status of the machine.
      */
@@ -59,10 +59,13 @@ public MachineState() {}
     }
 
     @Override
-    public @NotNull CompoundTag createTag() {
-        CompoundTag tag = new CompoundTag();
-        tag.putBoolean(Constant.Nbt.POWERED, this.powered);
-        return tag;
+    public @NotNull ByteTag createTag() {
+        return ByteTag.valueOf(this.powered);
+    }
+
+    @Override
+    public void readTag(@NotNull ByteTag tag) {
+        this.powered = tag.getAsByte() != 0;
     }
 
     @Override
@@ -82,11 +85,6 @@ public void copyInto(MachineState other) {
         other.powered = this.powered;
     }
 
-    @Override
-    public void readTag(@NotNull CompoundTag tag) {
-        this.powered = tag.getBoolean(Constant.Nbt.POWERED);
-    }
-
     @Override
     public void readPacket(@NotNull RegistryFriendlyByteBuf buf) {
         this.status = MachineStatus.readPacket(buf);
@@ -136,4 +134,9 @@ public boolean isPowered() {
     public void setPowered(boolean powered) {
         this.powered = powered;
     }
+
+    @Override
+    public MachineState createEquivalent() {
+        return new MachineState();
+    }
 }

src/main/java/dev/galacticraft/machinelib/api/machine/MachineType.java

@@ -51,7 +51,7 @@ public interface MachineType<Machine extends MachineBlockEntity, Menu extends Ma
 
     @Contract(value = "_, _, _, _, _, _ -> new", pure = true)
     static <Machine extends MachineBlockEntity, Menu extends MachineMenu<Machine>> @NotNull MachineType<Machine, Menu> create(@NotNull Block block, @NotNull BlockEntityType<Machine> blockEntityType, @NotNull MenuType<Menu> menuType,  @NotNull Supplier<MachineEnergyStorage> energySupplier, @NotNull Supplier<MachineItemStorage> itemSupplier, @NotNull Supplier<MachineFluidStorage> fluidSupplier) {
-        return new MachineTypeImpl<>(block, blockEntityType, menuType,  energySupplier, itemSupplier, fluidSupplier);
+        return new MachineTypeImpl<>(block, blockEntityType, menuType, energySupplier, itemSupplier, fluidSupplier);
     }
 
     /**

src/main/java/dev/galacticraft/machinelib/api/machine/configuration/IOConfig.java

@@ -152,6 +152,11 @@ public void writeDeltaPacket(@NotNull ByteBuf buf, @NotNull IOConfig previous) {
         }
     }
 
+    @Override
+    public IOConfig createEquivalent() {
+        return new IOConfig();
+    }
+
     @Override
     public void copyInto(@NotNull IOConfig other) {
         for (int i = 0; i < this.faces.length; i++) {

src/main/java/dev/galacticraft/machinelib/api/machine/configuration/SecuritySettings.java

@@ -190,6 +190,11 @@ public void readDeltaPacket(@NotNull FriendlyByteBuf buf) {
         }
     }
 
+    @Override
+    public SecuritySettings createEquivalent() {
+        return new SecuritySettings();
+    }
+
     @Override
     public boolean hasChanged(SecuritySettings previous) {
         return !Objects.equals(previous.owner, this.owner) || previous.accessLevel != this.accessLevel;

src/main/java/dev/galacticraft/machinelib/api/menu/MachineMenu.java

@@ -47,11 +47,10 @@
 import dev.galacticraft.machinelib.impl.compat.vanilla.RecipeOutputStorageSlot;
 import dev.galacticraft.machinelib.impl.compat.vanilla.StorageSlot;
 import dev.galacticraft.machinelib.impl.menu.MachineMenuDataImpl;
-import io.netty.buffer.ByteBufAllocator;
+import dev.galacticraft.machinelib.impl.util.Utils;
 import net.fabricmc.fabric.api.screenhandler.v1.ExtendedScreenHandlerType;
 import net.minecraft.core.BlockPos;
 import net.minecraft.network.RegistryFriendlyByteBuf;
-import net.minecraft.network.codec.StreamCodec;
 import net.minecraft.server.level.ServerPlayer;
 import net.minecraft.world.entity.player.Inventory;
 import net.minecraft.world.entity.player.Player;
@@ -79,23 +78,6 @@
  * @param <Machine> The type of machine block entity this menu is linked to.
  */
 public class MachineMenu<Machine extends MachineBlockEntity> extends AbstractContainerMenu {
-    /**
-     * A codec that copies the contents of a buffer.
-     */
-    public static final StreamCodec<RegistryFriendlyByteBuf, RegistryFriendlyByteBuf> BUF_IDENTITY_CODEC = new StreamCodec<>() {
-        @Override
-        public void encode(RegistryFriendlyByteBuf src, RegistryFriendlyByteBuf dst) {
-            src.writeBytes(dst);
-        }
-
-        @Override
-        public @NotNull RegistryFriendlyByteBuf decode(RegistryFriendlyByteBuf src) {
-            RegistryFriendlyByteBuf buf = new RegistryFriendlyByteBuf(ByteBufAllocator.DEFAULT.buffer(src.capacity()), src.registryAccess());
-            buf.writeBytes(src);
-            return buf;
-        }
-    };
-
     /**
      * The machine type associated with this menu.
      */
@@ -165,7 +147,7 @@ public void encode(RegistryFriendlyByteBuf src, RegistryFriendlyByteBuf dst) {
     /**
      * The redstone mode of the machine associated with this menu.
      */
-    public @NotNull RedstoneMode redstoneMode;
+    public @NotNull RedstoneMode redstoneMode = RedstoneMode.IGNORE;
 
     /**
      * Array of {@link MachineItemStorage item storage}-backed slots.
@@ -199,7 +181,7 @@ public MachineMenu(int syncId, @NotNull ServerPlayer player, @NotNull Machine ma
         assert !Objects.requireNonNull(machine.getLevel()).isClientSide;
         this.type = machine.getMachineType();
         this.machine = machine;
-        this.data = new MachineMenuDataImpl(player);
+        this.data = new MachineMenuDataImpl(player, syncId);
         this.server = true;
 
         this.player = player;
@@ -248,7 +230,6 @@ public MachineMenu(int syncId, @NotNull ServerPlayer player, @NotNull Machine ma
 
         this.addPlayerInventorySlots(player.getInventory(), 0, 0); // never displayed on the server.
         this.registerData(this.data);
-        this.data.synchronizeFull();
     }
 
     /**
@@ -265,28 +246,21 @@ protected MachineMenu(int syncId, @NotNull Inventory inventory, @NotNull Registr
 
         this.type = type;
         this.server = false;
-        this.data = new MachineMenuDataClient();
+        this.data = new MachineMenuDataClient(syncId);
         this.player = inventory.player;
         this.playerInventory = inventory;
         this.playerUUID = inventory.player.getUUID();
 
         BlockPos blockPos = buf.readBlockPos();
-        this.machine = (Machine) inventory.player.level().getBlockEntity(blockPos); //todo: actually stop using the BE on the client side
+        this.machine = (Machine) inventory.player.level().getBlockEntity(blockPos);
         this.levelAccess = ContainerLevelAccess.create(inventory.player.level(), blockPos);
-        this.configuration = new IOConfig();
-        this.configuration.readPacket(buf);
-        this.security = new SecuritySettings();
-        this.security.readPacket(buf);
-        this.redstoneMode = RedstoneMode.readPacket(buf);
-
-        this.state = new MachineState();
-        this.state.readPacket(buf);
-        this.energyStorage = type.createEnergyStorage();
-        this.energyStorage.readPacket(buf);
-        this.itemStorage = type.createItemStorage();
-        this.itemStorage.readPacket(buf);
-        this.fluidStorage = type.createFluidStorage();
-        this.fluidStorage.readPacket(buf);
+        this.configuration = this.machine.getIOConfig();
+        this.security = this.machine.getSecurity();
+
+        this.state = this.machine.getState();
+        this.energyStorage = this.machine.energyStorage();
+        this.itemStorage = this.machine.itemStorage();
+        this.fluidStorage = this.machine.fluidStorage();
 
         this.machineSlots = new StorageSlot[this.itemStorage.size()];
 
@@ -316,6 +290,7 @@ protected MachineMenu(int syncId, @NotNull Inventory inventory, @NotNull Registr
 
         this.addPlayerInventorySlots(inventory, invX, invY);
         this.registerData(this.data);
+        this.data.handleInitial(buf);
     }
 
     /**
@@ -329,7 +304,7 @@ protected MachineMenu(int syncId, @NotNull Inventory inventory, @NotNull Registr
      */
     @Contract(value = "_, _ -> new", pure = true)
     public static <Machine extends MachineBlockEntity, Menu extends MachineMenu<Machine>> @NotNull MenuType<Menu> createType(@NotNull MachineMenuFactory<Machine, Menu> factory, Supplier<MachineType<Machine, Menu>> typeSupplier) {
-        return new ExtendedScreenHandlerType<>((syncId, inventory, buf) -> factory.create(syncId, inventory, buf, typeSupplier.get()), BUF_IDENTITY_CODEC);
+        return new ExtendedScreenHandlerType<>((syncId, inventory, buf) -> factory.create(syncId, inventory, buf, typeSupplier.get()), Utils.BUF_IDENTITY_CODEC);
     }
 
     /**
@@ -342,7 +317,7 @@ protected MachineMenu(int syncId, @NotNull Inventory inventory, @NotNull Registr
      */
     @Contract(value = "_ -> new", pure = true)
     public static <Machine extends MachineBlockEntity, Menu extends MachineMenu<Machine>> @NotNull MenuType<Menu> createType(@NotNull BasicMachineMenuFactory<Machine, Menu> factory) {
-        return new ExtendedScreenHandlerType<>(factory::create, BUF_IDENTITY_CODEC);
+        return new ExtendedScreenHandlerType<>(factory::create, Utils.BUF_IDENTITY_CODEC);
     }
 
     /**
@@ -356,7 +331,7 @@ protected MachineMenu(int syncId, @NotNull Inventory inventory, @NotNull Registr
      */
     @Contract(value = "_, _, _ -> new", pure = true)
     public static <Machine extends MachineBlockEntity> @NotNull MenuType<MachineMenu<Machine>> createSimple(int invX, int invY, Supplier<MachineType<Machine, MachineMenu<Machine>>> typeSupplier) {
-        return new ExtendedScreenHandlerType<>((syncId, inventory, buf) -> new MachineMenu<>(syncId, inventory, buf, invX, invY, typeSupplier.get()), BUF_IDENTITY_CODEC);
+        return new ExtendedScreenHandlerType<>((syncId, inventory, buf) -> new MachineMenu<>(syncId, inventory, buf, invX, invY, typeSupplier.get()), Utils.BUF_IDENTITY_CODEC);
     }
 
     /**
@@ -389,13 +364,13 @@ protected MachineMenu(int syncId, @NotNull Inventory inventory, @NotNull Registr
      */
     @MustBeInvokedByOverriders
     public void registerData(MachineMenuData data) {
-        data.register(this.itemStorage, new long[this.itemStorage.size()]); //todo: probably synced by vanilla - is this necessary?
-        data.register(this.fluidStorage, new long[this.fluidStorage.size()]);
-        data.register(this.energyStorage, new long[1]);
-        data.register(this.configuration, new IOConfig());
-        data.register(this.security, new SecuritySettings());
+        data.register(this.itemStorage); //todo: probably synced by vanilla - is this necessary?
+        data.register(this.fluidStorage);
+        data.register(this.energyStorage);
+        data.register(this.configuration);
+        data.register(this.security);
         data.registerEnum(RedstoneMode.values(), () -> this.redstoneMode, mode -> this.redstoneMode = mode);
-        data.register(this.state, new MachineState());
+        data.register(this.state);
     }
 
     /**
@@ -634,14 +609,9 @@ private short calculateIoBitmask() {
         return bits;
     }
 
-    /**
-     * Receives and deserializes sync packets from the server (called on the client).
-     *
-     * @param buf The packet buffer.
-     */
     @ApiStatus.Internal
-    public void receiveState(@NotNull RegistryFriendlyByteBuf buf) {
-        this.data.handle(buf);
+    public MachineMenuData getData() {
+        return data;
     }
 
     /**