improve usability a ton

Author: jumpingpxl

core/src/main/java/net/labymod/serverapi/core/AbstractLabyModPlayer.java

@@ -31,10 +31,16 @@
 import net.labymod.serverapi.core.integration.LabyModIntegrationPlayer;
 import net.labymod.serverapi.core.integration.LabyModProtocolIntegration;
 import net.labymod.serverapi.core.model.display.Subtitle;
+import net.labymod.serverapi.core.model.feature.DiscordRPC;
+import net.labymod.serverapi.core.model.feature.InteractionMenuEntry;
 import net.labymod.serverapi.core.model.moderation.Permission;
 import net.labymod.serverapi.core.model.supplement.InputPrompt;
 import net.labymod.serverapi.core.model.supplement.ServerSwitchPrompt;
 import net.labymod.serverapi.core.packet.clientbound.game.display.SubtitlePacket;
+import net.labymod.serverapi.core.packet.clientbound.game.display.TabListBannerPacket;
+import net.labymod.serverapi.core.packet.clientbound.game.feature.DiscordRPCPacket;
+import net.labymod.serverapi.core.packet.clientbound.game.feature.InteractionMenuPacket;
+import net.labymod.serverapi.core.packet.clientbound.game.feature.PlayingGameModePacket;
 import net.labymod.serverapi.core.packet.clientbound.game.moderation.PermissionPacket;
 import net.labymod.serverapi.core.packet.clientbound.game.supplement.InputPromptPacket;
 import net.labymod.serverapi.core.packet.clientbound.game.supplement.ServerSwitchPromptPacket;
