feat: improve tablist (#1532)

* fix: setDisplayName in TabListEntry duplicating players on 1.7.10 (#1530)

* feat: expose toggling hat layer in TabListEntry (#1531)

api/src/main/java/com/velocitypowered/api/proxy/player/TabList.java

@@ -40,6 +40,7 @@ public interface TabList {
    * Adds a {@link TabListEntry} to the {@link Player}'s tab list.
    *
    * @param entry to add to the tab list
+   * @throws IllegalArgumentException on versions below 1.19.3, if an entry with the same UUID already exists
    */
   void addEntry(TabListEntry entry);
 
@@ -47,6 +48,7 @@ public interface TabList {
    * Adds a {@link Iterable} of {@link TabListEntry}'s to the {@link Player}'s tab list.
    *
    * @param entries to add to the tab list
+   * @throws IllegalArgumentException on versions below 1.19.3, if an entry with the same UUID already exists
    */
   default void addEntries(Iterable<TabListEntry> entries) {
     for (TabListEntry entry : entries) {
@@ -58,6 +60,7 @@ public interface TabList {
    * Adds an array of {@link TabListEntry}'s to the {@link Player}'s tab list.
    *
    * @param entries to add to the tab list
+   * @throws IllegalArgumentException on versions below 1.19.3, if an entry with the same UUID already exists
    */
   default void addEntries(TabListEntry... entries) {
     for (TabListEntry entry : entries) {
@@ -187,6 +190,26 @@ public interface TabList {
    * @deprecated Internal usage. Use {@link TabListEntry.Builder} instead.
    */
   @Deprecated
+  default TabListEntry buildEntry(GameProfile profile, @Nullable Component displayName, int latency,
+                          int gameMode, @Nullable ChatSession chatSession, boolean listed, int listOrder) {
+    return buildEntry(profile, displayName, latency, gameMode, chatSession, listed, listOrder, true);
+  }
+
+  /**
+   * Represents an entry in a {@link Player}'s tab list.
+   *
+   * @param profile     the profile
+   * @param displayName the display name
+   * @param latency     the latency
+   * @param gameMode    the game mode
+   * @param chatSession the chat session
+   * @param listed      the visible status of entry
+   * @param listOrder   the order/priority of entry in the tab list
+   * @param showHat     the visibility of this entry's hat layer
+   * @return the entry
+   * @deprecated Internal usage. Use {@link TabListEntry.Builder} instead.
+   */
+  @Deprecated
   TabListEntry buildEntry(GameProfile profile, @Nullable Component displayName, int latency,
-                          int gameMode, @Nullable ChatSession chatSession, boolean listed, int listOrder);
+                          int gameMode, @Nullable ChatSession chatSession, boolean listed, int listOrder, boolean showHat);
 }

api/src/main/java/com/velocitypowered/api/proxy/player/TabListEntry.java

@@ -160,6 +160,27 @@ public interface TabListEntry extends KeyIdentifiable {
     return this;
   }
 
+  /**
+   * Returns whether this entry's hat layer is shown in the tab list.
+   *
+   * @return whether to show this entry's hat layer
+   * @sinceMinecraft 1.21.4
+   */
+  default boolean isShowHat() {
+    return true;
+  }
+
+  /**
+   * Sets whether to show this entry's hat layer in the tab list.
+   *
+   * @param showHat whether to show this entry's hat layer
+   * @return {@code this}, for chaining
+   * @sinceMinecraft 1.21.4
+   */
+  default TabListEntry setShowHat(boolean showHat) {
+    return this;
+  }
+
   /**
    * Returns a {@link Builder} to create a {@link TabListEntry}.
    *
@@ -183,6 +204,7 @@ public interface TabListEntry extends KeyIdentifiable {
     private int gameMode = 0;
     private boolean listed = true;
     private int listOrder = 0;
+    private boolean showHat;
 
     private @Nullable ChatSession chatSession;
 
@@ -268,7 +290,7 @@ public interface TabListEntry extends KeyIdentifiable {
      * Sets whether this entry should be visible.
      *
      * @param listed to set
-     * @return ${code this}, for chaining
+     * @return {@code this}, for chaining
      * @see TabListEntry#isListed()
      */
     public Builder listed(boolean listed) {
@@ -280,7 +302,7 @@ public interface TabListEntry extends KeyIdentifiable {
      * Sets the order/priority of this entry in the tab list.
      *
      * @param order to set
-     * @return ${code this}, for chaining
+     * @return {@code this}, for chaining
      * @sinceMinecraft 1.21.2
      * @see TabListEntry#getListOrder()
      */
@@ -289,6 +311,18 @@ public interface TabListEntry extends KeyIdentifiable {
       return this;
     }
 
+    /**
+     * Sets whether this entry's hat layer should be shown in the tab list.
+     *
+     * @param showHat to set
+     * @return {@code this}, for chaining
+     * @see TabListEntry#isShowHat()
+     */
+    public Builder showHat(boolean showHat) {
+      this.showHat = showHat;
+      return this;
+    }
+
     /**
      * Constructs the {@link TabListEntry} specified by {@code this} {@link Builder}.
      *
@@ -301,7 +335,7 @@ public interface TabListEntry extends KeyIdentifiable {
       if (profile == null) {
         throw new IllegalStateException("The GameProfile must be set when building a TabListEntry");
       }
-      return tabList.buildEntry(profile, displayName, latency, gameMode, chatSession, listed, listOrder);
+      return tabList.buildEntry(profile, displayName, latency, gameMode, chatSession, listed, listOrder, showHat);
     }
   }
 }