public interface Scoreboard

A scoreboard

Since:: 1.5.1

Method Summary

Modifier and Type

Method

Description

void

clearSlot(@NotNull DisplaySlot slot)

Clears any objective in the specified slot.

@Nullable Team

getEntityTeam(Entity entity)

Gets an entity's Team on this Scoreboard

@NotNull Set<String>

getEntries()

Gets all entries tracked by this Scoreboard

@Nullable Team

getEntryTeam(@NotNull String entry)

Gets an entry's Team on this Scoreboard

@Nullable Objective

getObjective(@NotNull String name)

Gets an Objective on this Scoreboard by name

@Nullable Objective

getObjective(@NotNull DisplaySlot slot)

Gets the Objective currently displayed in a DisplaySlot on this Scoreboard

@NotNull Set<Objective>

getObjectives()

Gets all Objectives on this Scoreboard

@NotNull Set<Objective>

getObjectivesByCriteria(@NotNull String criteria)

Deprecated.
use getObjectivesByCriteria(Criteria)

@NotNull Set<Objective>

getObjectivesByCriteria(@NotNull Criteria criteria)

Gets all Objectives of a Criteria on the Scoreboard

@NotNull Set<OfflinePlayer>

getPlayers()

Deprecated.
Scoreboards can contain entries that aren't players

@Nullable Team

getPlayerTeam(@NotNull OfflinePlayer player)

Gets a player's Team on this Scoreboard

@NotNull Set<Score>

getScores(@NotNull String entry)

Gets all scores for an entry on this Scoreboard

@NotNull Set<Score>

getScores(@NotNull OfflinePlayer player)

Gets all scores for a player on this Scoreboard

@NotNull Set<Score>

getScoresFor(Entity entity)

Gets all scores for an entity on this Scoreboard

@Nullable Team

getTeam(@NotNull String teamName)

Gets a Team by name on this Scoreboard

@NotNull Set<Team>

getTeams()

Gets all teams on this Scoreboard

default @NotNull Objective

registerNewObjective(@NotNull String name, @NotNull String criteria)

Deprecated.
a displayName should be explicitly specified

default @NotNull Objective

registerNewObjective(@NotNull String name, @NotNull String criteria, @NotNull String displayName)

Deprecated.
use registerNewObjective(String, Criteria, net.kyori.adventure.text.Component)

@NotNull Objective

registerNewObjective(@NotNull String name, @NotNull String criteria, @NotNull String displayName, @NotNull RenderType renderType)

Deprecated.
use registerNewObjective(String, Criteria, net.kyori.adventure.text.Component, RenderType)

default @NotNull Objective

registerNewObjective(@NotNull String name, @NotNull String criteria, @Nullable Component displayName)

Deprecated.
use registerNewObjective(String, Criteria, net.kyori.adventure.text.Component)

@NotNull Objective

registerNewObjective(@NotNull String name, @NotNull String criteria, @Nullable Component displayName, @NotNull RenderType renderType)

Deprecated.
use registerNewObjective(String, Criteria, net.kyori.adventure.text.Component, RenderType)

default @NotNull Objective

registerNewObjective(@NotNull String name, @NotNull Criteria criteria, @NotNull String displayName)

Deprecated.
in favour of registerNewObjective(String, Criteria, net.kyori.adventure.text.Component)

default @NotNull Objective

registerNewObjective(@NotNull String name, @NotNull Criteria criteria, @NotNull String displayName, @NotNull RenderType renderType)

Deprecated.
in favour of registerNewObjective(String, Criteria, net.kyori.adventure.text.Component, RenderType)

default @NotNull Objective

registerNewObjective(@NotNull String name, @NotNull Criteria criteria, @Nullable Component displayName)

Registers an Objective on this Scoreboard

@NotNull Objective

registerNewObjective(@NotNull String name, @NotNull Criteria criteria, @Nullable Component displayName, @NotNull RenderType renderType)

Registers an Objective on this Scoreboard

@NotNull Team

registerNewTeam(@NotNull String name)

Registers a Team on this Scoreboard

void

resetScores(@NotNull String entry)

Removes all scores for an entry on this Scoreboard

void

resetScores(@NotNull OfflinePlayer player)

Removes all scores for a player on this Scoreboard

void

resetScoresFor(Entity entity)

Removes all scores for an entity on this Scoreboard

