fix: manually synchronize block entity data, component nullability errors

Author: marcus8448

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

@@ -43,9 +43,12 @@
 import dev.galacticraft.machinelib.client.api.screen.MachineScreen;
 import dev.galacticraft.machinelib.impl.Constant;
 import dev.galacticraft.machinelib.impl.MachineLib;
+import dev.galacticraft.machinelib.impl.network.s2c.BaseMachineUpdatePayload;
+import dev.galacticraft.machinelib.impl.network.s2c.SideConfigurationUpdatePayload;
 import io.netty.buffer.ByteBuf;
 import io.netty.buffer.Unpooled;
 import net.fabricmc.fabric.api.blockview.v2.RenderDataBlockEntity;
+import net.fabricmc.fabric.api.networking.v1.ServerPlayNetworking;
 import net.fabricmc.fabric.api.screenhandler.v1.ExtendedScreenHandlerFactory;
 import net.fabricmc.fabric.api.transfer.v1.fluid.FluidStorage;
 import net.fabricmc.fabric.api.transfer.v1.fluid.FluidVariant;
@@ -55,31 +58,38 @@
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;
 import net.minecraft.core.HolderLookup;
-import net.minecraft.nbt.*;
+import net.minecraft.nbt.ByteTag;
+import net.minecraft.nbt.CompoundTag;
+import net.minecraft.nbt.LongTag;
+import net.minecraft.nbt.Tag;
 import net.minecraft.network.RegistryFriendlyByteBuf;
 import net.minecraft.network.chat.Component;
 import net.minecraft.network.protocol.Packet;
+import net.minecraft.network.protocol.common.ClientboundCustomPayloadPacket;
+import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
 import net.minecraft.network.protocol.game.ClientGamePacketListener;
-import net.minecraft.network.protocol.game.ClientboundBlockEntityDataPacket;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.server.level.ServerLevel;
 import net.minecraft.server.level.ServerPlayer;
 import net.minecraft.util.profiling.ProfilerFiller;
 import net.minecraft.world.entity.player.Player;
 import net.minecraft.world.item.Item;
 import net.minecraft.world.item.crafting.RecipeHolder;
+import net.minecraft.world.level.ChunkPos;
 import net.minecraft.world.level.block.Block;
 import net.minecraft.world.level.block.Blocks;
 import net.minecraft.world.level.block.entity.BlockEntity;
 import net.minecraft.world.level.block.entity.BlockEntityType;
 import net.minecraft.world.level.block.state.BlockState;
 import net.minecraft.world.level.block.state.properties.BlockStateProperties;
 import net.minecraft.world.level.material.Fluid;
-import org.jetbrains.annotations.*;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import team.reborn.energy.api.EnergyStorage;
 import team.reborn.energy.api.EnergyStorageUtil;
 
-import javax.crypto.Mac;
 import java.util.Collections;
 import java.util.Objects;
 import java.util.Optional;
