Package org.bukkit.scoreboard

Interface Scoreboard

public interface Scoreboard
A scoreboard

  • Method Details

    • registerNewObjective

      @Deprecated(since="1.13") @NotNull Objective registerNewObjective(@NotNull String name, @NotNull String criteria)
      Deprecated.
      a displayName should be explicitly specified
      Registers an Objective on this Scoreboard
      Parameters:
      name - Name of the Objective
      criteria - Criteria for the Objective
      Returns:
      The registered Objective
      Throws:
      IllegalArgumentException - if name is longer than 32767 characters.
      IllegalArgumentException - if an objective by that name already exists

    • registerNewObjective

      @Deprecated(since="1.20.5") @NotNull Objective registerNewObjective(@NotNull String name, @NotNull String criteria, @NotNull String displayName)
      Deprecated.
      use registerNewObjective(String, Criteria, String)
      Registers an Objective on this Scoreboard
      Parameters:
      name - Name of the Objective
      criteria - Criteria for the Objective
      displayName - Name displayed to players for the Objective.
      Returns:
      The registered Objective
      Throws:
      IllegalArgumentException - if name is longer than 32767 characters.
      IllegalArgumentException - if an objective by that name already exists

    • registerNewObjective

      @Deprecated(since="1.20.5") @NotNull Objective registerNewObjective(@NotNull String name, @NotNull String criteria, @NotNull String displayName, @NotNull RenderType renderType)
      Deprecated.
      use registerNewObjective(String, Criteria, String, RenderType)
      Registers an Objective on this Scoreboard
      Parameters:
      name - Name of the Objective
      criteria - Criteria for the Objective
      displayName - Name displayed to players for the Objective.
      renderType - Manner of rendering the Objective
      Returns:
      The registered Objective
      Throws:
      IllegalArgumentException - if name is longer than 32767 characters.
      IllegalArgumentException - if an objective by that name already exists

    • registerNewObjective

      @NotNull Objective registerNewObjective(@NotNull String name, @NotNull Criteria criteria, @NotNull String displayName)
      Registers an Objective on this Scoreboard
      Parameters:
      name - Name of the Objective
      criteria - Criteria for the Objective
      displayName - Name displayed to players for the Objective.
      Returns:
      The registered Objective
      Throws:
      IllegalArgumentException - if name is longer than 32767 characters.
      IllegalArgumentException - if an objective by that name already exists

    • registerNewObjective

      @NotNull Objective registerNewObjective(@NotNull String name, @NotNull Criteria criteria, @NotNull String displayName, @NotNull RenderType renderType)
      Registers an Objective on this Scoreboard
      Parameters:
      name - Name of the Objective
      criteria - Criteria for the Objective
      displayName - Name displayed to players for the Objective.
      renderType - Manner of rendering the Objective
      Returns:
      The registered Objective
      Throws:
      IllegalArgumentException - if name is longer than 32767 characters.
      IllegalArgumentException - if an objective by that name already exists

    • getObjective

      @Nullable Objective getObjective(@NotNull String name)
      Gets an Objective on this Scoreboard by name
      Parameters:
      name - Name of the Objective
      Returns:
      the Objective or null if it does not exist

    • getObjectivesByCriteria

      @Deprecated(since="1.19.2") @NotNull Set<Objective> getObjectivesByCriteria(@NotNull String criteria)
      Deprecated.
      use getObjectivesByCriteria(Criteria)
      Gets all Objectives of a Criteria on the Scoreboard
      Parameters:
      criteria - Criteria to search by
      Returns:
      an immutable set of Objectives using the specified Criteria

    • getObjectivesByCriteria

      @NotNull Set<Objective> getObjectivesByCriteria(@NotNull Criteria criteria)
      Gets all Objectives of a Criteria on the Scoreboard
      Parameters:
      criteria - Criteria to search by
      Returns:
      an immutable set of Objectives using the specified Criteria

    • getObjectives

      @NotNull Set<Objective> getObjectives()
      Gets all Objectives on this Scoreboard
      Returns:
      An immutable set of all Objectives on this Scoreboard

    • getObjective

      @Nullable Objective getObjective(@NotNull DisplaySlot slot)
      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

    • getScores

      @Deprecated(since="1.7.8") @NotNull Set<Score> getScores(@NotNull OfflinePlayer player)
      Deprecated.
      Scoreboards can contain entries that aren't players
      Gets 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
      See Also:

    • getScores

      @NotNull Set<Score> getScores(@NotNull String entry)
      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

    • resetScores

      @Deprecated(since="1.7.8") void resetScores(@NotNull OfflinePlayer player)
      Deprecated.
      Scoreboards can contain entries that aren't players
      Removes all scores for a player on this Scoreboard
      Parameters:
      player - the player to drop all current scores for
      See Also:

    • resetScores

      void resetScores(@NotNull String entry)
      Removes all scores for an entry on this Scoreboard
      Parameters:
      entry - the entry to drop all current scores for

    • getPlayerTeam

      @Deprecated(since="1.8.6") @Nullable Team getPlayerTeam(@NotNull OfflinePlayer player)
      Deprecated.
      Scoreboards can contain entries that aren't players
      Gets 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
      See Also:

    • getEntryTeam

      @Nullable Team getEntryTeam(@NotNull String entry)
      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

    • getTeam

      @Nullable Team getTeam(@NotNull String teamName)
      Gets a Team by name on this Scoreboard
      Parameters:
      teamName - Team name
      Returns:
      the matching Team or null if no matches

    • getTeams

      @NotNull Set<Team> getTeams()
      Gets all teams on this Scoreboard
      Returns:
      an immutable set of Teams

    • registerNewTeam

      @NotNull Team registerNewTeam(@NotNull String name)
      Registers a Team on this Scoreboard
      Parameters:
      name - Team name
      Returns:
      registered Team
      Throws:
      IllegalArgumentException - if team by that name already exists

    • getPlayers

      @Deprecated(since="1.7.8") @NotNull Set<OfflinePlayer> getPlayers()
      Deprecated.
      Scoreboards can contain entries that aren't players
      Gets all players tracked by this Scoreboard
      Returns:
      immutable set of all tracked players
      See Also:

    • getEntries

      @NotNull Set<String> getEntries()
      Gets all entries tracked by this Scoreboard
      Returns:
      immutable set of all tracked entries

    • clearSlot

      void clearSlot(@NotNull DisplaySlot slot)
      Clears any objective in the specified slot.
      Parameters:
      slot - the slot to remove objectives