Package org.bukkit.scoreboard

Interface Objective

public interface Objective
An objective on a scoreboard that can show scores specific to entries. This objective is only relevant to the display of the associated scoreboard.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getCriteria()
    Gets the criteria this objective tracks.
    java.lang.String getDisplayName()
    Gets the name displayed to players for this objective
    DisplaySlot getDisplaySlot()
    Gets the display slot this objective is displayed at.
    java.lang.String getName()
    Gets the name of this Objective
    Score getScore​(java.lang.String entry)
    Gets an entry's Score for an Objective on this Scoreboard.
    Score getScore​(OfflinePlayer player)
    Deprecated.
    Scoreboards can contain entries that aren't players
    Scoreboard getScoreboard()
    Gets the scoreboard to which this objective is attached.
    boolean isModifiable()
    Gets if the objective's scores can be modified directly by a plugin.
    void setDisplayName​(java.lang.String displayName)
    Sets the name displayed to players for this objective.
    void setDisplaySlot​(DisplaySlot slot)
    Sets this objective to display on the specified slot for the scoreboard, removing it from any other display slot.
    void unregister()
    Unregisters this objective from the scoreboard.

  • Method Details

    • getName

      java.lang.String getName() throws java.lang.IllegalStateException
      Gets the name of this Objective
      Returns:
      this objective'ss name
      Throws:
      java.lang.IllegalStateException - if this objective has been unregistered

    • getDisplayName

      java.lang.String getDisplayName() throws java.lang.IllegalStateException
      Gets the name displayed to players for this objective
      Returns:
      this objective's display name
      Throws:
      java.lang.IllegalStateException - if this objective has been unregistered

    • setDisplayName

      void setDisplayName​(java.lang.String displayName) throws java.lang.IllegalStateException, java.lang.IllegalArgumentException
      Sets the name displayed to players for this objective.
      Parameters:
      displayName - Display name to set
      Throws:
      java.lang.IllegalStateException - if this objective has been unregistered
      java.lang.IllegalArgumentException - if displayName is null
      java.lang.IllegalArgumentException - if displayName is longer than 32 characters.

    • getCriteria

      java.lang.String getCriteria() throws java.lang.IllegalStateException
      Gets the criteria this objective tracks.
      Returns:
      this objective's criteria
      Throws:
      java.lang.IllegalStateException - if this objective has been unregistered

    • isModifiable

      boolean isModifiable() throws java.lang.IllegalStateException
      Gets if the objective's scores can be modified directly by a plugin.
      Returns:
      true if scores are modifiable
      Throws:
      java.lang.IllegalStateException - if this objective has been unregistered
      See Also:
      Criterias.HEALTH

    • getScoreboard

      Scoreboard getScoreboard()
      Gets the scoreboard to which this objective is attached.
      Returns:
      Owning scoreboard, or null if it has been unregistered

    • unregister

      void unregister() throws java.lang.IllegalStateException
      Unregisters this objective from the scoreboard.
      Throws:
      java.lang.IllegalStateException - if this objective has been unregistered

    • setDisplaySlot

      void setDisplaySlot​(DisplaySlot slot) throws java.lang.IllegalStateException
      Sets this objective to display on the specified slot for the scoreboard, removing it from any other display slot.
      Parameters:
      slot - display slot to change, or null to not display
      Throws:
      java.lang.IllegalStateException - if this objective has been unregistered

    • getDisplaySlot

      DisplaySlot getDisplaySlot() throws java.lang.IllegalStateException
      Gets the display slot this objective is displayed at.
      Returns:
      the display slot for this objective, or null if not displayed
      Throws:
      java.lang.IllegalStateException - if this objective has been unregistered

    • getScore

      @Deprecated Score getScore​(OfflinePlayer player) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException
      Deprecated.
      Scoreboards can contain entries that aren't players
      Gets a player's Score for an Objective on this Scoreboard
      Parameters:
      player - Player for the Score
      Returns:
      Score tracking the Objective and player specified
      Throws:
      java.lang.IllegalArgumentException - if player is null
      java.lang.IllegalStateException - if this objective has been unregistered
      See Also:
      getScore(String)

    • getScore

      Score getScore​(java.lang.String entry) throws java.lang.IllegalArgumentException, java.lang.IllegalStateException
      Gets an entry's Score for an Objective on this Scoreboard.
      Parameters:
      entry - Entry for the Score
      Returns:
      Score tracking the Objective and entry specified
      Throws:
      java.lang.IllegalArgumentException - if entry is null
      java.lang.IllegalStateException - if this objective has been unregistered