me.lucko.helper.scoreboard

Interface ScoreboardObjective

All Known Implementing Classes:

PacketScoreboardObjective

@NonnullByDefault
public interface ScoreboardObjective

Represents a specific objective on a Scoreboard.

Method Summary

Modifier and Type	Method and Description
void	applyLines(Collection<String> lines) Automatically applies a set of score lines to this objective.
void	applyLines(String... lines) Automatically applies a set of score lines to this objective.
void	applyScores(Map<String,Integer> scores) Applies a score mapping to this objective
void	clearScores() Clears the scores from this objective
String	getDisplayName() Gets the current display name of this objective
org.bukkit.scoreboard.DisplaySlot	getDisplaySlot() Gets the current display slot of this objective
String	getId() Gets the id of this objective
Integer	getScore(String name) Gets the value mapped to a given score, if present
Map<String,Integer>	getScores() Gets an immutable copy of the current objective scores
boolean	hasScore(String name) Returns true if this objective has a given score
boolean	removeScore(String name) Removes a score
void	setAutoSubscribe(boolean autoSubscribe) Sets if players should be automatically subscribed to this objective.
void	setDisplayName(String displayName) Lazily sets the display name to a new value and updates the objectives subscribers
void	setDisplaySlot(org.bukkit.scoreboard.DisplaySlot displaySlot) Lazily sets the display slot to a new value and updates the objectives subscribers
void	setScore(String name, int value) Sets a new score value
boolean	shouldAutoSubscribe() Gets if players should be automatically subscribed to this objective.
void	subscribe(org.bukkit.entity.Player player) Subscribes a player to this objective
void	unsubscribe(org.bukkit.entity.Player player) Unsubscribes a player from this objective
void	unsubscribe(org.bukkit.entity.Player player, boolean fast) Unsubscribes a player from this objective
void	unsubscribeAll() Unsubscribes all players from this objective

Method Detail

getId

String getId()

Gets the id of this objective

Returns:

the id

shouldAutoSubscribe

boolean shouldAutoSubscribe()

Gets if players should be automatically subscribed to this objective.

Returns:

true if players should be automatically subscribed

setAutoSubscribe

void setAutoSubscribe(boolean autoSubscribe)

Sets if players should be automatically subscribed to this objective.

Parameters:

autoSubscribe - if players should be automatically subscribed

getDisplayName

String getDisplayName()

Gets the current display name of this objective

Returns:

the display name

setDisplayName

void setDisplayName(String displayName)

Lazily sets the display name to a new value and updates the objectives subscribers

Parameters:

displayName - the new display name

getDisplaySlot

org.bukkit.scoreboard.DisplaySlot getDisplaySlot()

Gets the current display slot of this objective

Returns:

the display slot

setDisplaySlot

void setDisplaySlot(org.bukkit.scoreboard.DisplaySlot displaySlot)

Lazily sets the display slot to a new value and updates the objectives subscribers

Parameters:

displaySlot - the new display slot

getScores

Map<String,Integer> getScores()

Gets an immutable copy of the current objective scores

Returns:

the current scores

hasScore

boolean hasScore(String name)

Returns true if this objective has a given score

Parameters:

name - the name of the score to check for

Returns:

true if the objective has the score

getScore

@Nullable
Integer getScore(String name)

Gets the value mapped to a given score, if present

Parameters:

name - the name of the score

Returns:

the value, or null if a mapping could not be found

setScore

void setScore(String name,
              int value)

Sets a new score value

Parameters:

name - the name of the score

value - the value to set the score to

removeScore

boolean removeScore(String name)

Removes a score

Parameters:

name - the name of the score

Returns:

true if the score was removed

clearScores

void clearScores()

Clears the scores from this objective

applyScores

void applyScores(Map<String,Integer> scores)

Applies a score mapping to this objective

Parameters:

scores - the scores to apply

applyLines

void applyLines(String... lines)

Automatically applies a set of score lines to this objective.

Parameters:

lines - the lines to apply

applyLines

void applyLines(Collection<String> lines)

Automatically applies a set of score lines to this objective.

Parameters:

lines - the lines to apply

subscribe

void subscribe(org.bukkit.entity.Player player)

Subscribes a player to this objective

Parameters:

player - the player to subscribe

unsubscribe

void unsubscribe(org.bukkit.entity.Player player)

Unsubscribes a player from this objective

Parameters:

player - the player to unsubscribe

unsubscribe

void unsubscribe(org.bukkit.entity.Player player,
                 boolean fast)

Unsubscribes a player from this objective

Parameters:

player - the player to unsubscribe

fast - if true, the removal packet will not be sent (for use when the player is leaving)

unsubscribeAll

void unsubscribeAll()

Unsubscribes all players from this objective