Package org.bukkit.scoreboard
Interface Scoreboard
public interface Scoreboard
A scoreboard
-
Method Summary
Modifier and Type Method Description void
clearSlot(DisplaySlot slot)
Clears any objective in the specified slot.Set<String>
getEntries()
Gets all entries tracked by this ScoreboardTeam
getEntryTeam(String entry)
Gets a entries Team on this ScoreboardObjective
getObjective(String name)
Gets an Objective on this Scoreboard by nameObjective
getObjective(DisplaySlot slot)
Gets the Objective currently displayed in a DisplaySlot on this ScoreboardSet<Objective>
getObjectives()
Gets all Objectives on this ScoreboardSet<Objective>
getObjectivesByCriteria(String criteria)
Gets all Objectives of a Criteria on the ScoreboardSet<OfflinePlayer>
getPlayers()
Deprecated.Scoreboards can contain entries that aren't playersTeam
getPlayerTeam(OfflinePlayer player)
Deprecated.Scoreboards can contain entries that aren't playersSet<Score>
getScores(String entry)
Gets all scores for an entry on this ScoreboardSet<Score>
getScores(OfflinePlayer player)
Deprecated.Scoreboards can contain entries that aren't playersTeam
getTeam(String teamName)
Gets a Team by name on this ScoreboardSet<Team>
getTeams()
Gets all teams on this ScoreboardObjective
registerNewObjective(String name, String criteria)
Deprecated.a displayName should be explicitly specifiedObjective
registerNewObjective(String name, String criteria, String displayName)
Registers an Objective on this ScoreboardObjective
registerNewObjective(String name, String criteria, String displayName, RenderType renderType)
Registers an Objective on this ScoreboardTeam
registerNewTeam(String name)
Registers a Team on this Scoreboardvoid
resetScores(String entry)
Removes all scores for an entry on this Scoreboardvoid
resetScores(OfflinePlayer player)
Deprecated.Scoreboards can contain entries that aren't players
-
Method Details
-
registerNewObjective
@Deprecated @NotNull Objective registerNewObjective(@NotNull String name, @NotNull String criteria) throws IllegalArgumentExceptionDeprecated.a displayName should be explicitly specifiedRegisters an Objective on this Scoreboard- Parameters:
name
- Name of the Objectivecriteria
- Criteria for the Objective- Returns:
- The registered Objective
- Throws:
IllegalArgumentException
- if name is nullIllegalArgumentException
- if name is longer than 16 characters.IllegalArgumentException
- if criteria is nullIllegalArgumentException
- if an objective by that name already exists
-
registerNewObjective
@NotNull Objective registerNewObjective(@NotNull String name, @NotNull String criteria, @NotNull String displayName) throws IllegalArgumentExceptionRegisters an Objective on this Scoreboard- Parameters:
name
- Name of the Objectivecriteria
- Criteria for the ObjectivedisplayName
- Name displayed to players for the Objective.- Returns:
- The registered Objective
- Throws:
IllegalArgumentException
- if name is nullIllegalArgumentException
- if name is longer than 16 characters.IllegalArgumentException
- if criteria is nullIllegalArgumentException
- if displayName is nullIllegalArgumentException
- if displayName is longer than 128 characters.IllegalArgumentException
- if an objective by that name already exists
-
registerNewObjective
@NotNull Objective registerNewObjective(@NotNull String name, @NotNull String criteria, @NotNull String displayName, @NotNull RenderType renderType) throws IllegalArgumentExceptionRegisters an Objective on this Scoreboard- Parameters:
name
- Name of the Objectivecriteria
- Criteria for the ObjectivedisplayName
- Name displayed to players for the Objective.renderType
- Manner of rendering the Objective- Returns:
- The registered Objective
- Throws:
IllegalArgumentException
- if name is nullIllegalArgumentException
- if name is longer than 16 characters.IllegalArgumentException
- if criteria is nullIllegalArgumentException
- if displayName is nullIllegalArgumentException
- if displayName is longer than 128 characters.IllegalArgumentException
- if renderType is nullIllegalArgumentException
- if an objective by that name already exists
-
getObjective
Gets an Objective on this Scoreboard by name- Parameters:
name
- Name of the Objective- Returns:
- the Objective or null if it does not exist
- Throws:
IllegalArgumentException
- if name is null
-
getObjectivesByCriteria
@NotNull Set<Objective> getObjectivesByCriteria(@NotNull String criteria) throws IllegalArgumentExceptionGets all Objectives of a Criteria on the Scoreboard- Parameters:
criteria
- Criteria to search by- Returns:
- an immutable set of Objectives using the specified Criteria
- Throws:
IllegalArgumentException
- if criteria is null
-
getObjectives
Gets all Objectives on this Scoreboard- Returns:
- An immutable set of all Objectives on this Scoreboard
-
getObjective
Gets the Objective currently displayed in a DisplaySlot on this Scoreboard- Parameters:
slot
- The DisplaySlot- Returns:
- the Objective currently displayed or null if nothing is displayed in that DisplaySlot
- Throws:
IllegalArgumentException
- if slot is null
-
getScores
@Deprecated @NotNull Set<Score> getScores(@NotNull OfflinePlayer player) throws IllegalArgumentExceptionDeprecated.Scoreboards can contain entries that aren't playersGets all scores for a player on this Scoreboard- Parameters:
player
- the player whose scores are being retrieved- Returns:
- immutable set of all scores tracked for the player
- Throws:
IllegalArgumentException
- if player is null- See Also:
getScores(String)
-
getScores
Gets all scores for an entry on this Scoreboard- Parameters:
entry
- the entry whose scores are being retrieved- Returns:
- immutable set of all scores tracked for the entry
- Throws:
IllegalArgumentException
- if entry is null
-
resetScores
Deprecated.Scoreboards can contain entries that aren't playersRemoves all scores for a player on this Scoreboard- Parameters:
player
- the player to drop all current scores for- Throws:
IllegalArgumentException
- if player is null- See Also:
resetScores(String)
-
resetScores
Removes all scores for an entry on this Scoreboard- Parameters:
entry
- the entry to drop all current scores for- Throws:
IllegalArgumentException
- if entry is null
-
getPlayerTeam
@Deprecated @Nullable Team getPlayerTeam(@NotNull OfflinePlayer player) throws IllegalArgumentExceptionDeprecated.Scoreboards can contain entries that aren't playersGets a player's Team on this Scoreboard- Parameters:
player
- the player to search for- Returns:
- the player's Team or null if the player is not on a team
- Throws:
IllegalArgumentException
- if player is null- See Also:
getEntryTeam(String)
-
getEntryTeam
Gets a entries Team on this Scoreboard- Parameters:
entry
- the entry to search for- Returns:
- the entries Team or null if the entry is not on a team
- Throws:
IllegalArgumentException
- if entry is null
-
getTeam
Gets a Team by name on this Scoreboard- Parameters:
teamName
- Team name- Returns:
- the matching Team or null if no matches
- Throws:
IllegalArgumentException
- if teamName is null
-
getTeams
Gets all teams on this Scoreboard- Returns:
- an immutable set of Teams
-
registerNewTeam
Registers a Team on this Scoreboard- Parameters:
name
- Team name- Returns:
- registered Team
- Throws:
IllegalArgumentException
- if name is nullIllegalArgumentException
- if team by that name already exists
-
getPlayers
Deprecated.Scoreboards can contain entries that aren't playersGets all players tracked by this Scoreboard- Returns:
- immutable set of all tracked players
- See Also:
getEntries()
-
getEntries
Gets all entries tracked by this Scoreboard- Returns:
- immutable set of all tracked entries
-
clearSlot
Clears any objective in the specified slot.- Parameters:
slot
- the slot to remove objectives- Throws:
IllegalArgumentException
- if slot is null
-