me.lucko.helper.scoreboard

Class PacketScoreboardObjective

java.lang.Object

me.lucko.helper.scoreboard.PacketScoreboardObjective

All Implemented Interfaces:

ScoreboardObjective

@NonnullByDefault
public class PacketScoreboardObjective
extends Object
implements ScoreboardObjective

Implements ScoreboardObjective using ProtocolLib.

Constructor Summary

Constructors

Constructor and Description
PacketScoreboardObjective(String id, String displayName, org.bukkit.scoreboard.DisplaySlot displaySlot) Creates a new scoreboard objective
PacketScoreboardObjective(String id, String displayName, org.bukkit.scoreboard.DisplaySlot displaySlot, boolean autoSubscribe) Creates a new scoreboard objective

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PacketScoreboardObjective

public PacketScoreboardObjective(String id,
                                 String displayName,
                                 org.bukkit.scoreboard.DisplaySlot displaySlot,
                                 boolean autoSubscribe)

Creates a new scoreboard objective

Parameters:

id - the id of this objective

displayName - the initial display name

displaySlot - the initial display slot

autoSubscribe - if players should be automatically subscribed

PacketScoreboardObjective

public PacketScoreboardObjective(String id,
                                 String displayName,
                                 org.bukkit.scoreboard.DisplaySlot displaySlot)

Creates a new scoreboard objective

Parameters:

id - the id of this objective

displayName - the initial display name

displaySlot - the initial display slot

Method Detail

getId

public String getId()

Description copied from interface: ScoreboardObjective

Gets the id of this objective

Specified by:

getId in interface ScoreboardObjective

Returns:

the id

shouldAutoSubscribe

public boolean shouldAutoSubscribe()

Description copied from interface: ScoreboardObjective

Gets if players should be automatically subscribed to this objective.

Specified by:

shouldAutoSubscribe in interface ScoreboardObjective

Returns:

true if players should be automatically subscribed

setAutoSubscribe

public void setAutoSubscribe(boolean autoSubscribe)

Description copied from interface: ScoreboardObjective

Sets if players should be automatically subscribed to this objective.

Specified by:

setAutoSubscribe in interface ScoreboardObjective

Parameters:

autoSubscribe - if players should be automatically subscribed

getDisplayName

public String getDisplayName()

Description copied from interface: ScoreboardObjective

Gets the current display name of this objective

Specified by:

getDisplayName in interface ScoreboardObjective

Returns:

the display name

setDisplayName

public void setDisplayName(String displayName)

Description copied from interface: ScoreboardObjective

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

Specified by:

setDisplayName in interface ScoreboardObjective

Parameters:

displayName - the new display name

getDisplaySlot

public org.bukkit.scoreboard.DisplaySlot getDisplaySlot()

Description copied from interface: ScoreboardObjective

Gets the current display slot of this objective

Specified by:

getDisplaySlot in interface ScoreboardObjective

Returns:

the display slot

setDisplaySlot

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

Description copied from interface: ScoreboardObjective

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

Specified by:

setDisplaySlot in interface ScoreboardObjective

Parameters:

displaySlot - the new display slot

getScores

public Map<String,Integer> getScores()

Description copied from interface: ScoreboardObjective

Gets an immutable copy of the current objective scores

Specified by:

getScores in interface ScoreboardObjective

Returns:

the current scores

hasScore

public boolean hasScore(String name)

Description copied from interface: ScoreboardObjective

Returns true if this objective has a given score

Specified by:

hasScore in interface ScoreboardObjective

Parameters:

name - the name of the score to check for

Returns:

true if the objective has the score

getScore

@Nullable
public Integer getScore(String name)

Description copied from interface: ScoreboardObjective

Gets the value mapped to a given score, if present

Specified by:

getScore in interface ScoreboardObjective

Parameters:

name - the name of the score

Returns:

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

setScore

public void setScore(String name,
                     int value)

Description copied from interface: ScoreboardObjective

Sets a new score value

Specified by:

setScore in interface ScoreboardObjective

Parameters:

name - the name of the score

value - the value to set the score to

removeScore

public boolean removeScore(String name)

Description copied from interface: ScoreboardObjective

Removes a score

Specified by:

removeScore in interface ScoreboardObjective

Parameters:

name - the name of the score

Returns:

true if the score was removed

clearScores

public void clearScores()

Description copied from interface: ScoreboardObjective

Clears the scores from this objective

Specified by:

clearScores in interface ScoreboardObjective

applyScores

public void applyScores(Map<String,Integer> scores)

Description copied from interface: ScoreboardObjective

Applies a score mapping to this objective

Specified by:

applyScores in interface ScoreboardObjective

Parameters:

scores - the scores to apply

applyLines

public void applyLines(String... lines)

Description copied from interface: ScoreboardObjective

Automatically applies a set of score lines to this objective.

Specified by:

applyLines in interface ScoreboardObjective

Parameters:

lines - the lines to apply

applyLines

public void applyLines(Collection<String> lines)

Description copied from interface: ScoreboardObjective

Automatically applies a set of score lines to this objective.

Specified by:

applyLines in interface ScoreboardObjective

Parameters:

lines - the lines to apply

subscribe

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

Description copied from interface: ScoreboardObjective

Subscribes a player to this objective

Specified by:

subscribe in interface ScoreboardObjective

Parameters:

player - the player to subscribe

unsubscribe

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

Description copied from interface: ScoreboardObjective

Unsubscribes a player from this objective

Specified by:

unsubscribe in interface ScoreboardObjective

Parameters:

player - the player to unsubscribe

unsubscribe

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

Description copied from interface: ScoreboardObjective

Unsubscribes a player from this objective

Specified by:

unsubscribe in interface ScoreboardObjective

Parameters:

player - the player to unsubscribe

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

unsubscribeAll

public void unsubscribeAll()

Description copied from interface: ScoreboardObjective

Unsubscribes all players from this objective

Specified by:

unsubscribeAll in interface ScoreboardObjective