org.spongepowered.api.scoreboard

Interface Team

public interface Team

A team on a scoreboard that has a common display theme and other properties.

A team is comprised of different members, represented by Text objects. While any Text can be added to a team, certain Texts convey a special meaning.

Examples of this include players, whose names gain the prefix and suffix of the team they are on.

With the exception of getNameTagVisibility() (which is handled client-side), all of the team options require players to have the same team object (and by extension, the same scoreboard). For example, consider two players who each have different scoreboards set. Each scoreboard has a team registered with identical names, each containing the same players. Both players would always be able to attack each other, regardless of the value of allowFriendlyFire(). For it to work, both players must have the same scoreboard, and be on a team registered to said scoreboard.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Team.Builder Represents a builder tp create Team instances.

Method Summary

Modifier and Type	Method and Description
void	addMember(Text member) Adds the specified Text to this team.
boolean	allowFriendlyFire() Gets whether friendly fire is enabled.
static Team.Builder	builder() Creates a new Team.Builder to build a Team.
boolean	canSeeFriendlyInvisibles() Gets whether invisible team members are shown.
CollisionRule	getCollisionRule() Gets the CollisionRule for entities on this team.
TextColor	getColor() Gets the color of this team.
Visibility	getDeathMessageVisibility() Gets the Visibility which controls who death Texts for players on this team are visible to.
Text	getDisplayName() Gets the name displayed to users for this team.
Set<Text>	getMembers() Gets the Texts representing the members of this team.
String	getName() Gets the name of this team.
Visibility	getNameTagVisibility() Gets the Visibility which controls to who nametags of players on this team are visible to.
Text	getPrefix() Gets the prefix prepended to the display name of users on this team.
Optional<Scoreboard>	getScoreboard() Returns the scoreboard this team is registered on, if available.
Text	getSuffix() Gets the suffix appended to the display name of users on this team.
boolean	removeMember(Text member) Removes the specified Text from this team.
void	setAllowFriendlyFire(boolean enabled) Sets whether friendly fire is enabled.
void	setCanSeeFriendlyInvisibles(boolean enabled) Sets whether invisible team members are shown.
void	setCollisionRule(CollisionRule rule) Sets the CollisionRule for entities on this team.
void	setColor(TextColor color) Sets the color of this team.
void	setDeathMessageVisibility(Visibility visibility) Sets the Visibility which controls who death Texts of players on this team are visible to.
void	setDisplayName(Text displayName) Sets the name displayed to users for this team.
void	setNameTagVisibility(Visibility visibility) Sets the Visibility which controls to who nametags of players on this team are visible to.
void	setPrefix(Text prefix) Sets the prefix prepended to the display name of users on this team.
void	setSuffix(Text suffix) Sets the suffix appended to the display name of users on this team.
boolean	unregister() Unregisters this team from its Scoreboard, if present.

Method Detail

builder

static Team.Builder builder()

Creates a new Team.Builder to build a Team.

Returns:

The new builder

getName

String getName()

Gets the name of this team.

Returns:

The name of this team

getDisplayName

Text getDisplayName()

Gets the name displayed to users for this team.

Returns:

The display name for this team

setDisplayName

void setDisplayName(Text displayName)
             throws IllegalArgumentException

Sets the name displayed to users for this team.

Parameters:

displayName - The Text to use

Throws:

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

getColor

TextColor getColor()

Gets the color of this team.

The team's color is a distinct concept from its prefix or suffix. It is only used for colored sidebar display slots, and certain statistic criteria.

Returns:

The team color

setColor

void setColor(TextColor color)

Sets the color of this team.

The team's color is a distinct concept from its prefix or suffix. It is only used for colored sidebar display slots, and certain statistic criteria.

Parameters:

color - The team color

getPrefix

Text getPrefix()

Gets the prefix prepended to the display name of users on this team.

Returns:

The prefix for this team

setPrefix

void setPrefix(Text prefix)
        throws IllegalArgumentException

Sets the prefix prepended to the display name of users on this team.

Parameters:

prefix - The new prefix for this team

Throws:

IllegalArgumentException - If prefix is longer than 16 characters

getSuffix

Text getSuffix()

Gets the suffix appended to the display name of users on this team.

Returns:

The team's current suffix

setSuffix

void setSuffix(Text suffix)
        throws IllegalArgumentException

Sets the suffix appended to the display name of users on this team.

Parameters:

suffix - The new suffix for this team.

Throws:

IllegalArgumentException - If suffix is longer than 16 characters (in its legacy representation)

allowFriendlyFire

boolean allowFriendlyFire()

Gets whether friendly fire is enabled.

This option only controls players attacking other players. It has no affect other entities attacking other entities, or players attacking other entities (or vice-versa).

Returns:

Whether friendly fire is enabled

setAllowFriendlyFire

void setAllowFriendlyFire(boolean enabled)

Sets whether friendly fire is enabled.

Parameters:

enabled - Whether friendly fire is enabled

canSeeFriendlyInvisibles

boolean canSeeFriendlyInvisibles()

Gets whether invisible team members are shown.

Returns:

Whether to show invisible team members

setCanSeeFriendlyInvisibles

void setCanSeeFriendlyInvisibles(boolean enabled)

Sets whether invisible team members are shown.

Parameters:

enabled - Whether to show invisible teammates

getNameTagVisibility

Visibility getNameTagVisibility()

Gets the Visibility which controls to who nametags of players on this team are visible to.

Returns:

The Visibility for this team's nametags

setNameTagVisibility

void setNameTagVisibility(Visibility visibility)

Sets the Visibility which controls to who nametags of players on this team are visible to.

Parameters:

visibility - The Visibility for this team's nametags

getDeathMessageVisibility

Visibility getDeathMessageVisibility()

Gets the Visibility which controls who death Texts for players on this team are visible to.

Returns:

The Visibility for this team's death Texts

setDeathMessageVisibility

void setDeathMessageVisibility(Visibility visibility)

Sets the Visibility which controls who death Texts of players on this team are visible to.

Parameters:

visibility - The Visibility for this team's death Texts

getCollisionRule

CollisionRule getCollisionRule()

Gets the CollisionRule for entities on this team.

Returns:

The CollisionRule for entities on this team

setCollisionRule

void setCollisionRule(CollisionRule rule)

Sets the CollisionRule for entities on this team.

Parameters:

rule - The CollisionRule for entities on this team

getMembers

Set<Text> getMembers()

Gets the Texts representing the members of this team.

Returns:

the Texts for this team's members

addMember

void addMember(Text member)

Adds the specified Text to this team.

While any Text may be added, the Text to use should normally be obtained by calling TeamMember.getTeamRepresentation() on a TeamMember, such as a Player.

Parameters:

member - the Text to add

removeMember

boolean removeMember(Text member)

Removes the specified Text from this team.

While any Text may be removed, the Text to use should normally be obtained by calling TeamMember.getTeamRepresentation() on a TeamMember, such as a Player.

Parameters:

member - The Text to remove

Returns:

Whether the Text was on this team

getScoreboard

Optional<Scoreboard> getScoreboard()

Returns the scoreboard this team is registered on, if available.

This will return Optional.empty() when a team has been removed from its Scoreboard, or has been created but not yet registered.

Returns:

The scoreboard this team is registered on, if available.

unregister

boolean unregister()

Unregisters this team from its Scoreboard, if present.

A team can still be fully used after being unregistered. However, it will not affect the game in any way until registered to a Scoreboard again, through Scoreboard.registerTeam(Team).

Returns:

Whether this team was registered to a Scoreboard.