Fix spam of block update (#7068)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Martin Robertz <dream-master@gmx.net>

Author: 3 people

src/main/java/gregtech/api/metatileentity/BaseMetaPipeEntity.java

@@ -796,15 +796,12 @@ public boolean onRightclick(final EntityPlayer aPlayer, final ForgeDirection sid
                         // logic handled internally
                         sendSoundToPlayers(SoundResource.IC2_TOOLS_BATTERY_USE, 1.0F, -1);
                     } else if (GTModHandler.useSolderingIron(tCurrentItem, aPlayer)) {
-                        mMetaTileEntity.markDirty();
-                        mStrongRedstone ^= wrenchingSide.flag;
                         GTUtility.sendChatTrans(
                             aPlayer,
-                            (mStrongRedstone & wrenchingSide.flag) != 0 ? "GT5U.chat.machine.redstone_output_set.strong"
+                            toggleStrongRedstone(wrenchingSide) ? "GT5U.chat.machine.redstone_output_set.strong"
                                 : "GT5U.chat.machine.redstone_output_set.weak",
                             new ChatComponentTranslation(GTUtility.getUnlocalizedSideName(wrenchingSide)));
                         sendSoundToPlayers(SoundResource.IC2_TOOLS_BATTERY_USE, 3.0F, -1);
-                        issueBlockUpdate();
                     }
                     doEnetUpdate();
                     return true;

src/main/java/gregtech/api/metatileentity/BaseMetaTileEntity.java

@@ -1548,15 +1548,12 @@ public boolean onRightclick(final EntityPlayer aPlayer, final ForgeDirection sid
                             // logic handled internally
                             sendSoundToPlayers(SoundResource.IC2_TOOLS_BATTERY_USE, 1.0F, -1);
                         } else if (GTModHandler.useSolderingIron(tCurrentItem, aPlayer)) {
-                            mStrongRedstone ^= wrenchingSide.flag;
                             GTUtility.sendChatTrans(
                                 aPlayer,
-                                (mStrongRedstone & wrenchingSide.flag) != 0
-                                    ? "GT5U.chat.machine.redstone_output_set.strong"
+                                toggleStrongRedstone(wrenchingSide) ? "GT5U.chat.machine.redstone_output_set.strong"
                                     : "GT5U.chat.machine.redstone_output_set.weak",
                                 new ChatComponentTranslation(GTUtility.getUnlocalizedSideName(wrenchingSide)));
                             sendSoundToPlayers(SoundResource.IC2_TOOLS_BATTERY_USE, 3.0F, -1);
-                            issueBlockUpdate();
                         }
                         if (tCurrentItem.stackSize == 0) ForgeEventFactory.onPlayerDestroyItem(aPlayer, tCurrentItem);
                         doEnetUpdate();

src/main/java/gregtech/api/metatileentity/BaseTileEntity.java

@@ -161,6 +161,8 @@ public final int getOffsetZ(ForgeDirection side, int multiplier) {
         return zCoord + side.offsetZ * multiplier;
     }
 
+    abstract boolean isTickDisabled();
+
     @Override
     public final boolean isServerSide() {
         if (worldObj == null) {

src/main/java/gregtech/api/metatileentity/CommonBaseMetaTileEntity.java

@@ -45,13 +45,18 @@
 public abstract class CommonBaseMetaTileEntity extends CoverableTileEntity
     implements IGregTechTileEntity, IInterfaceNameProvider {
 
-    protected boolean mNeedsBlockUpdate = true, mNeedsUpdate = true, mNeedsTileUpdate = false,
-        mInventoryChanged = false, mTickDisabled = false;
+    // mNeedsUpdate: Client only, mark the block for rerender
+    // mNeedsTileUpdate: Server only, mark the block for sync using `S35PacketUpdateTileEntity`
+    // mInventoryChanged: whether the inventory had changed in the previous tick, currently not all code set this
+    // mTickDisabled: whether this block is currently or pending to be unregistered from loaded tile entity list.
+    protected boolean mNeedsUpdate = true, mNeedsTileUpdate = false, mInventoryChanged = false, mTickDisabled = false;
 
     private boolean mIgnoreNextUnload = false;
 
     protected int oldX = 0, oldY = 0, oldZ = 0;
-    protected byte oldStrongRedstone = 0, oldRedstoneData = 63, oldUpdateData = 0;
+    // oldRedstoneData: bitmask of redstone output for all 6 sides, apparently used for client rendering
+    // oldUpdateData: One byte of data that is supplied by MTE and synced with client
+    protected byte oldRedstoneData = 63, oldUpdateData = 0;
 
     private byte mColor = 0;
 
@@ -75,7 +80,8 @@ protected boolean createNewMetatileEntity(short aID) {
         return false;
     }
 
-    public boolean isTickDisabled() {
+    @Override
+    public final boolean isTickDisabled() {
         return mTickDisabled;
     }
 
@@ -471,20 +477,6 @@ public void issueTextureUpdate() {
         mNeedsUpdate = true;
     }
 
-    @Override
-    public void issueBlockUpdate() {
-        mNeedsBlockUpdate = true;
-        if (mTickDisabled) {
-            doBlockUpdateServer();
-        }
-    }
-
-    public final void doBlockUpdateServer() {
-        updateNeighbours(mStrongRedstone, oldStrongRedstone);
-        oldStrongRedstone = mStrongRedstone;
-        mNeedsBlockUpdate = false;
-    }
-
     @Override
     public void issueTileUpdate() {
         mNeedsTileUpdate = true;

src/main/java/gregtech/api/metatileentity/CoverableTileEntity.java

@@ -74,9 +74,15 @@ public abstract class CoverableTileEntity extends BaseTileEntity implements ICov
         CoverRegistry.NO_COVER, CoverRegistry.NO_COVER, CoverRegistry.NO_COVER, CoverRegistry.NO_COVER };
     private byte validCoversMask;
 
+    // Whether block update is needed because of redstone changes.
+    protected boolean mNeedsBlockUpdate = true;
+    // The actual redstone signal per side, direct modifiers of this are required to issue block update for change.
+    // Use `setOutputRedstoneSignal` to modify the redstone output and issue block update on the server if changed.
     protected final byte[] mSidedRedstone = new byte[] { 0, 0, 0, 0, 0, 0 };
-    protected byte mStrongRedstone = 0;
-    protected byte oldStrongRedstone = 0;
+    // Use `setStrongRedstone` to automatically send block update on change
+    private byte mStrongRedstone = 0;
+    // To only issue update to sides that has strong redstone set either previously or currently
+    private byte oldStrongRedstone = 0;
 
     protected short mID = 0;
     public long mTickTimer = 0;
@@ -330,6 +336,9 @@ protected void onBaseTEDestroyed() {
         }
     }
 
+    /**
+     * Used on client side, no need to issue block update
+     */
     protected void setRedstoneOutput(int packedRedstoneValue) {
         mSidedRedstone[0] = (byte) ((packedRedstoneValue & 1) == 1 ? 15 : 0);
         mSidedRedstone[1] = (byte) ((packedRedstoneValue & 2) == 2 ? 15 : 0);
@@ -349,13 +358,54 @@ public final byte getSidedRedstoneMask() {
         return redstone;
     }
 
+    public final byte getStrongRedstone() {
+        return mStrongRedstone;
+    }
+
+    /**
+     * Sets a new value for strong redstone. If the value is changed, block update is issued automatically.
+     */
+    public final void setStrongRedstone(byte newStrongRedstone) {
+        if (newStrongRedstone != mStrongRedstone) {
+            mStrongRedstone = newStrongRedstone;
+            markDirty();
+            issueBlockUpdate();
+        }
+    }
+
+    /**
+     * Toggles the specified side for strong redstone
+     *
+     * @return whether the side is emitting strong redstone
+     */
+    public final boolean toggleStrongRedstone(ForgeDirection side) {
+        mStrongRedstone ^= (byte) side.flag;
+        markDirty();
+        issueBlockUpdate();
+        return (mStrongRedstone & side.flag) != 0;
+    }
+
+    @Override
+    public void issueBlockUpdate() {
+        mNeedsBlockUpdate = true;
+        if (isTickDisabled()) {
+            doBlockUpdateServer();
+        }
+    }
+
+    public final void doBlockUpdateServer() {
+        updateNeighbours(mStrongRedstone, oldStrongRedstone);
+        oldStrongRedstone = mStrongRedstone;
+        mNeedsBlockUpdate = false;
+    }
+
     @Override
     public void setOutputRedstoneSignal(ForgeDirection side, byte strength) {
         final byte cappedStrength = (byte) Math.min(Math.max(0, strength), 15);
         if (side == ForgeDirection.UNKNOWN) return;
 
         final int ordinalSide = side.ordinal();
-        if (mSidedRedstone[ordinalSide] != cappedStrength || (mStrongRedstone & (1 << ordinalSide)) > 0) {
+        if (mSidedRedstone[ordinalSide] != cappedStrength) {
             mSidedRedstone[ordinalSide] = cappedStrength;
             issueBlockUpdate();
             scheduleTexturePacket();
@@ -364,16 +414,16 @@ public void setOutputRedstoneSignal(ForgeDirection side, byte strength) {
 
     @Override
     public void setStrongOutputRedstoneSignal(ForgeDirection side, byte strength) {
-        mStrongRedstone |= (byte) side.flag;
+        setStrongRedstone((byte) (mStrongRedstone | side.flag));
         setOutputRedstoneSignal(side, strength);
     }
 
     @Override
     public void setRedstoneOutputStrength(ForgeDirection side, boolean isStrong) {
         if (isStrong) {
-            mStrongRedstone |= (byte) side.flag;
+            setStrongRedstone((byte) (mStrongRedstone | side.flag));
         } else {
-            mStrongRedstone &= ~(byte) side.flag;
+            setStrongRedstone((byte) (mStrongRedstone & (~side.flag)));
         }
         setOutputRedstoneSignal(side, mSidedRedstone[side.ordinal()]);
     }