improvement: Split packet version handling for clientbound and serverbound

Author: ConnorLinfoot

src/main/java/net/hypixel/modapi/HypixelModAPI.java

@@ -5,11 +5,7 @@
 import net.hypixel.modapi.handler.ClientboundPacketHandler;
 import net.hypixel.modapi.packet.ClientboundHypixelPacket;
 import net.hypixel.modapi.packet.PacketRegistry;
-import net.hypixel.modapi.packet.impl.VersionedPacket;
-import net.hypixel.modapi.packet.impl.clientbound.ClientboundLocationPacket;
-import net.hypixel.modapi.packet.impl.clientbound.ClientboundPartyInfoPacket;
-import net.hypixel.modapi.packet.impl.clientbound.ClientboundPingPacket;
-import net.hypixel.modapi.packet.impl.clientbound.ClientboundPlayerInfoPacket;
+import net.hypixel.modapi.packet.impl.clientbound.*;
 import net.hypixel.modapi.packet.impl.serverbound.ServerboundLocationPacket;
 import net.hypixel.modapi.packet.impl.serverbound.ServerboundPartyInfoPacket;
 import net.hypixel.modapi.packet.impl.serverbound.ServerboundPingPacket;
@@ -72,7 +68,7 @@ public void handle(String identifier, PacketSerializer serializer) {
         }
 
         ClientboundHypixelPacket packet = registry.createClientboundPacket(identifier, serializer);
