Package org.spongepowered.api.scoreboard

Interface Score

public interface Score
A score entry for one or more Objectives.

  • Method Details

    • name

      String name()
      Gets the name of this score.
      Returns:
      The name of this score

    • score

      int score()
      Gets the current score value.
      Returns:
      The current score value

    • setScore

      void setScore(int score)
      Sets the current score value.
      Parameters:
      score - The new score value

    • isLocked

      boolean isLocked()
      Checks for whether the score is locked.
      Returns:
      True if the score is locked, false otherwise

    • setLocked

      void setLocked(boolean locked)
      Sets this score as locked.
      Parameters:
      locked - True to lock this score

    • setDisplay

      void setDisplay(@Nullable Component display)
      Sets this score display
      Parameters:
      display - the display

    • display

      Optional<Component> display()
      Returns this score display
      Returns:
      the display

    • setNumberFormat

      void setNumberFormat(@Nullable ScoreFormat format)
      Sets the score number format
      Parameters:
      format - the number format

    • numberFormat

      Optional<ScoreFormat> numberFormat()
      Returns the score number format
      Returns:
      the number format

    • objectives

      Set<Objective> objectives()
      Returns a Set of parent Objectives this Score is registered to.
      Returns:
      A Set of parent Objective this Score is registered to