Moved sound play logic to using network packets

Author: pedroksl

gradle.properties

@@ -16,7 +16,7 @@ mod_id=ae2addonlib
 mod_name=AE2AddonLib
 mod_license=LGPL-3.0
 mod_license_url=https://github.com/pedroksl/AE2AddonLib/blob/main/LICENSE
-mod_version=1.0.3-1.20.1
+mod_version=1.0.4-1.20.1
 mod_url=https://github.com/pedroksl/AE2AddonLib
 version_type=release
 mod_group_id=net.pedroksl.ae2addonlib

src/main/java/net/pedroksl/ae2addonlib/api/IFluidTankHandler.java

@@ -9,7 +9,8 @@
 import net.minecraftforge.common.capabilities.ForgeCapabilities;
 import net.minecraftforge.fluids.FluidStack;
 import net.minecraftforge.fluids.capability.IFluidHandler;
-import net.pedroksl.ae2addonlib.client.widgets.FluidTankSlot;
+import net.pedroksl.ae2addonlib.network.LibNetworkHandler;
+import net.pedroksl.ae2addonlib.network.clientPacket.FluidTankClientAudioPacket;
 
 import appeng.api.config.Actionable;
 import appeng.api.stacks.AEFluidKey;
@@ -95,7 +96,7 @@ default void onItemUse(int index, int button) {
                         setCarriedItem(cap.getContainer());
 
                         if (inserted > 0) {
-                            FluidTankSlot.playDownSound(true);
+                            LibNetworkHandler.INSTANCE.sendTo(new FluidTankClientAudioPacket(true), getServerPlayer());
                         }
                     }
                 } else {
@@ -121,7 +122,7 @@ default void onItemUse(int index, int button) {
 
                             setCarriedItem(cap.getContainer());
 
-                            FluidTankSlot.playDownSound(false);
+                            LibNetworkHandler.INSTANCE.sendTo(new FluidTankClientAudioPacket(false), getServerPlayer());
                         }
                     }
                 }

src/main/java/net/pedroksl/ae2addonlib/api/IFluidTankScreen.java

@@ -1,6 +1,7 @@
 package net.pedroksl.ae2addonlib.api;
 
 import net.minecraftforge.fluids.FluidStack;
+import net.pedroksl.ae2addonlib.client.widgets.FluidTankSlot;
 
 /**
  * Marks a screen as compatible with {@link net.pedroksl.ae2addonlib.client.widgets.FluidTankSlot}.
@@ -13,4 +14,12 @@ public interface IFluidTankScreen {
      * @param stack The tank's updated stack.
      */
     void updateFluidTankContents(int index, FluidStack stack);
+
+    /**
+     * Method called when a successful interaction wants to play a sound on the client.
+     * @param isInsert Decides if the sound is of an insertion or extraction.
+     */
+    default void playDownSound(boolean isInsert) {
+        FluidTankSlot.playDownSound(isInsert);
+    }
 }

src/main/java/net/pedroksl/ae2addonlib/network/LibNetworkHandler.java

@@ -1,6 +1,7 @@
 package net.pedroksl.ae2addonlib.network;
 
 import net.pedroksl.ae2addonlib.AE2AddonLib;
+import net.pedroksl.ae2addonlib.network.clientPacket.FluidTankClientAudioPacket;
 import net.pedroksl.ae2addonlib.network.clientPacket.FluidTankStackUpdatePacket;
 import net.pedroksl.ae2addonlib.network.clientPacket.OutputDirectionUpdatePacket;
 import net.pedroksl.ae2addonlib.network.serverPacket.AddonConfigButtonPacket;
@@ -23,7 +24,7 @@ public class LibNetworkHandler extends NetworkHandler {
 
     @Override
     public void init() {
-        // registerPacket(FluidTankClientAudioPacket.class, FluidTankClientAudioPacket::new);
+        registerPacket(FluidTankClientAudioPacket.class, FluidTankClientAudioPacket::new);
         registerPacket(FluidTankStackUpdatePacket.class, FluidTankStackUpdatePacket::new);
         registerPacket(OutputDirectionUpdatePacket.class, OutputDirectionUpdatePacket::new);
 

src/main/java/net/pedroksl/ae2addonlib/network/clientPacket/FluidTankClientAudioPacket.java

@@ -1,15 +1,43 @@
 package net.pedroksl.ae2addonlib.network.clientPacket;
 
+import net.minecraft.client.Minecraft;
+import net.minecraft.network.FriendlyByteBuf;
+import net.minecraft.world.entity.player.Player;
+import net.pedroksl.ae2addonlib.api.IFluidTankScreen;
+import net.pedroksl.ae2addonlib.network.AddonPacket;
+
 /**
- * Record used to define the packet used to tell the client to trigger sound from a {@link net.pedroksl.ae2addonlib.client.widgets.FluidTankSlot} interaction.
- * @param isInsert Defines if the sound to be played is of an insertion or extraction.
+ * Class used to define the packet used to tell the client to trigger sound from a {@link net.pedroksl.ae2addonlib.client.widgets.FluidTankSlot} interaction.
  */
-public record FluidTankClientAudioPacket(boolean isInsert) { // implements ClientboundPacket {
-
-    // @Override
-    // public void handleOnClient(IPayloadContext context) {
-    //    if (Minecraft.getInstance().screen instanceof IFluidTankScreen screen) {
-    //        FluidTankSlot.playDownSound(isInsert);
-    //    }
-    // }
+public class FluidTankClientAudioPacket extends AddonPacket {
+
+    private final boolean isInsert;
+
+    /**
+     * Constructs the packet from data in the stream.
+     * @param stream The data stream.
+     */
+    public FluidTankClientAudioPacket(FriendlyByteBuf stream) {
+        this.isInsert = stream.readBoolean();
+    }
+
+    /**
+     * Constructs the packet to send to the stream.
+     * @param isInsert Defines if the sound to be played is of an insertion or extraction.
+     */
+    public FluidTankClientAudioPacket(boolean isInsert) {
+        this.isInsert = isInsert;
+    }
+
+    @Override
+    protected void write(FriendlyByteBuf stream) {
+        stream.writeBoolean(isInsert);
+    }
+
+    @Override
+    public void clientPacketData(Player player) {
+        if (Minecraft.getInstance().screen instanceof IFluidTankScreen screen) {
+            screen.playDownSound(isInsert);
+        }
+    }
 }