org.bukkit.scoreboard.Scoreboard Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of chest-server Show documentation
A spigot fork to kotlin structure and news.
The newest version!
package org.bukkit.scoreboard;

import org.bukkit.OfflinePlayer;

import java.util.Set;

/**
 * A scoreboard
 */
public interface Scoreboard {

  /**
   * Registers an Objective on this Scoreboard
   *
   * @param name     Name of the Objective
   * @param criteria Criteria for the Objective
   * @return The registered Objective
   * @throws IllegalArgumentException if name is null
   * @throws IllegalArgumentException if criteria is null
   * @throws IllegalArgumentException if an objective by that name already
   *                                  exists
   */
  Objective registerNewObjective(String name, String criteria) throws IllegalArgumentException;

  /**
   * Gets an Objective on this Scoreboard by name
   *
   * @param name Name of the Objective
   * @return the Objective or null if it does not exist
   * @throws IllegalArgumentException if name is null
   */
  Objective getObjective(String name) throws IllegalArgumentException;

  /**
   * Gets all Objectives of a Criteria on the Scoreboard
   *
   * @param criteria Criteria to search by
   * @return an immutable set of Objectives using the specified Criteria
   */
  Set getObjectivesByCriteria(String criteria) throws IllegalArgumentException;

  /**
   * Gets all Objectives on this Scoreboard
   *
   * @return An immutable set of all Objectives on this Scoreboard
   */
  Set getObjectives();

  /**
   * Gets the Objective currently displayed in a DisplaySlot on this
   * Scoreboard
   *
   * @param slot The DisplaySlot
   * @return the Objective currently displayed or null if nothing is
   * displayed in that DisplaySlot
   * @throws IllegalArgumentException if slot is null
   */
  Objective getObjective(DisplaySlot slot) throws IllegalArgumentException;

  /**
   * Gets all scores for a player on this Scoreboard
   *
   * @param player the player whose scores are being retrieved
   * @return immutable set of all scores tracked for the player
   * @throws IllegalArgumentException if player is null
   * @see #getScores(String)
   * @deprecated Scoreboards can contain entries that aren't players
   */
  @Deprecated
  Set getScores(OfflinePlayer player) throws IllegalArgumentException;

  /**
   * Gets all scores for an entry on this Scoreboard
   *
   * @param entry the entry whose scores are being retrieved
   * @return immutable set of all scores tracked for the entry
   * @throws IllegalArgumentException if entry is null
   */
  Set getScores(String entry) throws IllegalArgumentException;

  /**
   * Removes all scores for a player on this Scoreboard
   *
   * @param player the player to drop all current scores for
   * @throws IllegalArgumentException if player is null
   * @see #resetScores(String)
   * @deprecated Scoreboards can contain entries that aren't players
   */
  @Deprecated
  void resetScores(OfflinePlayer player) throws IllegalArgumentException;

  /**
   * Removes all scores for an entry on this Scoreboard
   *
   * @param entry the entry to drop all current scores for
   * @throws IllegalArgumentException if entry is null
   */
  void resetScores(String entry) throws IllegalArgumentException;

  /**
   * Gets a player's Team on this Scoreboard
   *
   * @param player the player to search for
   * @return the player's Team or null if the player is not on a team
   * @throws IllegalArgumentException if player is null
   * @see #getEntryTeam(String)
   * @deprecated Scoreboards can contain entries that aren't players
   */
  @Deprecated
  Team getPlayerTeam(OfflinePlayer player) throws IllegalArgumentException;

  /**
   * Gets a entries Team on this Scoreboard
   *
   * @param entry the entry to search for
   * @return the entries Team or null if the entry is not on a team
   * @throws IllegalArgumentException if entry is null
   */
  Team getEntryTeam(String entry) throws IllegalArgumentException;

  /**
   * Gets a Team by name on this Scoreboard
   *
   * @param teamName Team name
   * @return the matching Team or null if no matches
   * @throws IllegalArgumentException if teamName is null
   */
  Team getTeam(String teamName) throws IllegalArgumentException;

  /**
   * Gets all teams on this Scoreboard
   *
   * @return an immutable set of Teams
   */
  Set getTeams();

  /**
   * Registers a Team on this Scoreboard
   *
   * @param name Team name
   * @return registered Team
   * @throws IllegalArgumentException if name is null
   * @throws IllegalArgumentException if team by that name already exists
   */
  Team registerNewTeam(String name) throws IllegalArgumentException;

  /**
   * Gets all players tracked by this Scoreboard
   *
   * @return immutable set of all tracked players
   * @see #getEntries()
   * @deprecated Scoreboards can contain entries that aren't players
   */
  @Deprecated
  Set getPlayers();

  /**
   * Gets all entries tracked by this Scoreboard
   *
   * @return immutable set of all tracked entries
   */
  Set getEntries();

  /**
   * Clears any objective in the specified slot.
   *
   * @param slot the slot to remove objectives
   * @throws IllegalArgumentException if slot is null
   */
  void clearSlot(DisplaySlot slot) throws IllegalArgumentException;
}