@@ -129,7 +135,42 @@ protected AbstractLabyModPlayer(
    * @param component The component to set as subtitle
    */
   public void setSubtitle(@NotNull ServerAPIComponent component) {
-    this.setSubtitleInternal(Subtitle.create(this.uniqueId, component));
+    this.setSubtitle(Subtitle.create(this.uniqueId, component));
+  }
+
+  public void setSubtitle(@Nullable Subtitle subtitle) {
+    if (Objects.equals(this.subtitle, subtitle)) {
+      return;
+    }
+
+    this.subtitle = subtitle;
+
+    List<Subtitle> subtitles = new ArrayList<>();
+    if (subtitle == null) {
+      subtitle = Subtitle.create(this.uniqueId, null);
+      subtitles.add(subtitle);
+    }
+
+    LabyModProtocol labyModProtocol = this.protocolService.labyModProtocol();
+    SubtitlePacket packet = new SubtitlePacket(subtitle);
+    for (AbstractLabyModPlayer<?> player : this.protocolService.getPlayers()) {
+      Subtitle playerSubtitle = player.getSubtitle();
+      if (playerSubtitle != null) {
+        subtitles.add(playerSubtitle);
+      }
+
+      if (player.equals(this)) {
+        continue;
+      }
+
+      labyModProtocol.sendPacket(player.getUniqueId(), packet);
+    }
+
+    if (subtitles.isEmpty()) {
+      return;
+    }
+
+    this.sendLabyModPacket(new SubtitlePacket(subtitles));
   }
 
   /**
@@ -139,16 +180,66 @@ public void setSubtitle(@NotNull ServerAPIComponent component) {
    * @param size      The size of the subtitle
    */
   public void setSubtitle(@NotNull ServerAPIComponent component, double size) {
-    this.setSubtitleInternal(Subtitle.create(this.uniqueId, component, size));
+    this.setSubtitle(Subtitle.create(this.uniqueId, component, size));
   }
 
   /**
    * Resets the subtitle of the player and sends it to all other online players
    */
   public void resetSubtitle() {
-    this.setSubtitleInternal(null);
+    this.setSubtitle((Subtitle) null);
+  }
+
+  /**
+   * Sends the provided interaction menu entries to the player
+   *
+   * @param entries The entries to send
+   */
+  public void sendInteractionMenuEntries(@NotNull InteractionMenuEntry... entries) {
+    this.sendLabyModPacket(new InteractionMenuPacket(entries));
+  }
+
+  /**
+   * Sends the provided interaction menu entries to the player
+   *
+   * @param entries The entries to send
+   */
+  public void sendInteractionMenuEntries(@NotNull List<InteractionMenuEntry> entries) {
+    this.sendLabyModPacket(new InteractionMenuPacket(entries));
+  }
+
+  /**
+   * Sends the provided game mode to the LabyMod Chat friends of the player
+   *
+   * @param gameMode The game mode to send or {@code null} to unset
+   */
+  public void sendPlayingGameMode(@Nullable String gameMode) {
+    this.sendLabyModPacket(new PlayingGameModePacket(gameMode));
+  }
+
+  /**
+   * Sends the provided discord rpc to the player
+   *
+   * @param discordRPC The discord rpc to send
+   */
+  public void sendDiscordRPC(@NotNull DiscordRPC discordRPC) {
+    this.sendLabyModPacket(new DiscordRPCPacket(discordRPC));
   }
 
+  /**
+   * Sends the provided icon url as tab list banner to the player
+   *
+   * @param iconUrl The icon url to send or {@code null} to unset the banner
+   */
+  public void sendTabListBanner(@Nullable String iconUrl) {
+    this.sendLabyModPacket(new TabListBannerPacket(iconUrl));
+  }
+
+  /**
+   * Sends the provided packet to the player
+   *
+   * @param packet The packet to send
+   */
   public void sendPacket(@NotNull Packet packet) {
     Class<? extends Packet> packetClass = packet.getClass();
     for (Protocol protocol : this.protocolService.registry().getProtocols()) {
@@ -237,41 +328,6 @@ public void openServerSwitchPrompt(
     );
   }
 
-  protected void setSubtitleInternal(@Nullable Subtitle subtitle) {
-    if (Objects.equals(this.subtitle, subtitle)) {
-      return;
-    }
-
-    this.subtitle = subtitle;
-
-    List<Subtitle> subtitles = new ArrayList<>();
-    if (subtitle == null) {
-      subtitle = Subtitle.create(this.uniqueId, null);
-      subtitles.add(subtitle);
-    }
-
-    LabyModProtocol labyModProtocol = this.protocolService.labyModProtocol();
-    SubtitlePacket packet = new SubtitlePacket(subtitle);
-    for (AbstractLabyModPlayer<?> player : this.protocolService.getPlayers()) {
-      Subtitle playerSubtitle = player.getSubtitle();
-      if (playerSubtitle != null) {
-        subtitles.add(playerSubtitle);
-      }
-
-      if (player.equals(this)) {
-        continue;
-      }
-
-      labyModProtocol.sendPacket(player.getUniqueId(), packet);
-    }
-
-    if (subtitles.isEmpty()) {
-      return;
-    }
-
-    this.sendLabyModPacket(new SubtitlePacket(subtitles));
-  }
-
   private void sendLabyModPacket(@NotNull Packet packet) {
     this.protocolService.labyModProtocol.sendPacket(this.uniqueId, packet);
   }

core/src/main/java/net/labymod/serverapi/core/model/feature/DiscordRPC.java

@@ -0,0 +1,97 @@
+package net.labymod.serverapi.core.model.feature;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Objects;
+
+public class DiscordRPC {
+
+  private static final DiscordRPC RESET = new DiscordRPC(null, 0, 0);
+
+  private final String gameMode;
+  private final long startTime;
+  private final long endTime;
+
+  protected DiscordRPC(@Nullable String gameMode, long startTime, long endTime) {
+    if (startTime < 0) {
+      throw new IllegalArgumentException("startTime cannot be negative");
+    }
+    if (endTime < 0) {
+      throw new IllegalArgumentException("endTime cannot be negative");
+    }
+
+    this.gameMode = gameMode;
+    this.startTime = startTime;
+    this.endTime = endTime;
+  }
+
+  public static DiscordRPC createReset() {
+    return RESET;
+  }
+
+  public static DiscordRPC create(@NotNull String gameMode) {
+    Objects.requireNonNull(gameMode, "GameMode cannot be null");
+    return new DiscordRPC(gameMode, 0, 0);
+  }
+
+  public static DiscordRPC createWithStart(@NotNull String gameMode, long startTime) {
+    Objects.requireNonNull(gameMode, "GameMode cannot be null");
+    return new DiscordRPC(gameMode, startTime, 0);
+  }
+
+  public static DiscordRPC createWithEnd(@NotNull String gameMode, long endTime) {
+    Objects.requireNonNull(gameMode, "GameMode cannot be null");
+    return new DiscordRPC(gameMode, 0, endTime);
+  }
+
+  public @Nullable String getGameMode() {
+    return this.gameMode;
+  }
+
+  public long getStartTime() {
+    return this.startTime;
+  }
+
+  public long getEndTime() {
+    return this.endTime;
+  }
+
+  public boolean hasGameMode() {
+    return this.gameMode != null;
+  }
+
+  public boolean hasStartTime() {
+    return this.startTime != 0;
+  }
+
+  public boolean hasEndTime() {
+    return this.endTime != 0;
+  }
+
+  @Override
+  public String toString() {
+    return "DiscordRPC{" +
+        "gameMode='" + this.gameMode + '\'' +
+        ", startTime=" + this.startTime +
+        ", endTime=" + this.endTime +
+        '}';
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+    if (!(o instanceof DiscordRPC that)) {
+      return false;
+    }
+    return this.startTime == that.startTime && this.endTime == that.endTime && Objects.equals(
+        this.gameMode, that.gameMode);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(this.gameMode, this.startTime, this.endTime);
+  }
+}

core/src/main/java/net/labymod/serverapi/core/model/feature/Emote.java

@@ -40,10 +40,27 @@ protected Emote(@NotNull UUID uniqueId, int emoteId) {
     this.emoteId = emoteId;
   }
 
-  public static Emote create(@NotNull UUID uniqueId, int emoteId) {
+  /**
+   * Plays the emote for the supplied npc.
+   *
+   * @param uniqueId The unique id of the npc.
+   * @param emoteId  The emote id.
+   * @return The emote instance.
+   */
+  public static Emote play(@NotNull UUID uniqueId, int emoteId) {
     return new Emote(uniqueId, emoteId);
   }
 
+  /**
+   * Stops the current emote for the supplied npc.
+   *
+   * @param uniqueId The unique id of the npc.
+   * @return The emote instance.
+   */
+  public static Emote stop(@NotNull UUID uniqueId) {
+    return new Emote(uniqueId, -1);
+  }
+
   public @NotNull UUID getUniqueId() {
     return this.uniqueId;
   }
@@ -52,6 +69,10 @@ public int getEmoteId() {
     return this.emoteId;
   }
 
+  public boolean isStop() {
+    return this.emoteId == -1;
+  }
+
   @Override
   public boolean equals(Object o) {
     if (this == o) {