org.spongepowered.api.scoreboard.objective

Interface Objective

public interface Objective

An objective tracks an integer score for each entry it contains.

Entries can be updated by plugins, by in-game commands, or automatically by the game, depending on their Criterion.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	addScore(Score score) Adds the specified Score to this objective.
static Objective.Builder	builder() Creates a new Objective.Builder to build a Objective.
Criterion	getCriterion() Gets the criterion for this objective.
ObjectiveDisplayMode	getDisplayMode() Gets the ObjectiveDisplayMode used to display this objective.
Text	getDisplayName() Gets the name displayed to players.
String	getName() Gets the name of this Objective.
Score	getOrCreateScore(Text name) Gets an entry's Score for this objective.
default Optional<Score>	getScore(Text name) Gets an entry's Score for this objective, if it exists.
Set<Scoreboard>	getScoreboards() Returns a Set of parent Scoreboards this Objective is registered to.
Map<Text,Score>	getScores() Gets the set of Scores for this objective.
boolean	hasScore(Text name) Returns whether this objective has a Score with the given name.
boolean	removeScore(Score score) Removes the specified Score from this objective, if present.
boolean	removeScore(Text name) Removes the Score with the specified name from this objective, if present.
void	setDisplayMode(ObjectiveDisplayMode displayMode) Sets the ObjectiveDisplayMode used to display this objective.
void	setDisplayName(Text displayName) Sets the name displayed to players.

Method Detail

builder

static Objective.Builder builder()

Creates a new Objective.Builder to build a Objective.

Returns:

The new builder

getName

String getName()

Gets the name of this Objective.

Returns:

The objective's name

getDisplayName

Text getDisplayName()

Gets the name displayed to players.

Returns:

The objective's display name

setDisplayName

void setDisplayName(Text displayName)
             throws IllegalArgumentException

Sets the name displayed to players.

Parameters:

displayName - Display name to set

Throws:

IllegalArgumentException - if displayName is longer than 32 characters (in its legacy representation)

getCriterion

Criterion getCriterion()

Gets the criterion for this objective.

Returns:

This objective's criterion

getDisplayMode

ObjectiveDisplayMode getDisplayMode()

Gets the ObjectiveDisplayMode used to display this objective.

Returns:

The ObjectiveDisplayMode used to display this objective

setDisplayMode

void setDisplayMode(ObjectiveDisplayMode displayMode)

Sets the ObjectiveDisplayMode used to display this objective.

Parameters:

displayMode - The ObjectiveDisplayMode used to display this objective

getScores

Map<Text,Score> getScores()

Gets the set of Scores for this objective.

Returns:

The set of Scores for this objective

hasScore

boolean hasScore(Text name)

Returns whether this objective has a Score with the given name.

Parameters:

name - The name of the Score to check for.

Returns:

Whether this objective has a Score with the given name.

addScore

void addScore(Score score)
       throws IllegalArgumentException

Adds the specified Score to this objective.

Parameters:

score - The Score to add

Throws:

IllegalArgumentException - If a Score with the same name exists, or the specified Score has already been added

getScore

default Optional<Score> getScore(Text name)

Gets an entry's Score for this objective, if it exists.

Parameters:

name - The name of the Score to get.

Returns:

The Score for te specified Text, if it exists.

getOrCreateScore

Score getOrCreateScore(Text name)

Gets an entry's Score for this objective.

If the Score does not exist, it will be created.

Parameters:

name - The name of the Score to get

Returns:

The Score for the specified Text

removeScore

boolean removeScore(Score score)

Removes the specified Score from this objective, if present.

Parameters:

score - The Score to remove

Returns:

Whether the score existed on this objective

removeScore

boolean removeScore(Text name)

Removes the Score with the specified name from this objective, if present.

Parameters:

name - The name of the Score to remove.

Returns:

Whether the score existed on this objective

getScoreboards

Set<Scoreboard> getScoreboards()

Returns a Set of parent Scoreboards this Objective is registered to.

Returns:

A Set of parent Scoreboards this Objective is registered to