feat: migration to Velocity's new immutable packets model (PaperMC/Velocity#1672)

version might change depending on when Velocity PR is merged

Author: Timongcraft

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>de.timongcraft</groupId>
     <artifactId>VeloBoard</artifactId>
-    <version>1.6.1</version>
+    <version>1.6.2-SNAPSHOT</version>
 
     <properties>
         <java.version>17</java.version>
@@ -105,14 +105,14 @@
         </dependency>
         <dependency>
             <groupId>com.velocitypowered</groupId>
-            <artifactId>velocity-proxy</artifactId>
+            <artifactId>local-velocity-immutable-packets-proxy</artifactId>
             <version>3.4.0-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>de.timongcraft</groupId>
             <artifactId>VeloPacketImpl</artifactId>
-            <version>3.1.5</version>
+            <version>4.0.0-SNAPSHOT</version>
         </dependency>
     </dependencies>
 </project>

src/main/java/de/timongcraft/veloboard/SimpleBoard.java

@@ -9,15 +9,14 @@
 import de.timongcraft.velopacketimpl.network.protocol.packets.UpdateScorePacket;
 import de.timongcraft.velopacketimpl.utils.ComponentUtils;
 import de.timongcraft.velopacketimpl.utils.annotations.Since;
-import net.kyori.adventure.text.Component;
-import org.jetbrains.annotations.Nullable;
-import org.jetbrains.annotations.Unmodifiable;
-
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.List;
 import java.util.Objects;
+import net.kyori.adventure.text.Component;
+import org.jetbrains.annotations.Nullable;
+import org.jetbrains.annotations.Unmodifiable;
 
 import static com.velocitypowered.api.network.ProtocolVersion.MINECRAFT_1_20_3;
 
