mirror of
https://github.com/PaperMC/Paper.git
synced 2024-12-30 16:19:03 +01:00
Improve scoreboard entries
This commit is contained in:
parent
546372966a
commit
3907f8a544
3 changed files with 86 additions and 14 deletions
|
@ -148,9 +148,8 @@ public interface Objective {
|
||||||
* @return Score tracking the Objective and player specified
|
* @return Score tracking the Objective and player specified
|
||||||
* @throws IllegalStateException if this objective has been unregistered
|
* @throws IllegalStateException if this objective has been unregistered
|
||||||
* @see #getScore(String)
|
* @see #getScore(String)
|
||||||
* @deprecated Scoreboards can contain entries that aren't players
|
|
||||||
*/
|
*/
|
||||||
@Deprecated(since = "1.7.8")
|
// @Deprecated(since = "1.7.8") // Paper
|
||||||
@NotNull
|
@NotNull
|
||||||
Score getScore(@NotNull OfflinePlayer player);
|
Score getScore(@NotNull OfflinePlayer player);
|
||||||
|
|
||||||
|
@ -164,4 +163,16 @@ public interface Objective {
|
||||||
*/
|
*/
|
||||||
@NotNull
|
@NotNull
|
||||||
Score getScore(@NotNull String entry);
|
Score getScore(@NotNull String entry);
|
||||||
|
|
||||||
|
// Paper start - improve scoreboard entries
|
||||||
|
/**
|
||||||
|
* 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 - improve scoreboard entries
|
||||||
}
|
}
|
||||||
|
|
|
@ -215,9 +215,8 @@ public interface Scoreboard {
|
||||||
* @param player the player whose scores are being retrieved
|
* @param player the player whose scores are being retrieved
|
||||||
* @return immutable set of all scores tracked for the player
|
* @return immutable set of all scores tracked for the player
|
||||||
* @see #getScores(String)
|
* @see #getScores(String)
|
||||||
* @deprecated Scoreboards can contain entries that aren't players
|
|
||||||
*/
|
*/
|
||||||
@Deprecated(since = "1.7.8")
|
// @Deprecated(since = "1.7.8") // Paper
|
||||||
@NotNull
|
@NotNull
|
||||||
Set<Score> getScores(@NotNull OfflinePlayer player);
|
Set<Score> getScores(@NotNull OfflinePlayer player);
|
||||||
|
|
||||||
|
@ -235,9 +234,8 @@ public interface Scoreboard {
|
||||||
*
|
*
|
||||||
* @param player the player to drop all current scores for
|
* @param player the player to drop all current scores for
|
||||||
* @see #resetScores(String)
|
* @see #resetScores(String)
|
||||||
* @deprecated Scoreboards can contain entries that aren't players
|
|
||||||
*/
|
*/
|
||||||
@Deprecated(since = "1.7.8")
|
// @Deprecated(since = "1.7.8") // Paper
|
||||||
void resetScores(@NotNull OfflinePlayer player);
|
void resetScores(@NotNull OfflinePlayer player);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -253,9 +251,8 @@ public interface Scoreboard {
|
||||||
* @param player the player to search for
|
* @param player the player to search for
|
||||||
* @return the player's Team or null if the player is not on a team
|
* @return the player's Team or null if the player is not on a team
|
||||||
* @see #getEntryTeam(String)
|
* @see #getEntryTeam(String)
|
||||||
* @deprecated Scoreboards can contain entries that aren't players
|
|
||||||
*/
|
*/
|
||||||
@Deprecated(since = "1.8.6")
|
// @Deprecated(since = "1.8.6") // Paper
|
||||||
@Nullable
|
@Nullable
|
||||||
Team getPlayerTeam(@NotNull OfflinePlayer player);
|
Team getPlayerTeam(@NotNull OfflinePlayer player);
|
||||||
|
|
||||||
|
@ -320,4 +317,35 @@ public interface Scoreboard {
|
||||||
* @param slot the slot to remove objectives
|
* @param slot the slot to remove objectives
|
||||||
*/
|
*/
|
||||||
void clearSlot(@NotNull DisplaySlot slot);
|
void clearSlot(@NotNull DisplaySlot slot);
|
||||||
|
|
||||||
|
// Paper start - improve scoreboard entries
|
||||||
|
/**
|
||||||
|
* Gets all scores for an 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 an 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 an 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 - improve scoreboard entries
|
||||||
}
|
}
|
||||||
|
|
|
@ -295,9 +295,8 @@ public interface Team extends net.kyori.adventure.audience.ForwardingAudience {
|
||||||
* @param player the player to add
|
* @param player the player to add
|
||||||
* @throws IllegalStateException if this team has been unregistered
|
* @throws IllegalStateException if this team has been unregistered
|
||||||
* @see #addEntry(String)
|
* @see #addEntry(String)
|
||||||
* @deprecated Teams can contain entries that aren't players
|
|
||||||
*/
|
*/
|
||||||
@Deprecated(since = "1.8.6")
|
// @Deprecated(since = "1.8.6") // Paper
|
||||||
void addPlayer(@NotNull OfflinePlayer player);
|
void addPlayer(@NotNull OfflinePlayer player);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -317,9 +316,8 @@ public interface Team extends net.kyori.adventure.audience.ForwardingAudience {
|
||||||
* @return if the player was on this team
|
* @return if the player was on this team
|
||||||
* @throws IllegalStateException if this team has been unregistered
|
* @throws IllegalStateException if this team has been unregistered
|
||||||
* @see #removeEntry(String)
|
* @see #removeEntry(String)
|
||||||
* @deprecated Teams can contain entries that aren't players
|
|
||||||
*/
|
*/
|
||||||
@Deprecated(since = "1.8.6")
|
// @Deprecated(since = "1.8.6") // Paper
|
||||||
boolean removePlayer(@NotNull OfflinePlayer player);
|
boolean removePlayer(@NotNull OfflinePlayer player);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -345,9 +343,8 @@ public interface Team extends net.kyori.adventure.audience.ForwardingAudience {
|
||||||
* @return true if the player is a member of this team
|
* @return true if the player is a member of this team
|
||||||
* @throws IllegalStateException if this team has been unregistered
|
* @throws IllegalStateException if this team has been unregistered
|
||||||
* @see #hasEntry(String)
|
* @see #hasEntry(String)
|
||||||
* @deprecated Teams can contain entries that aren't players
|
|
||||||
*/
|
*/
|
||||||
@Deprecated(since = "1.8.6")
|
// @Deprecated(since = "1.8.6") // Paper
|
||||||
boolean hasPlayer(@NotNull OfflinePlayer player);
|
boolean hasPlayer(@NotNull OfflinePlayer player);
|
||||||
/**
|
/**
|
||||||
* Checks to see if the specified entry is a member of this team.
|
* Checks to see if the specified entry is a member of this team.
|
||||||
|
@ -377,6 +374,42 @@ public interface Team extends net.kyori.adventure.audience.ForwardingAudience {
|
||||||
*/
|
*/
|
||||||
void setOption(@NotNull Option option, @NotNull OptionStatus status);
|
void setOption(@NotNull Option option, @NotNull OptionStatus status);
|
||||||
|
|
||||||
|
// Paper start - improve scoreboard entries
|
||||||
|
/**
|
||||||
|
* 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 - improve scoreboard entries
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents an option which may be applied to this team.
|
* Represents an option which may be applied to this team.
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in a new issue