@@ -206,7 +216,7 @@ protected MachineBlockEntity(@NotNull MachineType<? extends MachineBlockEntity,
 
         MachineIOFace[] faces = new MachineIOFace[6];
         for (int i = 0; i < faces.length; i++) {
-            faces[i] = new InternalMachineIoFace();
+            faces[i] = new InternalMachineIoFace(i);
         }
         this.configuration = new MachineIOConfig(faces);
         this.security = new InternalSecuritySettings();
@@ -334,7 +344,6 @@ public void setRedstoneMode(@NotNull RedstoneMode redstone) {
      * Used to determine who can interact with this machine.
      *
      * @return the security settings of this machine.
-     * @see MachineConfiguration
      */
     @Contract(pure = true)
     public final @NotNull SecuritySettings getSecurity() {
@@ -782,6 +791,8 @@ 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);
@@ -802,7 +813,7 @@ public RegistryFriendlyByteBuf getScreenOpeningData(ServerPlayer player) {
 
     @Override
     public @NotNull MachineRenderData getRenderData() {
-        return this.getIOConfig();
+        return this.configuration;
     }
 
     @Override
@@ -815,7 +826,26 @@ public CompoundTag getUpdateTag(HolderLookup.Provider registryLookup) {
     @Nullable
     @Override
     public Packet<ClientGamePacketListener> getUpdatePacket() {
-        return ClientboundBlockEntityDataPacket.create(this);
+        // safe cast because the ClientCommonPacketListener is a superclass of ClientGamePacketListener
+        // noinspection unchecked, rawtypes
+        return (Packet) new ClientboundCustomPayloadPacket(new BaseMachineUpdatePayload(this.worldPosition, this.configuration));
+    }
+
+    @Override
+    public void setChanged() {
+        super.setChanged();
+    }
+
+    protected void broadcastUpdate(CustomPacketPayload payload) {
+        if (this.level != null && !this.level.isClientSide) {
+            for (ServerPlayer player : ((ServerLevel) MachineBlockEntity.this.level).getChunkSource().chunkMap.getPlayers(new ChunkPos(MachineBlockEntity.this.worldPosition), false)) {
+                ServerPlayNetworking.getSender(player).sendPacket(payload);
+            }
+        }
+    }
+
+    public void markForRerender() {
+        this.level.sendBlockUpdated(this.worldPosition, this.getBlockState(), this.getBlockState(), 0);
     }
 
     public void awardUsedRecipes(@NotNull ServerPlayer player, @NotNull Set<ResourceLocation> recipes) {
@@ -870,24 +900,33 @@ public void setAccessLevel(@NotNull AccessLevel accessLevel) {
     }
 
     private class InternalMachineIoFace extends MachineIOFace {
+        private final BlockFace face;
         private @Nullable ExposedStorage<Item, ItemVariant> cachedItemStorage = null;
         private @Nullable ExposedStorage<Fluid, FluidVariant> cachedFluidStorage = null;
         private @Nullable EnergyStorage cachedEnergyStorage = null;
 
-        public InternalMachineIoFace() {
+        public InternalMachineIoFace(int i) {
             super(ResourceType.NONE, ResourceFlow.BOTH);
+            this.face = BlockFace.values()[i];
         }
 
         @Override
         public void setOption(@NotNull ResourceType type, @NotNull ResourceFlow flow) {
-            this.type = type;
-            this.flow = flow;
+            if (this.type != type || this.flow != flow) {
+                this.type = type;
+                this.flow = flow;
 
-            MachineBlockEntity.this.setChanged();
+                MachineBlockEntity.this.setChanged();
+                if (MachineBlockEntity.this.level.isClientSide) {
+                    MachineBlockEntity.this.markForRerender();
+                } else {
+                    MachineBlockEntity.this.broadcastUpdate(new SideConfigurationUpdatePayload(MachineBlockEntity.this.worldPosition, this.face, type, flow));
+                }
 
-            this.cachedItemStorage = null;
-            this.cachedFluidStorage = null;
-            this.cachedEnergyStorage = null;
+                this.cachedItemStorage = null;
+                this.cachedFluidStorage = null;
+                this.cachedEnergyStorage = null;
+            }
         }
 
         @Override

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

@@ -1,3 +1,25 @@
+/*
+ * 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.menu;
 
 import dev.galacticraft.machinelib.api.misc.DeltaPacketSerializable;
@@ -36,8 +58,8 @@ public void registerInt(IntSupplier getter, IntConsumer setter) {
         this.delta.add(new int[1]);
     }
     public <E extends Enum<E>> void registerEnum(E[] world, Supplier<E> getter, Consumer<E> setter) {
-        this.data.add(new EnumPacketSerializable(world, getter, setter));
-        this.delta.add(new int[1]);
+        this.data.add(new EnumPacketSerializable<>(world, getter, setter));
+        this.delta.add(null);
     }
 
     public void registerLong(LongSupplier getter, LongConsumer setter) {

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

@@ -61,7 +61,10 @@
 import net.minecraft.world.inventory.Slot;
 import net.minecraft.world.item.Item;
 import net.minecraft.world.item.ItemStack;
-import org.jetbrains.annotations.*;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.MustBeInvokedByOverriders;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -78,14 +81,14 @@ public class MachineMenu<Machine extends MachineBlockEntity> extends AbstractCon
     public static final StreamCodec<RegistryFriendlyByteBuf, RegistryFriendlyByteBuf> BUF_IDENTITY_CODEC = new StreamCodec<>() {
         @Override
         public void encode(RegistryFriendlyByteBuf src, RegistryFriendlyByteBuf dst) {
-            dst.writeBytes(src);
+            src.writeBytes(dst);
         }
 
         @Override
         public RegistryFriendlyByteBuf decode(RegistryFriendlyByteBuf src) {
             RegistryFriendlyByteBuf buf = new RegistryFriendlyByteBuf(ByteBufAllocator.DEFAULT.buffer(src.capacity()), src.registryAccess());
             buf.writeBytes(src);
-            return src;
+            return buf;
         }
     };
 

src/main/java/dev/galacticraft/machinelib/api/misc/Equivalent.java

@@ -1,6 +1,26 @@
-package dev.galacticraft.machinelib.api.misc;
+/*
+ * 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.
+ */
 
-import org.jetbrains.annotations.NotNull;
+package dev.galacticraft.machinelib.api.misc;
 
 public interface Equivalent<T> {
     boolean hasChanged(T previous);

src/main/java/dev/galacticraft/machinelib/client/api/screen/MachineScreen.java

@@ -25,18 +25,14 @@
 import com.google.common.base.Suppliers;
 import com.google.common.collect.Lists;
 import com.mojang.authlib.GameProfile;
-import com.mojang.authlib.minecraft.MinecraftProfileTexture;
 import com.mojang.blaze3d.systems.RenderSystem;
 import com.mojang.blaze3d.vertex.PoseStack;
 import dev.galacticraft.machinelib.api.block.entity.MachineBlockEntity;
 import dev.galacticraft.machinelib.api.machine.configuration.AccessLevel;
 import dev.galacticraft.machinelib.api.machine.configuration.MachineIOFace;
 import dev.galacticraft.machinelib.api.machine.configuration.RedstoneMode;
 import dev.galacticraft.machinelib.api.menu.MachineMenu;
-import dev.galacticraft.machinelib.api.storage.slot.FluidResourceSlot;
-import dev.galacticraft.machinelib.api.storage.slot.ItemResourceSlot;
 import dev.galacticraft.machinelib.api.transfer.InputType;
-import dev.galacticraft.machinelib.api.transfer.ResourceFlow;
 import dev.galacticraft.machinelib.api.transfer.ResourceType;
 import dev.galacticraft.machinelib.api.util.BlockFace;
 import dev.galacticraft.machinelib.client.api.render.MachineRenderData;
@@ -45,19 +41,15 @@
 import dev.galacticraft.machinelib.client.impl.model.MachineBakedModel;
 import dev.galacticraft.machinelib.impl.Constant;
 import dev.galacticraft.machinelib.impl.compat.vanilla.StorageSlot;
-import dev.galacticraft.machinelib.impl.network.c2s.AccessLevelPacket;
-import dev.galacticraft.machinelib.impl.network.c2s.RedstoneModePacket;
-import dev.galacticraft.machinelib.impl.network.c2s.SideConfigurationClickPacket;
-import dev.galacticraft.machinelib.impl.network.c2s.TankInteractionPacket;
-import io.netty.buffer.ByteBufAllocator;
+import dev.galacticraft.machinelib.impl.network.c2s.AccessLevelPayload;
+import dev.galacticraft.machinelib.impl.network.c2s.RedstoneModePayload;
+import dev.galacticraft.machinelib.impl.network.c2s.SideConfigurationClickPayload;
+import dev.galacticraft.machinelib.impl.network.c2s.TankInteractionPayload;
 import lol.bai.badpackets.api.PacketSender;
-import lol.bai.badpackets.api.play.PlayPackets;
 import net.fabricmc.api.EnvType;
 import net.fabricmc.api.Environment;
 import net.fabricmc.fabric.api.client.networking.v1.ClientPlayNetworking;
 import net.fabricmc.fabric.api.transfer.v1.context.ContainerItemContext;
-import net.fabricmc.fabric.api.transfer.v1.item.PlayerInventoryStorage;
-import net.fabricmc.fabric.impl.transfer.context.PlayerContainerItemContext;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.gui.GuiGraphics;
 import net.minecraft.client.gui.components.PlayerFaceRenderer;
@@ -67,7 +59,6 @@
 import net.minecraft.client.resources.PlayerSkin;
 import net.minecraft.client.resources.sounds.SimpleSoundInstance;
 import net.minecraft.core.registries.BuiltInRegistries;
-import net.minecraft.network.FriendlyByteBuf;
 import net.minecraft.network.chat.Component;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.sounds.SoundEvents;
@@ -551,7 +542,7 @@ public boolean checkConfigurationPanelClick(double mouseX, double mouseY, int bu
      */
     protected void setAccessibility(@NotNull AccessLevel accessLevel) {
         this.menu.security.setAccessLevel(accessLevel);
-        PacketSender.c2s().send(new AccessLevelPacket(accessLevel));
+        PacketSender.c2s().send(new AccessLevelPayload(accessLevel));
     }
 
     /**
@@ -561,7 +552,7 @@ protected void setAccessibility(@NotNull AccessLevel accessLevel) {
      */
     protected void setRedstone(@NotNull RedstoneMode redstone) {
         this.menu.redstoneMode = redstone;
-        PacketSender.c2s().send(new RedstoneModePacket(redstone));
+        PacketSender.c2s().send(new RedstoneModePayload(redstone));
     }
 
     /**
@@ -859,7 +850,7 @@ private void handleSlotHighlight(GuiGraphics graphics, int mouseX, int mouseY) {
     public boolean mouseClicked(double mouseX, double mouseY, int button) {
         if (this.hoveredTank != null && button == GLFW.GLFW_MOUSE_BUTTON_LEFT) {
             if (this.hoveredTank.acceptStack(ContainerItemContext.ofPlayerCursor(this.menu.playerInventory.player, this.menu))) {
-                PacketSender.c2s().send(new TankInteractionPacket(this.menu.containerId, this.hoveredTank.getIndex()));
+                PacketSender.c2s().send(new TankInteractionPayload(this.menu.containerId, this.hoveredTank.getIndex()));
             }
             return true;
         }
@@ -928,7 +919,7 @@ public int getImageHeight() {
     private void modifyFace(int button, BlockFace face) {
         if (this.menu.isFaceLocked(face)) return;
         if (button == 0) {
-            ClientPlayNetworking.send(new SideConfigurationClickPacket(face, Screen.hasShiftDown(), Screen.hasControlDown()));
+            ClientPlayNetworking.send(new SideConfigurationClickPayload(face, Screen.hasShiftDown(), Screen.hasControlDown()));
             this.menu.cycleFaceConfig(face, Screen.hasShiftDown(), Screen.hasControlDown());
         }
         this.playButtonSound();

src/main/java/dev/galacticraft/machinelib/client/api/util/DisplayUtil.java

@@ -34,7 +34,6 @@
 import net.minecraft.client.gui.screens.Screen;
 import net.minecraft.client.resources.language.I18n;
 import net.minecraft.core.component.DataComponentPatch;
-import net.minecraft.nbt.CompoundTag;
 import net.minecraft.network.chat.Component;
 import net.minecraft.network.chat.MutableComponent;
 import net.minecraft.network.chat.Style;
@@ -125,7 +124,8 @@ public static void createFluidTooltip(@NotNull List<Component> tooltip, @Nullabl
             return;
         }
 
-        tooltip.add(Component.translatable(Constant.TranslationKey.TANK_CONTENTS).setStyle(Constant.Text.GRAY_STYLE).append(FluidVariantAttributes.getName(FluidVariant.of(fluid, components))));
+        assert fluid != null;
+        tooltip.add(Component.translatable(Constant.TranslationKey.TANK_CONTENTS).setStyle(Constant.Text.GRAY_STYLE).append(FluidVariantAttributes.getName(FluidVariant.of(fluid, components == null ? DataComponentPatch.EMPTY : components))));
         tooltip.add(Component.translatable(Constant.TranslationKey.TANK_AMOUNT).setStyle(Constant.Text.GRAY_STYLE).append(DisplayUtil.formatFluid(amount, Screen.hasShiftDown()).setStyle(Style.EMPTY.withColor(ChatFormatting.WHITE))));
 
         if (capacity != -1) {

src/main/java/dev/galacticraft/machinelib/client/impl/menu/sync/MachineDataClient.java

@@ -1,3 +1,25 @@
+/*
+ * 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.client.impl.menu.sync;
 
 import dev.galacticraft.machinelib.api.menu.MachineData;

src/main/java/dev/galacticraft/machinelib/client/impl/model/MachineBakedModel.java

@@ -118,8 +118,9 @@ public MachineBakedModel(MachineModelRegistry.SpriteProviderFactory factory, Jso
 
     private boolean transform(MachineRenderData renderData, @NotNull BlockState state, @NotNull MutableQuadView quad) {
         BlockFace face = BlockFace.toFace(state.getValue(BlockStateProperties.HORIZONTAL_FACING), quad.nominalFace());
-        MachineIOFace machineFace = renderData == null ? new MachineIOFace() : renderData.getIOConfig().get(face);
         assert face != null;
+
+        MachineIOFace machineFace = renderData == null ? new MachineIOFace() : renderData.getIOConfig().get(face);
         quad.spriteBake(getSprite(face,
                         renderData,
                         machineFace.getType(), machineFace.getFlow()),