Merge pull request #100 from huanmeng-qwq/feat/refresh

Add refresh-related methods

Author: vytskalt

api/src/main/java/net/megavex/scoreboardlibrary/api/noop/NoopScoreboardObjective.java

@@ -52,6 +52,10 @@ public void defaultScoreFormat(@Nullable ScoreFormat defaultScoreFormat) {
     this.defaultScoreFormat = defaultScoreFormat;
   }
 
+  @Override
+  public void refreshProperties() {
+  }
+
   @Override
   public @Nullable ObjectiveScore scoreInfo(@NotNull String entry) {
     return scores.get(entry);
@@ -68,4 +72,8 @@ public void defaultScoreFormat(@Nullable ScoreFormat defaultScoreFormat) {
     scores.remove(entry);
     return this;
   }
+
+  @Override
+  public void refreshScore(@NotNull String entry) {
+  }
 }

api/src/main/java/net/megavex/scoreboardlibrary/api/noop/NoopSidebar.java

@@ -81,6 +81,10 @@ public void line(int index, @Nullable ComponentLike value, @Nullable ScoreFormat
     lines[index] = value == null ? null : value.asComponent();
   }
 
+  @Override
+  public void refreshLine(@Range(from = 0, to = Integer.MAX_VALUE - 1) final int index) {
+
+  }
   @Override
   public @Nullable Component line(int line) {
     checkLineBounds(line);
@@ -100,6 +104,11 @@ public void title(@NotNull ComponentLike title) {
     this.title = title.asComponent();
   }
 
+  @Override
+  public void refreshTitle() {
+
+  }
+
   private void checkClosed() {
     if (closed) {
       throw new IllegalStateException("NoopSidebar is closed");

api/src/main/java/net/megavex/scoreboardlibrary/api/noop/NoopTeamDisplay.java

@@ -140,4 +140,8 @@ public boolean canSeeFriendlyInvisibles() {
     this.playerColor = playerColor;
     return this;
   }
+
+  @Override
+  public void refresh() {
+  }
 }

api/src/main/java/net/megavex/scoreboardlibrary/api/objective/ScoreboardObjective.java

@@ -49,6 +49,11 @@ public interface ScoreboardObjective {
    */
   void defaultScoreFormat(@Nullable ScoreFormat defaultScoreFormat);
 
+  /**
+   * Refreshes the objective's {@link #value()} and {@link #defaultScoreFormat()}, re-rendering any {@link net.kyori.adventure.text.TranslatableComponent}s.
+   */
+  void refreshProperties();
+
   /**
    * Get the score for an entry, or null if the entry has no score.
    *
@@ -141,4 +146,11 @@ public interface ScoreboardObjective {
    * @param entry entry to remove score of
    */
   @NotNull ScoreboardObjective removeScore(@NotNull String entry);
+
+  /**
+   * Refreshes a score, re-rendering any {@link net.kyori.adventure.text.TranslatableComponent}s inside its format.
+   *
+   * @param entry entry to refresh score of
+   */
+  void refreshScore(@NotNull String entry);
 }

api/src/main/java/net/megavex/scoreboardlibrary/api/sidebar/Sidebar.java

@@ -1,18 +1,17 @@
 package net.megavex.scoreboardlibrary.api.sidebar;
 
-import net.kyori.adventure.text.Component;
-import net.kyori.adventure.text.ComponentLike;
 import net.megavex.scoreboardlibrary.api.ScoreboardLibrary;
 import net.megavex.scoreboardlibrary.api.objective.ScoreFormat;
+import java.util.Collection;
+import java.util.Locale;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.ComponentLike;
 import org.bukkit.entity.Player;
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.Range;
 
-import java.util.Collection;
-import java.util.Locale;
-
 /**
  * Represents a sidebar.
  * To get an instance of this interface, use {@link ScoreboardLibrary#createSidebar()}.
@@ -31,7 +30,8 @@ public interface Sidebar {
   /**
    * @return max amount of lines this sidebar can have
    */
-  @Range(from = 1, to = Integer.MAX_VALUE) int maxLines();
+  @Range(from = 1, to = Integer.MAX_VALUE)
+  int maxLines();
 
   /**
    * @return objective name used by this sidebar
@@ -90,6 +90,22 @@ default void clearLines() {
     }
   }
 
+  /**
+   * Refreshes a specific line, re-rendering any {@link net.kyori.adventure.text.TranslatableComponent}s.
+   *
+   * @param index line index
+   */
+  void refreshLine(@Range(from = 0, to = Integer.MAX_VALUE - 1) int index);
+
+  /**
+   * Refreshes all lines in this sidebar, re-rendering any {@link net.kyori.adventure.text.TranslatableComponent}s.
+   */
+  default void refreshLines() {
+    for (int i = 0; i < maxLines(); i++) {
+      refreshLine(i);
+    }
+  }
+
   // Title
 
   /**
@@ -104,6 +120,11 @@ default void clearLines() {
    */
   void title(@NotNull ComponentLike title);
 
+  /**
+   * Refresh the title of the sidebar, re-rendering any {@link net.kyori.adventure.text.TranslatableComponent}s.
+   */
+  void refreshTitle();
+
   // Players
 
   /**

api/src/main/java/net/megavex/scoreboardlibrary/api/team/TeamDisplay.java

@@ -170,4 +170,9 @@ public interface TeamDisplay {
    * @since Minecraft 1.8
    */
   @NotNull TeamDisplay playerColor(@Nullable NamedTextColor playerColor);
+
+  /**
+   * Refreshes the team display, re-rendering any {@link net.kyori.adventure.text.TranslatableComponent}s.
+   */
+  void refresh();
 }

implementation/src/main/java/net/megavex/scoreboardlibrary/implementation/objective/ScoreboardObjectiveImpl.java

@@ -1,19 +1,22 @@
 package net.megavex.scoreboardlibrary.implementation.objective;
 
-import net.kyori.adventure.text.Component;
-import net.kyori.adventure.text.ComponentLike;
 import net.megavex.scoreboardlibrary.api.objective.ObjectiveRenderType;
 import net.megavex.scoreboardlibrary.api.objective.ObjectiveScore;
 import net.megavex.scoreboardlibrary.api.objective.ScoreFormat;
 import net.megavex.scoreboardlibrary.api.objective.ScoreboardObjective;
 import net.megavex.scoreboardlibrary.implementation.packetAdapter.PropertiesPacketType;
 import net.megavex.scoreboardlibrary.implementation.packetAdapter.objective.ObjectivePacketAdapter;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Objects;
+import java.util.Queue;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.ComponentLike;
 import org.bukkit.entity.Player;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-import java.util.*;
-
 import static net.kyori.adventure.text.Component.empty;
 
 public class ScoreboardObjectiveImpl implements ScoreboardObjective {
@@ -95,6 +98,13 @@ public void defaultScoreFormat(@Nullable ScoreFormat defaultScoreFormat) {
     }
   }
 
+  @Override
+  public void refreshProperties() {
+    if (!closed) {
+      taskQueue.add(new ObjectiveManagerTask.UpdateObjective(this));
+    }
+  }
+
   @Override
   public @Nullable ObjectiveScore scoreInfo(@NotNull String entry) {
     return scores.get(entry);
@@ -117,6 +127,14 @@ public void defaultScoreFormat(@Nullable ScoreFormat defaultScoreFormat) {
     return this;
   }
 
+  @Override
+  public void refreshScore(@NotNull String entry) {
+    ObjectiveScore score = scores.get(entry);
+    if (score != null) {
+      taskQueue.add(new ObjectiveManagerTask.UpdateScore(this, entry, score));
+    }
+  }
+
   public void sendProperties(@NotNull Collection<Player> players, @NotNull PropertiesPacketType packetType) {
     packetAdapter.sendProperties(players, packetType, value, renderType, defaultScoreFormat);
   }

implementation/src/main/java/net/megavex/scoreboardlibrary/implementation/sidebar/AbstractSidebar.java

@@ -1,10 +1,6 @@
 package net.megavex.scoreboardlibrary.implementation.sidebar;
 
 import com.google.common.base.Preconditions;
-import net.kyori.adventure.text.Component;
-import net.kyori.adventure.text.ComponentLike;
-import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
-import net.kyori.adventure.translation.GlobalTranslator;
 import net.megavex.scoreboardlibrary.api.objective.ObjectiveDisplaySlot;
 import net.megavex.scoreboardlibrary.api.objective.ObjectiveRenderType;
 import net.megavex.scoreboardlibrary.api.objective.ScoreFormat;
@@ -17,15 +13,22 @@
 import net.megavex.scoreboardlibrary.implementation.player.ScoreboardLibraryPlayer;
 import net.megavex.scoreboardlibrary.implementation.sidebar.line.GlobalLineInfo;
 import net.megavex.scoreboardlibrary.implementation.sidebar.line.LocaleLineHandler;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Objects;
+import java.util.Queue;
+import java.util.Set;
+import java.util.concurrent.ConcurrentLinkedQueue;
+import java.util.function.Consumer;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.ComponentLike;
+import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
+import net.kyori.adventure.translation.GlobalTranslator;
 import org.bukkit.entity.Player;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.Range;
 
-import java.util.*;
-import java.util.concurrent.ConcurrentLinkedQueue;
-import java.util.function.Consumer;
-
 import static net.kyori.adventure.text.Component.empty;
 
 public abstract class AbstractSidebar implements Sidebar, PlayerDisplayable {
@@ -126,6 +129,17 @@ public final void line(@Range(from = 0, to = MAX_LINES - 1) int index, @Nullable
     }
   }
 
+  @Override
+  public void refreshLine(@Range(from = 0, to = Integer.MAX_VALUE - 1) final int index) {
+    checkClosed();
+    GlobalLineInfo line = lines[index];
+    if (line != null) {
+      boolean updateValue = line.value() != null;
+      boolean updateScore = line.scoreFormat() != null;
+      taskQueue.add(new SidebarTask.UpdateLine(index, updateValue, updateScore));
+    }
+  }
+
   @Override
   public final @Nullable Component line(@Range(from = 0, to = MAX_LINES - 1) int line) {
     checkClosed();
@@ -151,6 +165,12 @@ public final void title(@NotNull ComponentLike title) {
     }
   }
 
+  @Override
+  public void refreshTitle() {
+    checkClosed();
+    taskQueue.add(SidebarTask.UpdateTitle.INSTANCE);
+  }
+
   public final @NotNull ScoreboardLibraryImpl scoreboardLibrary() {
     return scoreboardLibrary;
   }

implementation/src/main/java/net/megavex/scoreboardlibrary/implementation/team/TeamDisplayImpl.java

@@ -210,6 +210,11 @@ public boolean canSeeFriendlyInvisibles() {
     return this;
   }
 
+  @Override
+  public void refresh() {
+    scheduleUpdate();
+  }
+
   public @NotNull TeamDisplayPacketAdapter packetAdapter() {
     return packetAdapter;
   }