Fix and add new scoreboard API (#10037)

2024-12-28 15:30:19 +01:00 · 2023-12-23 11:53:07 -08:00 · 2023-12-23 11:53:07 -08:00 · 0c9b5e23ab
commit 0c9b5e23ab
parent e93ec8f95d
4 changed files with 209 additions and 3 deletions
--- a/patches/api/Add-more-scoreboard-API.patch
+++ b/patches/api/Add-more-scoreboard-API.patch
@ -0,0 +1,90 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: Jake Potrebic <jake.m.potrebic@gmail.com>
+Date: Sat, 16 Dec 2023 14:45:46 -0800
+Subject: [PATCH] Add more scoreboard API
+
+
+diff --git a/src/main/java/org/bukkit/scoreboard/Objective.java b/src/main/java/org/bukkit/scoreboard/Objective.java
+index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
+--- a/src/main/java/org/bukkit/scoreboard/Objective.java
+++ b/src/main/java/org/bukkit/scoreboard/Objective.java
+@@ -0,0 +0,0 @@ public interface Objective {
+      */
+     @NotNull Score getScoreFor(@NotNull org.bukkit.entity.Entity entity) throws IllegalArgumentException, IllegalStateException;
+     // Paper end - improve scoreboard entries
+
+    // Paper start - add more score API
+    /**
+     * Gets if this objective will auto update score
+     * displays on changes.
+     *
+     * @return true if auto updating
+     * @throws IllegalStateException if this objective has been unregistered
+     */
+    boolean willAutoUpdateDisplay();
+
+    /**
+     * Sets if this objective will auto update
+     * score displays on changes.
+     *
+     * @param autoUpdateDisplay true to auto update
+     * @throws IllegalStateException if this objective has been unregistered
+     */
+    void setAutoUpdateDisplay(boolean autoUpdateDisplay);
+    // Paper end - add more score API
+ }
+diff --git a/src/main/java/org/bukkit/scoreboard/Score.java b/src/main/java/org/bukkit/scoreboard/Score.java
+index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
+--- a/src/main/java/org/bukkit/scoreboard/Score.java
+++ b/src/main/java/org/bukkit/scoreboard/Score.java
+@@ -0,0 +0,0 @@ public interface Score {
+      */
+     void resetScore() throws IllegalStateException;
+     // Paper end
+
+    // Paper start - add more score API
+    /**
+     * Gets if this score is triggerable and cannot
+     * be used by the {@code /trigger} command executed
+     * by the owner of this score.
+     *
+     * @return true if triggerable, false if not triggerable, score isn't set, or the objective isn't {@link Criteria#TRIGGER}
+     * @throws IllegalStateException if the associated objective has been unregistered
+     */
+    boolean isTriggerable();
+
+    /**
+     * Sets if this score is triggerable and can
+     * be used by the {@code /trigger} command
+     * executed by the owner of this score. Can
+     * only be set on {@link Criteria#TRIGGER} objectives.
+     * <p>
+     * If the score doesn't exist (aka {@link #isScoreSet()} returns false),
+     * this will create the score with a 0 value.
+     *
+     * @param triggerable true to enable trigger, false to disable
+     * @throws IllegalArgumentException if this objective isn't {@link Criteria#TRIGGER}
+     * @throws IllegalStateException if the associated objective has been unregistered
+     */
+    void setTriggerable(boolean triggerable);
+
+    /**
+     * Get the custom name for this entry.
+     *
+     * @return the custom name or null if not set (or score isn't set)
+     * @throws IllegalStateException if the associated objective has been unregistered
+     */
+    @Nullable net.kyori.adventure.text.Component customName();
+
+    /**
+     * Sets the custom name for this entry.
+     * <p>
+     * If the score doesn't exist (aka {@link #isScoreSet()} returns false),
+     * this will create the score with a 0 value.
+     *
+     * @param customName the custom name or null to reset
+     * @throws IllegalStateException if the associated objective has been unregistered
+     */
+    void customName(net.kyori.adventure.text.@Nullable Component customName);
+    // Paper end - add more score API
+ }
--- a/patches/server/Fix-scoreboard-entries.patch
+++ b/patches/server/Fix-scoreboard-entries.patch
@ -0,0 +1,36 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: Jake Potrebic <jake.m.potrebic@gmail.com>
+Date: Sat, 16 Dec 2023 13:06:20 -0800
+Subject: [PATCH] Fix scoreboard entries
+
+1.20.3/4 introduced ScoreHolder which broke a lot of existing
+logic that just assumed score entries were strings.
+
+diff --git a/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftScore.java b/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftScore.java
+index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
+--- a/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftScore.java
+++ b/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftScore.java
+@@ -0,0 +0,0 @@ final class CraftScore implements Score {
+     public int getScore() {
+         Scoreboard board = this.objective.checkState().board;
+ 
+-        if (board.getTrackedPlayers().contains(this.entry)) { // Lazy
+        // if (board.getTrackedPlayers().contains(this.entry)) { // Lazy // Paper - just use the null check
+             ReadOnlyScoreInfo score = board.getPlayerScoreInfo(this.entry, this.objective.getHandle());
+             if (score != null) { // Lazy
+                 return score.value();
+             }
+-        }
+        // } // Paper - just use the null check above
+ 
+         return 0; // Lazy
+     }
+@@ -0,0 +0,0 @@ final class CraftScore implements Score {
+     public boolean isScoreSet() {
+         Scoreboard board = this.objective.checkState().board;
+ 
+-        return board.getTrackedPlayers().contains(this.entry) && board.getPlayerScoreInfo(this.entry, this.objective.getHandle()) != null;
+        return /*board.getTrackedPlayers().contains(this.entry) && */board.getPlayerScoreInfo(this.entry, this.objective.getHandle()) != null; // Paper - just check if the player score info exists
+     }
+ 
+     @Override
--- a/patches/server/Improve-scoreboard-entries.patch
+++ b/patches/server/Improve-scoreboard-entries.patch
@ -16,7 +16,8 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +    @Override
 +    public Score getScoreFor(org.bukkit.entity.Entity entity) throws IllegalArgumentException, IllegalStateException {
 +        Preconditions.checkArgument(entity != null, "Entity cannot be null");
-+        return getScore(((org.bukkit.craftbukkit.entity.CraftEntity) entity).getHandle().getScoreboardName());
+        this.checkState();
+        return new CraftScore(this, ((org.bukkit.craftbukkit.entity.CraftEntity) entity).getHandle());
 +    }
 +    // Paper end
 +
@ -35,13 +36,13 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
 +    @Override
 +    public ImmutableSet<Score> getScoresFor(org.bukkit.entity.Entity entity) throws IllegalArgumentException {
 +        Preconditions.checkArgument(entity != null, "Entity cannot be null");
-+        return this.getScores(((org.bukkit.craftbukkit.entity.CraftEntity) entity).getHandle().getScoreboardName());
+        return this.getScores(((org.bukkit.craftbukkit.entity.CraftEntity) entity).getHandle());
 +    }
 +
 +    @Override
 +    public void resetScoresFor(org.bukkit.entity.Entity entity) throws IllegalArgumentException {
 +        Preconditions.checkArgument(entity != null, "Entity cannot be null");
-+        this.resetScores(((org.bukkit.craftbukkit.entity.CraftEntity) entity).getHandle().getScoreboardName());
+        this.resetScores(((org.bukkit.craftbukkit.entity.CraftEntity) entity).getHandle());
 +    }
 +
 +    @Override
--- a/patches/server/add-more-scoreboard-API.patch
+++ b/patches/server/add-more-scoreboard-API.patch
@ -0,0 +1,79 @@
+From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
+From: Jake Potrebic <jake.m.potrebic@gmail.com>
+Date: Sat, 16 Dec 2023 14:46:01 -0800
+Subject: [PATCH] add more scoreboard API
+
+
+diff --git a/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftObjective.java b/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftObjective.java
+index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
+--- a/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftObjective.java
+++ b/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftObjective.java
+@@ -0,0 +0,0 @@ final class CraftObjective extends CraftScoreboardComponent implements Objective
+         final CraftObjective other = (CraftObjective) obj;
+         return !(this.objective != other.objective && (this.objective == null || !this.objective.equals(other.objective)));
+     }
+    // Paper start - add more score API
+    @Override
+    public boolean willAutoUpdateDisplay() {
+        this.checkState();
+        return this.objective.displayAutoUpdate();
+    }
+
+    @Override
+    public void setAutoUpdateDisplay(final boolean autoUpdateDisplay) {
+        this.checkState();
+        this.objective.setDisplayAutoUpdate(autoUpdateDisplay);
+    }
+    // Paper end - add more score API
+ 
+ 
+ }
+diff --git a/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftScore.java b/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftScore.java
+index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
+--- a/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftScore.java
+++ b/src/main/java/org/bukkit/craftbukkit/scoreboard/CraftScore.java
+@@ -0,0 +0,0 @@ final class CraftScore implements Score {
+         board.resetSinglePlayerScore(entry, this.objective.getHandle());
+     }
+     // Paper end
+
+    // Paper start - add more score API
+    @Override
+    public boolean isTriggerable() {
+        if (this.objective.getTrackedCriteria() != org.bukkit.scoreboard.Criteria.TRIGGER) {
+            return false;
+        }
+        final Scoreboard board = this.objective.checkState().board;
+        final ReadOnlyScoreInfo scoreInfo = board.getPlayerScoreInfo(this.entry, this.objective.getHandle());
+        return scoreInfo != null && !scoreInfo.isLocked();
+    }
+
+    @Override
+    public void setTriggerable(final boolean triggerable) {
+        com.google.common.base.Preconditions.checkArgument(this.objective.getTrackedCriteria() == org.bukkit.scoreboard.Criteria.TRIGGER, "the criteria isn't 'trigger'");
+        final Scoreboard board = this.objective.checkState().board;
+        if (triggerable) {
+            board.getOrCreatePlayerScore(this.entry, this.objective.getHandle()).unlock();
+        } else {
+            board.getOrCreatePlayerScore(this.entry, this.objective.getHandle()).lock();
+        }
+    }
+
+    @Override
+    public net.kyori.adventure.text.Component customName() {
+        final Scoreboard board = this.objective.checkState().board;
+        final ReadOnlyScoreInfo scoreInfo = board.getPlayerScoreInfo(this.entry, this.objective.getHandle());
+        if (scoreInfo == null) {
+            return null; // If score doesn't exist, don't create one
+        }
+        final net.minecraft.network.chat.Component display = board.getOrCreatePlayerScore(this.entry, this.objective.getHandle()).display();
+        return display == null ? null : io.papermc.paper.adventure.PaperAdventure.asAdventure(display);
+    }
+
+    @Override
+    public void customName(final net.kyori.adventure.text.Component customName) {
+        final Scoreboard board = this.objective.checkState().board;
+        board.getOrCreatePlayerScore(this.entry, this.objective.getHandle()).display(io.papermc.paper.adventure.PaperAdventure.asVanilla(customName));
+    }
+    // Paper end - add more score API
+ }