mirror of https://github.com/PaperMC/Paper.git
192 lines
8.0 KiB
Diff
192 lines
8.0 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: Jake Potrebic <jake.m.potrebic@gmail.com>
|
|
Date: Thu, 4 Nov 2021 12:31:45 -0700
|
|
Subject: [PATCH] Improve scoreboard entries
|
|
|
|
|
|
diff --git a/src/main/java/org/bukkit/scoreboard/Objective.java b/src/main/java/org/bukkit/scoreboard/Objective.java
|
|
index 474274fdffe4041bf4bfb146fcc66424eb5be78a..b236d19d4e4e4f9def610bae8a0c7d222fe2241b 100644
|
|
--- a/src/main/java/org/bukkit/scoreboard/Objective.java
|
|
+++ b/src/main/java/org/bukkit/scoreboard/Objective.java
|
|
@@ -151,9 +151,8 @@ public interface Objective {
|
|
* @throws IllegalArgumentException if player is null
|
|
* @throws IllegalStateException if this objective has been unregistered
|
|
* @see #getScore(String)
|
|
- * @deprecated Scoreboards can contain entries that aren't players
|
|
*/
|
|
- @Deprecated
|
|
+ // @Deprecated // Paper
|
|
@NotNull
|
|
Score getScore(@NotNull OfflinePlayer player) throws IllegalArgumentException, IllegalStateException;
|
|
|
|
@@ -168,4 +167,16 @@ public interface Objective {
|
|
*/
|
|
@NotNull
|
|
Score getScore(@NotNull String entry) throws IllegalArgumentException, IllegalStateException;
|
|
+
|
|
+ // Paper start
|
|
+ /**
|
|
+ * Gets an entity's Score for an Objective on this Scoreboard.
|
|
+ *
|
|
+ * @param entity Entity for the Score
|
|
+ * @return Score tracking the Objective and entity specified
|
|
+ * @throws IllegalArgumentException if entity is null
|
|
+ * @throws IllegalStateException if this objective has been unregistered
|
|
+ */
|
|
+ @NotNull Score getScoreFor(@NotNull org.bukkit.entity.Entity entity) throws IllegalArgumentException, IllegalStateException;
|
|
+ // Paper end
|
|
}
|
|
diff --git a/src/main/java/org/bukkit/scoreboard/Scoreboard.java b/src/main/java/org/bukkit/scoreboard/Scoreboard.java
|
|
index ef3e729caf430b08cdf2d680d5a137a1ba56c1c5..880b20bf25f74e9cb54ff3fb282a5b74db6a0a85 100644
|
|
--- a/src/main/java/org/bukkit/scoreboard/Scoreboard.java
|
|
+++ b/src/main/java/org/bukkit/scoreboard/Scoreboard.java
|
|
@@ -265,9 +265,8 @@ public interface Scoreboard {
|
|
* @return immutable set of all scores tracked for the player
|
|
* @throws IllegalArgumentException if player is null
|
|
* @see #getScores(String)
|
|
- * @deprecated Scoreboards can contain entries that aren't players
|
|
*/
|
|
- @Deprecated
|
|
+ // @Deprecated // Paper
|
|
@NotNull
|
|
Set<Score> getScores(@NotNull OfflinePlayer player) throws IllegalArgumentException;
|
|
|
|
@@ -287,9 +286,8 @@ public interface Scoreboard {
|
|
* @param player the player to drop all current scores for
|
|
* @throws IllegalArgumentException if player is null
|
|
* @see #resetScores(String)
|
|
- * @deprecated Scoreboards can contain entries that aren't players
|
|
*/
|
|
- @Deprecated
|
|
+ // @Deprecated // Paper
|
|
void resetScores(@NotNull OfflinePlayer player) throws IllegalArgumentException;
|
|
|
|
/**
|
|
@@ -307,9 +305,8 @@ public interface Scoreboard {
|
|
* @return the player's Team or null if the player is not on a team
|
|
* @throws IllegalArgumentException if player is null
|
|
* @see #getEntryTeam(String)
|
|
- * @deprecated Scoreboards can contain entries that aren't players
|
|
*/
|
|
- @Deprecated
|
|
+ // @Deprecated // Paper
|
|
@Nullable
|
|
Team getPlayerTeam(@NotNull OfflinePlayer player) throws IllegalArgumentException;
|
|
|
|
@@ -378,4 +375,35 @@ public interface Scoreboard {
|
|
* @throws IllegalArgumentException if slot is null
|
|
*/
|
|
void clearSlot(@NotNull DisplaySlot slot) throws IllegalArgumentException;
|
|
+
|
|
+ // Paper start
|
|
+ /**
|
|
+ * Gets all scores for a entity on this Scoreboard
|
|
+ *
|
|
+ * @param entity the entity whose scores are being retrieved
|
|
+ * @return immutable set of all scores tracked for the entity
|
|
+ * @throws IllegalArgumentException if entity is null
|
|
+ * @see #getScores(String)
|
|
+ */
|
|
+ @NotNull Set<Score> getScoresFor(@NotNull org.bukkit.entity.Entity entity) throws IllegalArgumentException;
|
|
+
|
|
+ /**
|
|
+ * Removes all scores for a entity on this Scoreboard
|
|
+ *
|
|
+ * @param entity the entity to drop all current scores for
|
|
+ * @throws IllegalArgumentException if entity is null
|
|
+ * @see #resetScores(String)
|
|
+ */
|
|
+ void resetScoresFor(@NotNull org.bukkit.entity.Entity entity) throws IllegalArgumentException;
|
|
+
|
|
+ /**
|
|
+ * Gets a entity's Team on this Scoreboard
|
|
+ *
|
|
+ * @param entity the entity to search for
|
|
+ * @return the entity's Team or null if the entity is not on a team
|
|
+ * @throws IllegalArgumentException if entity is null
|
|
+ * @see #getEntryTeam(String)
|
|
+ */
|
|
+ @Nullable Team getEntityTeam(@NotNull org.bukkit.entity.Entity entity) throws IllegalArgumentException;
|
|
+ // Paper end
|
|
}
|
|
diff --git a/src/main/java/org/bukkit/scoreboard/Team.java b/src/main/java/org/bukkit/scoreboard/Team.java
|
|
index 47b10df619ad2520b9bb673e2220f36391680f1b..cbc82a03c24f746b913b30f14ecb0c08cdb42c24 100644
|
|
--- a/src/main/java/org/bukkit/scoreboard/Team.java
|
|
+++ b/src/main/java/org/bukkit/scoreboard/Team.java
|
|
@@ -308,9 +308,8 @@ public interface Team {
|
|
* @throws IllegalArgumentException if player is null
|
|
* @throws IllegalStateException if this team has been unregistered
|
|
* @see #addEntry(String)
|
|
- * @deprecated Teams can contain entries that aren't players
|
|
*/
|
|
- @Deprecated
|
|
+ // @Deprecated // Paper
|
|
void addPlayer(@NotNull OfflinePlayer player) throws IllegalStateException, IllegalArgumentException;
|
|
|
|
/**
|
|
@@ -332,9 +331,8 @@ public interface Team {
|
|
* @throws IllegalArgumentException if player is null
|
|
* @throws IllegalStateException if this team has been unregistered
|
|
* @see #removeEntry(String)
|
|
- * @deprecated Teams can contain entries that aren't players
|
|
*/
|
|
- @Deprecated
|
|
+ // @Deprecated // Paper
|
|
boolean removePlayer(@NotNull OfflinePlayer player) throws IllegalStateException, IllegalArgumentException;
|
|
|
|
/**
|
|
@@ -362,9 +360,8 @@ public interface Team {
|
|
* @throws IllegalArgumentException if player is null
|
|
* @throws IllegalStateException if this team has been unregistered
|
|
* @see #hasEntry(String)
|
|
- * @deprecated Teams can contain entries that aren't players
|
|
*/
|
|
- @Deprecated
|
|
+ // @Deprecated // Paper
|
|
boolean hasPlayer(@NotNull OfflinePlayer player) throws IllegalArgumentException, IllegalStateException;
|
|
/**
|
|
* Checks to see if the specified entry is a member of this team.
|
|
@@ -395,6 +392,42 @@ public interface Team {
|
|
*/
|
|
void setOption(@NotNull Option option, @NotNull OptionStatus status) throws IllegalStateException;
|
|
|
|
+ // Paper start
|
|
+ /**
|
|
+ * This puts the specified entity onto this team for the scoreboard.
|
|
+ * <p>
|
|
+ * This will remove the entity from any other team on the scoreboard.
|
|
+ *
|
|
+ * @param entity the entity to add
|
|
+ * @throws IllegalArgumentException if entity is null
|
|
+ * @throws IllegalStateException if this team has been unregistered
|
|
+ * @see #addEntry(String)
|
|
+ */
|
|
+ void addEntity(@NotNull org.bukkit.entity.Entity entity) throws IllegalStateException, IllegalArgumentException;
|
|
+
|
|
+ /**
|
|
+ * Removes the entity from this team.
|
|
+ *
|
|
+ * @param entity the entity to remove
|
|
+ * @return if the entity was on this team
|
|
+ * @throws IllegalArgumentException if entity is null
|
|
+ * @throws IllegalStateException if this team has been unregistered
|
|
+ * @see #removeEntry(String)
|
|
+ */
|
|
+ boolean removeEntity(@NotNull org.bukkit.entity.Entity entity) throws IllegalStateException, IllegalArgumentException;
|
|
+
|
|
+ /**
|
|
+ * Checks to see if the specified entity is a member of this team.
|
|
+ *
|
|
+ * @param entity the entity to search for
|
|
+ * @return true if the entity is a member of this team
|
|
+ * @throws IllegalArgumentException if entity is null
|
|
+ * @throws IllegalStateException if this team has been unregistered
|
|
+ * @see #hasEntry(String)
|
|
+ */
|
|
+ boolean hasEntity(@NotNull org.bukkit.entity.Entity entity) throws IllegalStateException, IllegalArgumentException;
|
|
+ // Paper end
|
|
+
|
|
/**
|
|
* Represents an option which may be applied to this team.
|
|
*/
|