me.lucko.helper.scoreboard

Class PacketScoreboardTeam

java.lang.Object

me.lucko.helper.scoreboard.PacketScoreboardTeam

All Implemented Interfaces:

ScoreboardTeam

@NonnullByDefault
public class PacketScoreboardTeam
extends Object
implements ScoreboardTeam

Implements ScoreboardTeam using ProtocolLib.

Nested Class Summary

Nested classes/interfaces inherited from interface me.lucko.helper.scoreboard.ScoreboardTeam

ScoreboardTeam.CollisionRule, ScoreboardTeam.NameTagVisibility

Constructor Summary

Constructors

Constructor and Description
PacketScoreboardTeam(String id, String displayName) Creates a new scoreboard team
PacketScoreboardTeam(String id, String displayName, boolean autoSubscribe) Creates a new scoreboard team

Method Summary

Modifier and Type	Method and Description
boolean	addPlayer(String player) Adds a player to this team
ScoreboardTeam.CollisionRule	getCollisionRule() Gets the current collision rule setting
ChatColor	getColor() Gets the team color.
String	getDisplayName() Gets the current display name of this team
String	getId() Gets the id of this team
ScoreboardTeam.NameTagVisibility	getNameTagVisibility() Gets the current nametag visibility setting
Set<String>	getPlayers() Gets an immutable copy of the teams members
String	getPrefix() Gets the current prefix for this team
String	getSuffix() Gets the current suffix for this team
boolean	hasPlayer(String player) Returns true if the given player is a member of this team
boolean	isAllowFriendlyFire() Gets if friendly fire is allowed
boolean	isCanSeeFriendlyInvisibles() Gets if members of this team can see invisible members on the same team
boolean	removePlayer(String player) Removes a player from this team
void	setAllowFriendlyFire(boolean allowFriendlyFire) Lazily sets the friendly fire setting to new value and updates the teams subscribers
void	setAutoSubscribe(boolean autoSubscribe) Sets if players should be automatically subscribed to this team.
void	setCanSeeFriendlyInvisibles(boolean canSeeFriendlyInvisibles) Lazily sets the friendly invisibility setting to new value and updates the teams subscribers
void	setCollisionRule(ScoreboardTeam.CollisionRule collisionRule) Lazily sets the collision rule setting to new value and updates the teams subscribers
void	setColor(ChatColor color) Sets the teams color.
void	setDisplayName(String displayName) Lazily sets the display name to a new value and updates the teams subscribers
void	setNameTagVisibility(ScoreboardTeam.NameTagVisibility nameTagVisibility) Lazily sets the nametag visibility setting to new value and updates the teams subscribers
void	setPrefix(String prefix) Lazily sets the prefix to a new value and updates the teams subscribers
void	setSuffix(String suffix) Lazily sets the suffix to a new value and updates the teams subscribers
boolean	shouldAutoSubscribe() Gets if players should be automatically subscribed to this team.
void	subscribe(Player player) Subscribes a player to this team
void	unsubscribe(Player player) Unsubscribes a player from this team
void	unsubscribe(Player player, boolean fast) Unsubscribes a player from this team
void	unsubscribeAll() Unsubscribes all players from this team

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.lucko.helper.scoreboard.ScoreboardTeam

addPlayer, hasPlayer, removePlayer

Constructor Detail

PacketScoreboardTeam

public PacketScoreboardTeam(String id,
                            String displayName,
                            boolean autoSubscribe)

Creates a new scoreboard team

Parameters:

id - the id of this team

displayName - the initial display name

autoSubscribe - if players should be automatically subscribed

PacketScoreboardTeam

public PacketScoreboardTeam(String id,
                            String displayName)

Creates a new scoreboard team

Parameters:

id - the id of this team

displayName - the initial display name

Method Detail

getId

public String getId()

Description copied from interface: ScoreboardTeam

Gets the id of this team

Specified by:

getId in interface ScoreboardTeam

Returns:

the id

shouldAutoSubscribe

public boolean shouldAutoSubscribe()

Description copied from interface: ScoreboardTeam

Gets if players should be automatically subscribed to this team.

Specified by:

shouldAutoSubscribe in interface ScoreboardTeam

Returns:

true if players should be automatically subscribed

setAutoSubscribe

public void setAutoSubscribe(boolean autoSubscribe)

Description copied from interface: ScoreboardTeam

Sets if players should be automatically subscribed to this team.

Specified by:

setAutoSubscribe in interface ScoreboardTeam

Parameters:

autoSubscribe - if players should be automatically subscribed

getDisplayName

public String getDisplayName()

Description copied from interface: ScoreboardTeam

Gets the current display name of this team

Specified by:

getDisplayName in interface ScoreboardTeam

Returns:

the display name

setDisplayName

public void setDisplayName(String displayName)

Description copied from interface: ScoreboardTeam

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

Specified by:

setDisplayName in interface ScoreboardTeam

Parameters:

displayName - the new display name

getPrefix

public String getPrefix()

Description copied from interface: ScoreboardTeam

Gets the current prefix for this team

Specified by:

getPrefix in interface ScoreboardTeam

Returns:

the prefix

setPrefix

public void setPrefix(String prefix)

Description copied from interface: ScoreboardTeam

Lazily sets the prefix to a new value and updates the teams subscribers

Specified by:

