org.spongepowered.api.scoreboard

Interface Scoreboard

public interface Scoreboard

Represents a scoreboard, which contains Teams and Objectives. The server has a default scoreboard, but each Player can have their own scoreboard.

See Also:

Scoreboards on the Minecraft Wiki

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Scoreboard.Builder Represents a builder to create Scoreboard instances.

Method Summary

Modifier and Type	Method and Description
void	addObjective(Objective objective) Adds the specified Objective to this scoreboard.
static Scoreboard.Builder	builder() Creates a new Scoreboard.Builder to build a Scoreboard.
default void	clearSlot(DisplaySlot slot) Clears any Objective in the specified slot.
Optional<Team>	getMemberTeam(Text member) Gets a Text member's Team on this scoreboard.
Optional<Objective>	getObjective(DisplaySlot slot) Gets the Objective currently displayed in a DisplaySlot on this scoreboard, if one is present.
Optional<Objective>	getObjective(String name) Gets an Objective on this scoreboard by name, if it exists.
Set<Objective>	getObjectives() Gets all Objectives on this scoreboard.
Set<Objective>	getObjectivesByCriteria(Criterion criteria) Gets all Objectives of a Criteria on this scoreboard.
Set<Score>	getScores() Gets all the scores on this scoreboard, across all objectives.
Set<Score>	getScores(Text name) Gets all scores with the specified name on this scoreboard, across all objectives.
Optional<Team>	getTeam(String teamName) Gets a Team by name on this scoreboard.
Set<Team>	getTeams() Gets all the Teams on this scoreboard.
void	registerTeam(Team team) Registers the specified Team to this scoreboard.
void	removeObjective(Objective objective) Removes the specified Objective from this scoreboard.
void	removeScores(Text name) Removes all scores with the specified name on this scoreboard, across all objectives.
void	updateDisplaySlot(Objective objective, DisplaySlot displaySlot) Sets the specified Objective in the specified DisplaySlot.

Method Detail

builder

static Scoreboard.Builder builder()

Creates a new Scoreboard.Builder to build a Scoreboard.

Returns:

The new builder

getObjective

Optional<Objective> getObjective(String name)

Gets an Objective on this scoreboard by name, if it exists.

Parameters:

name - Name of the Objective

Returns:

The Objective, if it exists

getObjective

Optional<Objective> getObjective(DisplaySlot slot)

Gets the Objective currently displayed in a DisplaySlot on this scoreboard, if one is present.

Parameters:

slot - The DisplaySlot

Returns:

the Objective currently displayed, if present

addObjective

void addObjective(Objective objective)
           throws IllegalArgumentException

Adds the specified Objective to this scoreboard.

Parameters:

objective - The Objective add

Throws:

IllegalArgumentException - if an Objective with the same name already exists, or if the specified Objective has already been added.

updateDisplaySlot

void updateDisplaySlot(@Nullable
                       Objective objective,
                       DisplaySlot displaySlot)
                throws IllegalStateException

Sets the specified Objective in the specified DisplaySlot.

If the Objective is null, then the specified DisplaySlot will be cleared.

Parameters:

objective - The Objective to set

displaySlot - The DisplaySlot to the specified Objective in

Throws:

IllegalStateException - if the specified Objective does not exist on this scoreboard

clearSlot

default void clearSlot(DisplaySlot slot)

Clears any Objective in the specified slot.

Parameters:

slot - The DisplaySlot to remove any Objective for

getObjectivesByCriteria

Set<Objective> getObjectivesByCriteria(Criterion criteria)

Gets all Objectives of a Criteria on this scoreboard.

Parameters:

criteria - Criterion to search by

Returns:

A set of Objectives using the specified Criteria

getObjectives

Set<Objective> getObjectives()

Gets all Objectives on this scoreboard.

Returns:

A set of all Objectives on this scoreboard

removeObjective

void removeObjective(Objective objective)

Removes the specified Objective from this scoreboard.

Parameters:

objective - The Objective to remove

getScores

Set<Score> getScores()

Gets all the scores on this scoreboard, across all objectives.

If the same Score has been added to multiple objectives, it will only appear once in the set.

Returns:

A set of all scores

getScores

Set<Score> getScores(Text name)

Gets all scores with the specified name on this scoreboard, across all objectives.

If the same Score has been added to multiple objectives, it will only appear once in the set.

Parameters:

name - The name whose scores are being retrieved

Returns:

A set of all scores for the name

removeScores

void removeScores(Text name)

Removes all scores with the specified name on this scoreboard, across all objectives.

Parameters:

name - The name to remove all scores for

getTeam

Optional<Team> getTeam(String teamName)

Gets a Team by name on this scoreboard.

Parameters:

teamName - The name of the Team

Returns:

The matching Team, if it exists

registerTeam

void registerTeam(Team team)
           throws IllegalArgumentException

Registers the specified Team to this scoreboard.

Parameters:

team - The Team to register

Throws:

IllegalArgumentException - if a team with the same name already exists on this scoreboard, or if the specified Team is already registered to a scoreboard (this scoreboard, or another one).

getTeams

Set<Team> getTeams()

Gets all the Teams on this scoreboard.

Returns:

The set of Teams

getMemberTeam

Optional<Team> getMemberTeam(Text member)

Gets a Text member's Team on this scoreboard.

Parameters:

member - The Text to search for

Returns:

The Text member's Team, or Optional.empty() if the member has no team