@@ -52,7 +51,7 @@ public SimpleBoard(Player player, Component title, @Nullable ComponentUtils.Numb
     public void initialize() {
         withLock(() -> {
             sendObjectivePacket(UpdateObjectivesPacket.Mode.CREATE_SCOREBOARD);
-            sendPacket(new DisplayObjectivePacket(1, id));
+            sendPacket(DisplayObjectivePacket.of(1, id));
         });
     }
 
@@ -307,7 +306,7 @@ private void sendLineChangeUnsafe(int score, UpdateScorePacket.Action action) {
         if (action == UpdateScorePacket.Action.CREATE_OR_UPDATE_SCORE) {
             LinesEntry line = getLineByScore(lines, score);
             sendPacket(
-                    new UpdateScorePacket(
+                    UpdateScorePacket.of(
                             String.valueOf(score),
                             id,
                             score,
@@ -320,7 +319,7 @@ private void sendLineChangeUnsafe(int score, UpdateScorePacket.Action action) {
                     )
             );
         } else {
-            sendPacket(new ResetScorePacket(
+            sendPacket(ResetScorePacket.of(
                     String.valueOf(score),
                     id
             ));
@@ -329,9 +328,11 @@ private void sendLineChangeUnsafe(int score, UpdateScorePacket.Action action) {
 
     private void sendObjectivePacket(UpdateObjectivesPacket.Mode mode) {
         sendPacket(
-                new UpdateObjectivesPacket(
+                mode == UpdateObjectivesPacket.Mode.REMOVE_SCOREBOARD
+                        ? UpdateObjectivesPacket.ofRemove(id)
+                        : UpdateObjectivesPacket.of(
                         id,
-                        mode,
+                        mode == UpdateObjectivesPacket.Mode.CREATE_SCOREBOARD,
                         title,
                         UpdateObjectivesPacket.Type.INTEGER,
                         defaultNumberFormat

src/main/java/de/timongcraft/veloboard/VeloBoard.java

@@ -1,5 +1,7 @@
 package de.timongcraft.veloboard;
 
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
 import com.velocitypowered.api.proxy.Player;
 import de.timongcraft.veloboard.utils.ListUtils;
 import de.timongcraft.velopacketimpl.network.protocol.packets.DisplayObjectivePacket;
@@ -9,18 +11,15 @@
 import de.timongcraft.velopacketimpl.network.protocol.packets.UpdateTeamsPacket;
 import de.timongcraft.velopacketimpl.utils.ComponentUtils;
 import de.timongcraft.velopacketimpl.utils.annotations.Since;
-import net.kyori.adventure.text.Component;
-import net.kyori.adventure.text.format.NamedTextColor;
-import org.jetbrains.annotations.Nullable;
-import org.jetbrains.annotations.Unmodifiable;
-
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
-import java.util.Collections;
-import java.util.EnumSet;
 import java.util.List;
 import java.util.Objects;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.format.NamedTextColor;
+import org.jetbrains.annotations.Nullable;
+import org.jetbrains.annotations.Unmodifiable;
 
 import static com.velocitypowered.api.network.ProtocolVersion.MINECRAFT_1_20_3;
 
@@ -53,7 +52,7 @@ public VeloBoard(Player player, Component title, @Nullable ComponentUtils.Number
     public void initialize() {
         withLock(() -> {
             sendObjectivePacket(UpdateObjectivesPacket.Mode.CREATE_SCOREBOARD);
-            sendPacket(new DisplayObjectivePacket(1, id));
+            sendPacket(DisplayObjectivePacket.of(1, id));
         });
     }
 
@@ -64,7 +63,7 @@ public void resend() {
 
             for (int i = 0; i < lines.size(); ++i) {
                 sendScorePacketUnchecked(i, UpdateScorePacket.Action.CREATE_OR_UPDATE_SCORE);
-                sendTeamPacketUnchecked(i, UpdateTeamsPacket.Mode.CREATE_TEAM, getLineByScore(lines, i));
+                sendTeamPacketUnchecked(i, true, getLineByScoreUnsafe(i));
             }
         });
     }
@@ -73,7 +72,7 @@ public void resend() {
     public void clear() {
         withLock(() -> {
             for (int i = 0; i < this.lines.size(); ++i) {
-                sendTeamPacketUnchecked(i, UpdateTeamsPacket.Mode.REMOVE_TEAM);
+                sendRemoveTeamUnchecked(i);
             }
 
             sendObjectivePacket(UpdateObjectivesPacket.Mode.REMOVE_SCOREBOARD);
@@ -169,19 +168,20 @@ public void updateLines(Collection<Component> lines) {
                 for (int i = 0; i < this.lines.size(); i++) {
                     if (i >= oldLines.size()) {
                         sendScorePacketUnchecked(i, UpdateScorePacket.Action.CREATE_OR_UPDATE_SCORE);
-                        sendTeamPacketUnchecked(i, UpdateTeamsPacket.Mode.CREATE_TEAM);
+                        sendTeamPacketUnchecked(i, true, getLineByScoreUnsafe(i));
+                    } else {
+                        sendLineChangeUnsafe(i);
                     }
-                    sendLineChangeUnsafe(i);
                 }
 
                 for (int i = this.lines.size(); i < oldLines.size(); i++) {
-                    sendTeamPacketUnchecked(i, UpdateTeamsPacket.Mode.REMOVE_TEAM);
+                    sendRemoveTeamUnchecked(i);
                     sendScorePacketUnchecked(i, UpdateScorePacket.Action.REMOVE_SCORE);
                 }
             }
 
             for (int i = 0; i < this.lines.size(); ++i) {
-                if (!Objects.equals(getLineByScore(oldLines, i), getLineByScore(this.lines, i))) {
+                if (!Objects.equals(getLineByScore(i, oldLines), getLineByScoreUnsafe(i))) {
                     sendLineChangeUnsafe(i);
                 }
             }
@@ -264,26 +264,33 @@ private void checkLineIndexUnsafe(int lineIndex, boolean checkInRange, boolean c
     }
 
     private int getScoreByLineUnsafe(int lineIndex) {
+        return getScoreByLine(lineIndex, lines);
+    }
+
+    private int getScoreByLine(int lineIndex, List<Component> lines) {
         return lines.size() - lineIndex - 1;
     }
 
-    private static @Nullable Component getLineByScore(List<Component> lines, int score) {
-        if (score < lines.size()) {
-            return lines.get(lines.size() - score - 1);
-        } else {
-            return null;
-        }
+    private @Nullable Component getLineByScoreUnsafe(int score) {
+        return getLineByScore(score, lines);
+    }
+
+    private @Nullable Component getLineByScore(int score, List<Component> lines) {
+        int index = lines.size() - score - 1;
+        if (index < 0 || index >= lines.size()) return null;
+        return lines.get(index);
     }
 
     private void sendLineChangeUnsafe(int score) {
-        sendTeamPacketUnchecked(score, UpdateTeamsPacket.Mode.UPDATE_TEAM_INFO, getLineByScore(lines, score));
+        sendTeamPacketUnchecked(score, false, getLineByScoreUnsafe(score));
     }
 
     private void sendObjectivePacket(UpdateObjectivesPacket.Mode mode) {
         sendPacket(
-                new UpdateObjectivesPacket(
-                        id,
-                        mode,
+                mode == UpdateObjectivesPacket.Mode.REMOVE_SCOREBOARD
+                        ? UpdateObjectivesPacket.ofRemove(id)
+                        : UpdateObjectivesPacket.of(id,
+                        mode == UpdateObjectivesPacket.Mode.CREATE_SCOREBOARD,
                         player.translateMessage(title),
                         UpdateObjectivesPacket.Type.INTEGER,
                         defaultNumberFormat
@@ -293,40 +300,44 @@ private void sendObjectivePacket(UpdateObjectivesPacket.Mode mode) {
 
     private void sendScorePacketUnchecked(int score, UpdateScorePacket.Action action) {
         sendPacket(
-                action != UpdateScorePacket.Action.REMOVE_SCORE || player.getProtocolVersion().getProtocol() < MINECRAFT_1_20_3.getProtocol() ?
-                        new UpdateScorePacket(
-                                COLOR_CODES[score],
-                                action,
-                                id,
-                                score
-                        )
-                        :
-                        new ResetScorePacket(
-                                COLOR_CODES[score],
-                                id
-                        )
+                action == UpdateScorePacket.Action.CREATE_OR_UPDATE_SCORE
+                        ? UpdateScorePacket.of(COLOR_CODES[score], id, score)
+
+                        : player.getProtocolVersion().lessThan(MINECRAFT_1_20_3)
+                        ? UpdateScorePacket.ofLegacyRemove(COLOR_CODES[score], id)
+                        : ResetScorePacket.of(COLOR_CODES[score], id)
         );
     }
 
-    private void sendTeamPacketUnchecked(int score, UpdateTeamsPacket.Mode mode) {
-        sendTeamPacketUnchecked(score, mode, Component.empty());
+    private void sendRemoveTeamUnchecked(int score) {
+        sendPacket(UpdateTeamsPacket.ofRemove(id + ':' + score));
     }
 
-    private void sendTeamPacketUnchecked(int score, UpdateTeamsPacket.Mode mode, Component teamPrefix) {
-        sendPacket(
-                new UpdateTeamsPacket(
-                        id + ':' + score,
-                        mode,
-                        Component.empty(),
-                        EnumSet.noneOf(UpdateTeamsPacket.FriendlyFlag.class),
-                        UpdateTeamsPacket.NameTagVisibility.ALWAYS,
-                        UpdateTeamsPacket.CollisionRule.ALWAYS,
-                        NamedTextColor.BLACK,
-                        player.translateMessage(teamPrefix),
-                        Component.empty(),
-                        Collections.singletonList(COLOR_CODES[score])
-                )
-        );
+    private void sendTeamPacketUnchecked(int score, boolean create, Component teamPrefix) {
+        if (create) {
+            sendPacket(UpdateTeamsPacket.ofCreate(
+                    id + ':' + score,
+                    Component.empty(),
+                    ImmutableSet.of(),
+                    UpdateTeamsPacket.NameTagVisibility.ALWAYS,
+                    UpdateTeamsPacket.CollisionRule.ALWAYS,
+                    NamedTextColor.BLACK,
+                    player.translateMessage(teamPrefix),
+                    Component.empty(),
+                    ImmutableList.of(COLOR_CODES[score])
+            ));
+        } else {
+            sendPacket(UpdateTeamsPacket.ofUpdateInfo(
+                    id + ':' + score,
+                    Component.empty(),
+                    ImmutableSet.of(),
+                    UpdateTeamsPacket.NameTagVisibility.ALWAYS,
+                    UpdateTeamsPacket.CollisionRule.ALWAYS,
+                    NamedTextColor.BLACK,
+                    player.translateMessage(teamPrefix),
+                    Component.empty()
+            ));
+        }
     }
 
 }