setPrefix in interface ScoreboardTeam

Parameters:

prefix - the new prefix

getSuffix

public String getSuffix()

Description copied from interface: ScoreboardTeam

Gets the current suffix for this team

Specified by:

getSuffix in interface ScoreboardTeam

Returns:

the suffix

setSuffix

public void setSuffix(String suffix)

Description copied from interface: ScoreboardTeam

Lazily sets the suffix to a new value and updates the teams subscribers

Specified by:

setSuffix in interface ScoreboardTeam

Parameters:

suffix - the new suffix

isAllowFriendlyFire

public boolean isAllowFriendlyFire()

Description copied from interface: ScoreboardTeam

Gets if friendly fire is allowed

Specified by:

isAllowFriendlyFire in interface ScoreboardTeam

Returns:

true if friendly fire is allowed

setAllowFriendlyFire

public void setAllowFriendlyFire(boolean allowFriendlyFire)

Description copied from interface: ScoreboardTeam

Lazily sets the friendly fire setting to new value and updates the teams subscribers

Specified by:

setAllowFriendlyFire in interface ScoreboardTeam

Parameters:

allowFriendlyFire - the new setting

isCanSeeFriendlyInvisibles

public boolean isCanSeeFriendlyInvisibles()

Description copied from interface: ScoreboardTeam

Gets if members of this team can see invisible members on the same team

Specified by:

isCanSeeFriendlyInvisibles in interface ScoreboardTeam

Returns:

true if members of this team can see invisible members on the same team

setCanSeeFriendlyInvisibles

public void setCanSeeFriendlyInvisibles(boolean canSeeFriendlyInvisibles)

Description copied from interface: ScoreboardTeam

Lazily sets the friendly invisibility setting to new value and updates the teams subscribers

Specified by:

setCanSeeFriendlyInvisibles in interface ScoreboardTeam

Parameters:

canSeeFriendlyInvisibles - the new setting

getNameTagVisibility

public ScoreboardTeam.NameTagVisibility getNameTagVisibility()

Description copied from interface: ScoreboardTeam

Gets the current nametag visibility setting

Specified by:

getNameTagVisibility in interface ScoreboardTeam

Returns:

the nametag visibility

setNameTagVisibility

public void setNameTagVisibility(ScoreboardTeam.NameTagVisibility nameTagVisibility)

Description copied from interface: ScoreboardTeam

Lazily sets the nametag visibility setting to new value and updates the teams subscribers

Specified by:

setNameTagVisibility in interface ScoreboardTeam

Parameters:

nameTagVisibility - the new setting

getCollisionRule

public ScoreboardTeam.CollisionRule getCollisionRule()

Description copied from interface: ScoreboardTeam

Gets the current collision rule setting

Specified by:

getCollisionRule in interface ScoreboardTeam

Returns:

the collision rule

setCollisionRule

public void setCollisionRule(ScoreboardTeam.CollisionRule collisionRule)

Description copied from interface: ScoreboardTeam

Lazily sets the collision rule setting to new value and updates the teams subscribers

Specified by:

setCollisionRule in interface ScoreboardTeam

Parameters:

collisionRule - the new setting

getColor

public ChatColor getColor()

Description copied from interface: ScoreboardTeam

Gets the team color. - ChatColor.RESET by default.

Specified by:

getColor in interface ScoreboardTeam

Returns:

the team color

setColor

public void setColor(ChatColor color)

Description copied from interface: ScoreboardTeam

Sets the teams color.

Specified by:

setColor in interface ScoreboardTeam

Parameters:

color - the new color

addPlayer

public boolean addPlayer(String player)

Description copied from interface: ScoreboardTeam

Adds a player to this team

Specified by:

addPlayer in interface ScoreboardTeam

Parameters:

player - the player to add

Returns:

true if the player was added successfully

removePlayer

public boolean removePlayer(String player)

Description copied from interface: ScoreboardTeam

Removes a player from this team

Specified by:

removePlayer in interface ScoreboardTeam

Parameters:

player - the player to remove

Returns:

true if the player was removed successfully

hasPlayer

public boolean hasPlayer(String player)

Description copied from interface: ScoreboardTeam

Returns true if the given player is a member of this team

Specified by:

hasPlayer in interface ScoreboardTeam

Parameters:

player - the player to check for

Returns:

true if the player is a member

getPlayers

public Set<String> getPlayers()

Description copied from interface: ScoreboardTeam

Gets an immutable copy of the teams members

Specified by:

getPlayers in interface ScoreboardTeam

Returns:

the team members

subscribe

public void subscribe(Player player)

Description copied from interface: ScoreboardTeam

Subscribes a player to this team

Specified by:

subscribe in interface ScoreboardTeam

Parameters:

player - the player to subscribe

unsubscribe

public void unsubscribe(Player player)

Description copied from interface: ScoreboardTeam

Unsubscribes a player from this team

Specified by:

unsubscribe in interface ScoreboardTeam

Parameters:

player - the player to unsubscribe

unsubscribe

public void unsubscribe(Player player,
                        boolean fast)

Description copied from interface: ScoreboardTeam

Unsubscribes a player from this team

Specified by:

unsubscribe in interface ScoreboardTeam

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: ScoreboardTeam

Unsubscribes all players from this team

Specified by:

unsubscribeAll in interface ScoreboardTeam