Method Details
- registerNewObjective
  
  @Deprecated(since="1.13") @NotNull default @NotNull Objective registerNewObjective(@NotNull @NotNull String name, @NotNull @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
  
  Since:
  
  1.5.1
- registerNewObjective
  
  @NotNull @Deprecated default @NotNull Objective registerNewObjective(@NotNull @NotNull String name, @NotNull @NotNull String criteria, @Nullable Component displayName)
  
  Deprecated.
  use registerNewObjective(String, Criteria, net.kyori.adventure.text.Component)
  
  Registers an Objective on this Scoreboard
  
  Parameters:
  
  name - Name of the Objective
  
  criteria - Criteria for the Objective
  
  displayName - display name 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
  
  Since:
  
  1.16.5
- registerNewObjective
  
  @NotNull @Deprecated @NotNull Objective registerNewObjective(@NotNull @NotNull String name, @NotNull @NotNull String criteria, @Nullable Component displayName, @NotNull @NotNull RenderType renderType) throws IllegalArgumentException
  
  Deprecated.
  use registerNewObjective(String, Criteria, net.kyori.adventure.text.Component, 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
  
  Since:
  
  1.16.5
- registerNewObjective
  
  @NotNull default @NotNull Objective registerNewObjective(@NotNull @NotNull String name, @NotNull @NotNull Criteria criteria, @Nullable Component displayName) throws IllegalArgumentException
  
  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
  
  Since:
  
  1.19.2
- registerNewObjective
  
  @NotNull @NotNull Objective registerNewObjective(@NotNull @NotNull String name, @NotNull @NotNull Criteria criteria, @Nullable Component displayName, @NotNull @NotNull RenderType renderType) throws IllegalArgumentException
  
  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
  
  Since:
  
  1.19.2
- registerNewObjective
  
  @Deprecated(since="1.20.5") @NotNull default @NotNull Objective registerNewObjective(@NotNull @NotNull String name, @NotNull @NotNull String criteria, @NotNull @NotNull String displayName)
  
  Deprecated.
  use registerNewObjective(String, Criteria, net.kyori.adventure.text.Component)
  
  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
  
  Since:
  
  1.13
- registerNewObjective
  
  @Deprecated(since="1.20.5") @NotNull @NotNull Objective registerNewObjective(@NotNull @NotNull String name, @NotNull @NotNull String criteria, @NotNull @NotNull String displayName, @NotNull @NotNull RenderType renderType)
  
  Deprecated.
  use registerNewObjective(String, Criteria, net.kyori.adventure.text.Component, 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
  
  Since:
  
  1.13.2
- registerNewObjective
  
  @NotNull @Deprecated default @NotNull Objective registerNewObjective(@NotNull @NotNull String name, @NotNull @NotNull Criteria criteria, @NotNull @NotNull String displayName)
  
  Deprecated.
  in favour of registerNewObjective(String, Criteria, net.kyori.adventure.text.Component)
  
  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
  
  Since:
  
  1.19.2
- registerNewObjective
  
  @NotNull @Deprecated default @NotNull Objective registerNewObjective(@NotNull @NotNull String name, @NotNull @NotNull Criteria criteria, @NotNull @NotNull String displayName, @NotNull @NotNull RenderType renderType)
  
  Deprecated.
  in favour of registerNewObjective(String, Criteria, net.kyori.adventure.text.Component, 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
  
  Since:
  
  1.19.2
- getObjective
  
  @Nullable @Nullable Objective getObjective(@NotNull @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
  
  Since:
  
  1.5.1
- getObjectivesByCriteria
  
  @Deprecated(since="1.19.2") @NotNull @NotNull Set<Objective> getObjectivesByCriteria(@NotNull @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
  
  Since:
  
  1.5.1
- getObjectivesByCriteria
  
  @NotNull @NotNull Set<Objective> getObjectivesByCriteria(@NotNull @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
  
  Since:
  
  1.19.2
- getObjectives
  
  @NotNull @NotNull Set<Objective> getObjectives()
  
  Gets all Objectives on this Scoreboard
  
  Returns:
  
  An immutable set of all Objectives on this Scoreboard
  
  Since:
  
  1.5.1
- getObjective
  
  @Nullable @Nullable Objective getObjective(@NotNull @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
  
  Since:
  
  1.5.1
- getScores
  @NotNull @NotNull Set<Score> getScores(@NotNull @NotNull OfflinePlayer player)
  
  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
  
  Since:
  
  1.5.1
  
  See Also:
  
  getScores(String)
- getScores
  
  @NotNull @NotNull Set<Score> getScores(@NotNull @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
  
  Since:
  
  1.7.10
- resetScores
  void resetScores(@NotNull @NotNull OfflinePlayer player)
  
  Removes all scores for a player on this Scoreboard
  
  Parameters:
  
  player - the player to drop all current scores for
  
  Since:
  
  1.5.1
  
  See Also:
  
  resetScores(String)
- resetScores
  
  void resetScores(@NotNull @NotNull String entry)
  
  Removes all scores for an entry on this Scoreboard
  
  Parameters:
  
  entry - the entry to drop all current scores for
  
  Since:
  
  1.7.10
- getPlayerTeam
  @Nullable @Nullable Team getPlayerTeam(@NotNull @NotNull OfflinePlayer player)
  
  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
  
  Since:
  
  1.5.1
  
  See Also:
  
  getEntryTeam(String)
- getEntryTeam
  
  @Nullable @Nullable Team getEntryTeam(@NotNull @NotNull String entry)
  
  Gets an entry's Team on this Scoreboard
  
  Parameters:
  
  entry - the entry to search for
  
  Returns:
  
  the entry's Team or null if the entry is not on a team
  
  Since:
  
  1.8.8
- getTeam
  
  @Nullable @Nullable Team getTeam(@NotNull @NotNull String teamName)
  
  Gets a Team by name on this Scoreboard
  
  Parameters:
  
  teamName - Team name
  
  Returns:
  
  the matching Team or null if no matches
  
  Since:
  
  1.5.1
- getTeams
  
  @NotNull @NotNull Set<Team> getTeams()
  
  Gets all teams on this Scoreboard
  
  Returns:
  
  an immutable set of Teams
  
  Since:
  
  1.5.1
- registerNewTeam
  
  @NotNull @NotNull Team registerNewTeam(@NotNull @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
  
  Since:
  
  1.5.1
- getPlayers
  @Deprecated(since="1.7.8") @NotNull @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
  
  Since:
  
  1.5.1
  
  See Also:
  
  getEntries()
- getEntries
  
  @NotNull @NotNull Set<String> getEntries()
  
  Gets all entries tracked by this Scoreboard
  
  Returns:
  
  immutable set of all tracked entries
  
  Since:
  
  1.7.10
- clearSlot
  
  void clearSlot(@NotNull @NotNull DisplaySlot slot)
  
  Clears any objective in the specified slot.
  
  Parameters:
  
  slot - the slot to remove objectives
  
  Since:
  
  1.5.1
- getScoresFor
  @NotNull @NotNull Set<Score> getScoresFor(@NotNull Entity entity) throws IllegalArgumentException
  
  Gets all scores for an entity on this Scoreboard
  
  Parameters:
  
  entity - the entity whose scores are being retrieved
  
  Returns:
  
  immutable set of all scores tracked for the entity
  
  Throws:
  
  IllegalArgumentException - if entity is null
  
  Since:
  
  1.18.1
  
  See Also:
  
  getScores(String)
- resetScoresFor
  void resetScoresFor(@NotNull Entity entity) throws IllegalArgumentException
  
  Removes all scores for an entity on this Scoreboard
  
  Parameters:
  
  entity - the entity to drop all current scores for
  
  Throws:
  
  IllegalArgumentException - if entity is null
  
  Since:
  
  1.18.1
  
  See Also:
  
  resetScores(String)
- getEntityTeam
  @Nullable @Nullable Team getEntityTeam(@NotNull Entity entity) throws IllegalArgumentException
  
  Gets an entity's Team on this Scoreboard
  
  Parameters:
  
  entity - the entity to search for
  
  Returns:
  
  the entity's Team or null if the entity is not on a team
  
  Throws:
  
  IllegalArgumentException - if entity is null
  
  Since:
  
  1.18.1
  
  See Also:
  
  getEntryTeam(String)

Interface Scoreboard

Method Summary

Method Details

registerNewObjective

registerNewObjective

registerNewObjective

registerNewObjective

registerNewObjective

registerNewObjective

registerNewObjective

registerNewObjective

registerNewObjective

getObjective

getObjectivesByCriteria

getObjectivesByCriteria

getObjectives

getObjective

getScores

getScores

resetScores

resetScores

getPlayerTeam

getEntryTeam

getTeam

getTeams

registerNewTeam

getPlayers

getEntries

clearSlot

getScoresFor

resetScoresFor

getEntityTeam