Package org.bukkit.scoreboard
Interface Team
public interface Team
A team on a scoreboard that has a common display theme and other
properties. This team is only relevant to the display of the associated
scoreboard
.-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic enum
Represents an option which may be applied to this team.static enum
How an option may be applied to members of this team. -
Method Summary
Modifier and TypeMethodDescriptionvoid
This puts the specified entry onto this team for the scoreboard.void
addPlayer
(OfflinePlayer player) Deprecated.Teams can contain entries that aren't playersboolean
Gets the team friendly fire stateboolean
Gets the team's ability to seeinvisible
teammates.getColor()
Gets the color of the team.Gets the name displayed to entries for this teamGets the Set of entries on the teamgetName()
Gets the name of this TeamDeprecated.getOption
(Team.Option option) Get an option for this teamDeprecated.Teams can contain entries that aren't playersGets the prefix prepended to the display of entries on this team.Gets the Scoreboard to which this team is attachedint
getSize()
Gets the size of the teamGets the suffix appended to the display of entries on this team.boolean
Checks to see if the specified entry is a member of this team.boolean
hasPlayer
(OfflinePlayer player) Deprecated.Teams can contain entries that aren't playersboolean
removeEntry
(String entry) Removes the entry from this team.boolean
removePlayer
(OfflinePlayer player) Deprecated.Teams can contain entries that aren't playersvoid
setAllowFriendlyFire
(boolean enabled) Sets the team friendly fire statevoid
setCanSeeFriendlyInvisibles
(boolean enabled) Sets the team's ability to seeinvisible
teammates.void
Sets the color of the team.void
setDisplayName
(String displayName) Sets the name displayed to entries for this teamvoid
setNameTagVisibility
(NameTagVisibility visibility) void
setOption
(Team.Option option, Team.OptionStatus status) Set an option for this teamvoid
Sets the prefix prepended to the display of entries on this team.void
Sets the suffix appended to the display of entries on this team.void
Unregisters this team from the Scoreboard
-
Method Details
-
getName
Gets the name of this Team- Returns:
- Objective name
- Throws:
IllegalStateException
- if this team has been unregistered
-
getDisplayName
Gets the name displayed to entries for this team- Returns:
- Team display name
- Throws:
IllegalStateException
- if this team has been unregistered
-
setDisplayName
void setDisplayName(@NotNull String displayName) throws IllegalStateException, IllegalArgumentException Sets the name displayed to entries for this team- Parameters:
displayName
- New display name- Throws:
IllegalArgumentException
- if displayName is longer than 128 characters.IllegalStateException
- if this team has been unregistered
-
getPrefix
Gets the prefix prepended to the display of entries on this team.- Returns:
- Team prefix
- Throws:
IllegalStateException
- if this team has been unregistered
-
setPrefix
Sets the prefix prepended to the display of entries on this team.- Parameters:
prefix
- New prefix- Throws:
IllegalArgumentException
- if prefix is nullIllegalArgumentException
- if prefix is longer than 64 charactersIllegalStateException
- if this team has been unregistered
-
getSuffix
Gets the suffix appended to the display of entries on this team.- Returns:
- the team's current suffix
- Throws:
IllegalStateException
- if this team has been unregistered
-
setSuffix
Sets the suffix appended to the display of entries on this team.- Parameters:
suffix
- the new suffix for this team.- Throws:
IllegalArgumentException
- if suffix is nullIllegalArgumentException
- if suffix is longer than 64 charactersIllegalStateException
- if this team has been unregistered
-
getColor
Gets the color of the team.
This only sets the team outline, other occurrences of colors such as in names are handled by prefixes / suffixes.- Returns:
- team color, defaults to
ChatColor.RESET
- Throws:
IllegalStateException
- if this team has been unregistered
-
setColor
Sets the color of the team.
This only sets the team outline, other occurrences of colors such as in names are handled by prefixes / suffixes.- Parameters:
color
- new color, must be non-null. UseChatColor.RESET
for no color
-
allowFriendlyFire
Gets the team friendly fire state- Returns:
- true if friendly fire is enabled
- Throws:
IllegalStateException
- if this team has been unregistered
-
setAllowFriendlyFire
Sets the team friendly fire state- Parameters:
enabled
- true if friendly fire is to be allowed- Throws:
IllegalStateException
- if this team has been unregistered
-
canSeeFriendlyInvisibles
Gets the team's ability to seeinvisible
teammates.- Returns:
- true if team members can see invisible members
- Throws:
IllegalStateException
- if this team has been unregistered
-
setCanSeeFriendlyInvisibles
Sets the team's ability to seeinvisible
teammates.- Parameters:
enabled
- true if invisible teammates are to be visible- Throws:
IllegalStateException
- if this team has been unregistered
-
getNameTagVisibility
Deprecated.Gets the team's ability to see name tags- Returns:
- the current name tag visibility for the team
- Throws:
IllegalArgumentException
- if this team has been unregistered
-
setNameTagVisibility
@Deprecated void setNameTagVisibility(@NotNull NameTagVisibility visibility) throws IllegalArgumentException Deprecated.Set's the team's ability to see name tags- Parameters:
visibility
- The nameTagVisibility to set- Throws:
IllegalArgumentException
- if this team has been unregistered
-
getPlayers
Deprecated.Teams can contain entries that aren't playersGets the Set of players on the team- Returns:
- players on the team
- Throws:
IllegalStateException
- if this team has been unregistered- See Also:
-
getEntries
Gets the Set of entries on the team- Returns:
- entries on the team
- Throws:
IllegalStateException
- if this entries has been unregistered\
-
getSize
Gets the size of the team- Returns:
- number of entries on the team
- Throws:
IllegalStateException
- if this team has been unregistered
-
getScoreboard
Gets the Scoreboard to which this team is attached- Returns:
- Owning scoreboard, or null if this team has been
unregistered
-
addPlayer
@Deprecated void addPlayer(@NotNull OfflinePlayer player) throws IllegalStateException, IllegalArgumentException Deprecated.Teams can contain entries that aren't playersThis puts the specified player onto this team for the scoreboard.This will remove the player from any other team on the scoreboard.
- Parameters:
player
- the player to add- Throws:
IllegalArgumentException
- if player is nullIllegalStateException
- if this team has been unregistered- See Also:
-
addEntry
This puts the specified entry onto this team for the scoreboard.This will remove the entry from any other team on the scoreboard.
- Parameters:
entry
- the entry to add- Throws:
IllegalArgumentException
- if entry is nullIllegalStateException
- if this team has been unregistered
-
removePlayer
@Deprecated boolean removePlayer(@NotNull OfflinePlayer player) throws IllegalStateException, IllegalArgumentException Deprecated.Teams can contain entries that aren't playersRemoves the player from this team.- Parameters:
player
- the player to remove- Returns:
- if the player was on this team
- Throws:
IllegalArgumentException
- if player is nullIllegalStateException
- if this team has been unregistered- See Also:
-
removeEntry
Removes the entry from this team.- Parameters:
entry
- the entry to remove- Returns:
- if the entry was a part of this team
- Throws:
IllegalArgumentException
- if entry is nullIllegalStateException
- if this team has been unregistered
-
unregister
Unregisters this team from the Scoreboard- Throws:
IllegalStateException
- if this team has been unregistered
-
hasPlayer
@Deprecated boolean hasPlayer(@NotNull OfflinePlayer player) throws IllegalArgumentException, IllegalStateException Deprecated.Teams can contain entries that aren't playersChecks to see if the specified player is a member of this team.- Parameters:
player
- the player to search for- Returns:
- true if the player is a member of this team
- Throws:
IllegalArgumentException
- if player is nullIllegalStateException
- if this team has been unregistered- See Also:
-
hasEntry
Checks to see if the specified entry is a member of this team.- Parameters:
entry
- the entry to search for- Returns:
- true if the entry is a member of this team
- Throws:
IllegalArgumentException
- if entry is nullIllegalStateException
- if this team has been unregistered
-
getOption
Get an option for this team- Parameters:
option
- the option to get- Returns:
- the option status
- Throws:
IllegalStateException
- if this team has been unregistered
-
setOption
void setOption(@NotNull Team.Option option, @NotNull Team.OptionStatus status) throws IllegalStateException Set an option for this team- Parameters:
option
- the option to setstatus
- the new option status- Throws:
IllegalStateException
- if this team has been unregistered
-