-        if (packet instanceof VersionedPacket && !((VersionedPacket) packet).isExpectedVersion()) {
+        if (packet instanceof ClientboundVersionedPacket && !((ClientboundVersionedPacket) packet).isExpectedVersion()) {
             // Ignore packets that don't match our expected version, these could be received due to other mods requesting them
             return;
         }

src/main/java/net/hypixel/modapi/packet/impl/VersionedPacket.java

@@ -7,7 +7,7 @@
  * Represents a packet that is backed by a version. Versioned packets will only be handled if the incoming packet matches the version of the packet known.
  */
 public abstract class VersionedPacket implements HypixelPacket {
-    private int version;
+    protected int version;
 
     public VersionedPacket(int version) {
         this.version = version;
@@ -20,10 +20,7 @@ public VersionedPacket(PacketSerializer serializer) {
     /**
      * @return true if reading was successful, false if otherwise (such as due to a mismatch in version)
      */
-    protected boolean read(PacketSerializer serializer) {
-        this.version = serializer.readVarInt();
-        return isExpectedVersion();
-    }
+    protected abstract boolean read(PacketSerializer serializer);
 
     @Override
     public void write(PacketSerializer serializer) {
@@ -34,12 +31,6 @@ public int getVersion() {
         return version;
     }
 
-    protected abstract int getLatestVersion();
-
-    public boolean isExpectedVersion() {
-        return getVersion() == getLatestVersion();
-    }
-
     @Override
     public String toString() {
         return "VersionedPacket{" +

src/main/java/net/hypixel/modapi/packet/impl/clientbound/ClientboundLocationPacket.java

@@ -3,14 +3,12 @@
 import net.hypixel.data.region.Environment;
 import net.hypixel.data.type.ServerType;
 import net.hypixel.modapi.handler.ClientboundPacketHandler;
-import net.hypixel.modapi.packet.ClientboundHypixelPacket;
-import net.hypixel.modapi.packet.impl.VersionedPacket;
 import net.hypixel.modapi.serializer.PacketSerializer;
 import org.jetbrains.annotations.Nullable;
 
 import java.util.Optional;
 
-public class ClientboundLocationPacket extends VersionedPacket implements ClientboundHypixelPacket {
+public class ClientboundLocationPacket extends ClientboundVersionedPacket {
     private static final int CURRENT_VERSION = 1;
 
     private Environment environment;

src/main/java/net/hypixel/modapi/packet/impl/clientbound/ClientboundPartyInfoPacket.java

@@ -8,7 +8,7 @@
 
 import java.util.*;
 
-public class ClientboundPartyInfoPacket extends VersionedPacket implements ClientboundHypixelPacket {
+public class ClientboundPartyInfoPacket extends ClientboundVersionedPacket {
     private static final int CURRENT_VERSION = 1;
 
     private boolean inParty;

src/main/java/net/hypixel/modapi/packet/impl/clientbound/ClientboundPingPacket.java

@@ -5,7 +5,7 @@
 import net.hypixel.modapi.packet.impl.VersionedPacket;
 import net.hypixel.modapi.serializer.PacketSerializer;
 
-public class ClientboundPingPacket extends VersionedPacket implements ClientboundHypixelPacket {
+public class ClientboundPingPacket extends ClientboundVersionedPacket {
     private static final int CURRENT_VERSION = 1;
 
     private String response;

src/main/java/net/hypixel/modapi/packet/impl/clientbound/ClientboundPlayerInfoPacket.java

@@ -11,7 +11,7 @@
 
 import java.util.Optional;
 
-public class ClientboundPlayerInfoPacket extends VersionedPacket implements ClientboundHypixelPacket {
+public class ClientboundPlayerInfoPacket extends ClientboundVersionedPacket {
     private static final int CURRENT_VERSION = 1;
 
     private PlayerRank playerRank;

src/main/java/net/hypixel/modapi/packet/impl/clientbound/ClientboundVersionedPacket.java

@@ -0,0 +1,39 @@
+package net.hypixel.modapi.packet.impl.clientbound;
+
+import net.hypixel.modapi.packet.ClientboundHypixelPacket;
+import net.hypixel.modapi.packet.impl.VersionedPacket;
+import net.hypixel.modapi.serializer.PacketSerializer;
+
+/**
+ * Represents a packet that is backed by a version. Clientbound versioned packets will only be handled if the incoming packet matches the version of the packet known.
+ */
+public abstract class ClientboundVersionedPacket extends VersionedPacket implements ClientboundHypixelPacket {
+
+    public ClientboundVersionedPacket(int version) {
+        super(version);
+    }
+
+    public ClientboundVersionedPacket(PacketSerializer serializer) {
+        super(serializer);
+    }
+
+    /**
+     * @return true if reading was successful, false if otherwise (such as due to a mismatch in version)
+     */
+    protected boolean read(PacketSerializer serializer) {
+        this.version = serializer.readVarInt();
+        return isExpectedVersion();
+    }
+
+    @Override
+    public void write(PacketSerializer serializer) {
+        serializer.writeVarInt(version);
+    }
+
+    protected abstract int getLatestVersion();
+
+    public boolean isExpectedVersion() {
+        return getVersion() == getLatestVersion();
+    }
+
+}

src/main/java/net/hypixel/modapi/packet/impl/serverbound/ServerboundLocationPacket.java

@@ -1,9 +1,8 @@
 package net.hypixel.modapi.packet.impl.serverbound;
 
-import net.hypixel.modapi.packet.impl.VersionedPacket;
 import net.hypixel.modapi.serializer.PacketSerializer;
 
-public class ServerboundLocationPacket extends VersionedPacket {
+public class ServerboundLocationPacket extends ServerboundVersionedPacket {
     private static final int CURRENT_VERSION = 1;
 
     public ServerboundLocationPacket() {
@@ -14,9 +13,4 @@ public ServerboundLocationPacket(PacketSerializer serializer) {
         super(serializer);
     }
 
-    @Override
-    protected int getLatestVersion() {
-        return CURRENT_VERSION;
-    }
-
 }

src/main/java/net/hypixel/modapi/packet/impl/serverbound/ServerboundPartyInfoPacket.java

@@ -1,9 +1,8 @@
 package net.hypixel.modapi.packet.impl.serverbound;
 
-import net.hypixel.modapi.packet.impl.VersionedPacket;
 import net.hypixel.modapi.serializer.PacketSerializer;
 
-public class ServerboundPartyInfoPacket extends VersionedPacket {
+public class ServerboundPartyInfoPacket extends ServerboundVersionedPacket {
     private static final int CURRENT_VERSION = 1;
 
     public ServerboundPartyInfoPacket() {
@@ -14,9 +13,4 @@ public ServerboundPartyInfoPacket(PacketSerializer serializer) {
         super(serializer);
     }
 
-    @Override
-    protected int getLatestVersion() {
-        return CURRENT_VERSION;
-    }
-
 }

src/main/java/net/hypixel/modapi/packet/impl/serverbound/ServerboundPingPacket.java

@@ -1,9 +1,8 @@
 package net.hypixel.modapi.packet.impl.serverbound;
 
-import net.hypixel.modapi.packet.impl.VersionedPacket;
 import net.hypixel.modapi.serializer.PacketSerializer;
 
-public class ServerboundPingPacket extends VersionedPacket {
+public class ServerboundPingPacket extends ServerboundVersionedPacket {
     private static final int CURRENT_VERSION = 1;
 
     public ServerboundPingPacket() {
@@ -14,9 +13,4 @@ public ServerboundPingPacket(PacketSerializer serializer) {
         super(serializer);
     }
 
-    @Override
-    protected int getLatestVersion() {
-        return CURRENT_VERSION;
-    }
-
 }