me.lucko.helper.scoreboard

Interface ScoreboardTeam

All Known Implementing Classes:

PacketScoreboardTeam

@NonnullByDefault
public interface ScoreboardTeam

Represents a specific team on a Scoreboard.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScoreboardTeam.CollisionRule
static class	ScoreboardTeam.NameTagVisibility

Method Summary

Modifier and Type	Method and Description
default boolean	addPlayer(org.bukkit.entity.Player player) Adds a player to this team
boolean	addPlayer(String player) Adds a player to this team
ScoreboardTeam.CollisionRule	getCollisionRule() Gets the current collision rule setting
org.bukkit.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
default boolean	hasPlayer(org.bukkit.entity.Player player) Returns true if the given player is a member of 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
default boolean	removePlayer(org.bukkit.entity.Player player) Removes a player from this 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(org.bukkit.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(org.bukkit.entity.Player player) Subscribes a player to this team
void	unsubscribe(org.bukkit.entity.Player player) Unsubscribes a player from this team
void	unsubscribe(org.bukkit.entity.Player player, boolean fast) Unsubscribes a player from this team
void	unsubscribeAll() Unsubscribes all players from this team

Method Detail

getId

String getId()

Gets the id of this team

Returns:

the id

shouldAutoSubscribe

boolean shouldAutoSubscribe()

Gets if players should be automatically subscribed to this team.

Returns:

true if players should be automatically subscribed

setAutoSubscribe

void setAutoSubscribe(boolean autoSubscribe)

Sets if players should be automatically subscribed to this team.

Parameters:

autoSubscribe - if players should be automatically subscribed

getDisplayName

String getDisplayName()

Gets the current display name of this team

Returns:

the display name

setDisplayName

void setDisplayName(String displayName)

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

Parameters:

displayName - the new display name

getPrefix

String getPrefix()

Gets the current prefix for this team

Returns:

the prefix

setPrefix

void setPrefix(String prefix)

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

Parameters:

prefix - the new prefix

getSuffix

String getSuffix()

Gets the current suffix for this team

Returns:

the suffix

setSuffix

void setSuffix(String suffix)

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

Parameters:

suffix - the new suffix

isAllowFriendlyFire

boolean isAllowFriendlyFire()

Gets if friendly fire is allowed

Returns:

true if friendly fire is allowed

setAllowFriendlyFire

void setAllowFriendlyFire(boolean allowFriendlyFire)

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

Parameters:

allowFriendlyFire - the new setting

isCanSeeFriendlyInvisibles

boolean isCanSeeFriendlyInvisibles()

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

Returns:

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

setCanSeeFriendlyInvisibles

void setCanSeeFriendlyInvisibles(boolean canSeeFriendlyInvisibles)

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

Parameters:

canSeeFriendlyInvisibles - the new setting

getNameTagVisibility

ScoreboardTeam.NameTagVisibility getNameTagVisibility()

Gets the current nametag visibility setting

Returns:

the nametag visibility

setNameTagVisibility

void setNameTagVisibility(ScoreboardTeam.NameTagVisibility nameTagVisibility)

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

Parameters:

nameTagVisibility - the new setting

getCollisionRule

ScoreboardTeam.CollisionRule getCollisionRule()

Gets the current collision rule setting

Returns:

the collision rule

setCollisionRule

void setCollisionRule(ScoreboardTeam.CollisionRule collisionRule)

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

Parameters:

collisionRule - the new setting

getColor

org.bukkit.ChatColor getColor()

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

Returns:

the team color

setColor

void setColor(org.bukkit.ChatColor color)

Sets the teams color.

Parameters:

color - the new color

addPlayer

boolean addPlayer(String player)

Adds a player to this team

Parameters:

player - the player to add

Returns:

true if the player was added successfully

removePlayer

boolean removePlayer(String player)

Removes a player from this team

Parameters:

player - the player to remove

Returns:

true if the player was removed successfully

hasPlayer

boolean hasPlayer(String player)

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

Parameters:

player - the player to check for

Returns:

true if the player is a member

addPlayer

default boolean addPlayer(org.bukkit.entity.Player player)

Adds a player to this team

Parameters:

player - the player to add

Returns:

true if the player was added successfully

removePlayer

default boolean removePlayer(org.bukkit.entity.Player player)

Removes a player from this team

Parameters:

player - the player to remove

Returns:

true if the player was removed successfully

hasPlayer

default boolean hasPlayer(org.bukkit.entity.Player player)

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

Parameters:

player - the player to check for

Returns:

true if the player is a member

getPlayers

Set<String> getPlayers()

Gets an immutable copy of the teams members

Returns:

the team members

subscribe

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

Subscribes a player to this team

Parameters:

player - the player to subscribe

unsubscribe

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

Unsubscribes a player from this team

Parameters:

player - the player to unsubscribe

unsubscribe

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

Unsubscribes a player from this team

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 team