程序包 org.bukkit.scoreboard

接口 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.

嵌套类概要

嵌套类

修饰符和类型	接口	说明
static enum	Team.Option	Represents an option which may be applied to this team.
static enum	Team.OptionStatus	How an option may be applied to members of this team.

方法概要

修饰符和类型	方法	说明
void	addEntry(String entry)	This puts the specified entry onto this team for the scoreboard.
void	addPlayer(OfflinePlayer player)	已过时。 Teams can contain entries that aren't players
boolean	allowFriendlyFire()	Gets the team friendly fire state
boolean	canSeeFriendlyInvisibles()	Gets the team's ability to see invisible teammates.
ChatColor	getColor()	Gets the color of the team.
String	getDisplayName()	Gets the name displayed to entries for this team
Set<String>	getEntries()	Gets the Set of entries on the team
String	getName()	Gets the name of this Team
NameTagVisibility	getNameTagVisibility()	已过时。 see getOption(org.bukkit.scoreboard.Team.Option)
Team.OptionStatus	getOption(Team.Option option)	Get an option for this team
Set<OfflinePlayer>	getPlayers()	已过时。 Teams can contain entries that aren't players
String	getPrefix()	Gets the prefix prepended to the display of entries on this team.
Scoreboard	getScoreboard()	Gets the Scoreboard to which this team is attached
int	getSize()	Gets the size of the team
String	getSuffix()	Gets the suffix appended to the display of entries on this team.
boolean	hasEntry(String entry)	Checks to see if the specified entry is a member of this team.
boolean	hasPlayer(OfflinePlayer player)	已过时。 Teams can contain entries that aren't players
boolean	removeEntry(String entry)	Removes the entry from this team.
boolean	removePlayer(OfflinePlayer player)	已过时。 Teams can contain entries that aren't players
void	setAllowFriendlyFire(boolean enabled)	Sets the team friendly fire state
void	setCanSeeFriendlyInvisibles(boolean enabled)	Sets the team's ability to see invisible teammates.
void	setColor(ChatColor color)	Sets the color of the team.
void	setDisplayName(String displayName)	Sets the name displayed to entries for this team
void	setNameTagVisibility(NameTagVisibility visibility)	已过时。 see setOption(org.bukkit.scoreboard.Team.Option, org.bukkit.scoreboard.Team.OptionStatus)
void	setOption(Team.Option option, Team.OptionStatus status)	Set an option for this team
void	setPrefix(String prefix)	Sets the prefix prepended to the display of entries on this team.
void	setSuffix(String suffix)	Sets the suffix appended to the display of entries on this team.
void	unregister()	Unregisters this team from the Scoreboard

方法详细资料

getName

String getName()
        throws IllegalStateException

Gets the name of this Team

返回:

Objective name

抛出:

IllegalStateException - if this team has been unregistered

getDisplayName

String getDisplayName()
               throws IllegalStateException

Gets the name displayed to entries for this team

返回:

Team display name

抛出:

IllegalStateException - if this team has been unregistered

setDisplayName

void setDisplayName(String displayName)
             throws IllegalStateException,
IllegalArgumentException

Sets the name displayed to entries for this team

参数:

displayName - New display name

抛出:

IllegalArgumentException - if displayName is longer than 32 characters.

IllegalStateException - if this team has been unregistered

getPrefix

String getPrefix()
          throws IllegalStateException

Gets the prefix prepended to the display of entries on this team.

返回:

Team prefix

抛出:

IllegalStateException - if this team has been unregistered

setPrefix

void setPrefix(String prefix)
        throws IllegalStateException,
IllegalArgumentException

Sets the prefix prepended to the display of entries on this team.

参数:

prefix - New prefix

抛出:

IllegalArgumentException - if prefix is null

IllegalArgumentException - if prefix is longer than 16 characters

IllegalStateException - if this team has been unregistered

getSuffix

String getSuffix()
          throws IllegalStateException

Gets the suffix appended to the display of entries on this team.

返回:

the team's current suffix

抛出:

IllegalStateException - if this team has been unregistered

setSuffix

void setSuffix(String suffix)
        throws IllegalStateException,
IllegalArgumentException

Sets the suffix appended to the display of entries on this team.

参数:

suffix - the new suffix for this team.

抛出:

IllegalArgumentException - if suffix is null

IllegalArgumentException - if suffix is longer than 16 characters

IllegalStateException - if this team has been unregistered

getColor

ChatColor getColor()
            throws IllegalStateException

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.

返回:

team color, defaults to ChatColor.RESET

抛出:

IllegalStateException

setColor

void setColor(ChatColor color)

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.

参数:

color - new color, must be non-null. Use ChatColor.RESET for no color

allowFriendlyFire

boolean allowFriendlyFire()
                   throws IllegalStateException

Gets the team friendly fire state

返回:

true if friendly fire is enabled

抛出:

IllegalStateException - if this team has been unregistered

setAllowFriendlyFire

void setAllowFriendlyFire(boolean enabled)
                   throws IllegalStateException

Sets the team friendly fire state

参数:

enabled - true if friendly fire is to be allowed

抛出:

IllegalStateException - if this team has been unregistered

canSeeFriendlyInvisibles

boolean canSeeFriendlyInvisibles()
                          throws IllegalStateException

Gets the team's ability to see invisible teammates.

返回:

true if team members can see invisible members

抛出:

IllegalStateException - if this team has been unregistered

setCanSeeFriendlyInvisibles

void setCanSeeFriendlyInvisibles(boolean enabled)
                          throws IllegalStateException

Sets the team's ability to see invisible teammates.

参数:

enabled - true if invisible teammates are to be visible

抛出:

IllegalStateException - if this team has been unregistered

getNameTagVisibility

@Deprecated
NameTagVisibility getNameTagVisibility()
                                throws IllegalArgumentException

已过时。

see getOption(org.bukkit.scoreboard.Team.Option)

Gets the team's ability to see name tags

返回:

the current name tag visibility for the team

抛出:

IllegalArgumentException - if this team has been unregistered

setNameTagVisibility

@Deprecated
void setNameTagVisibility(NameTagVisibility visibility)
                   throws IllegalArgumentException

已过时。

see setOption(org.bukkit.scoreboard.Team.Option, org.bukkit.scoreboard.Team.OptionStatus)

Set's the team's ability to see name tags

参数:

visibility - The nameTagVisibilty to set

抛出:

IllegalArgumentException - if this team has been unregistered

getPlayers

@Deprecated
Set<OfflinePlayer> getPlayers()
                       throws IllegalStateException

已过时。

Teams can contain entries that aren't players

Gets the Set of players on the team

返回:

players on the team

抛出:

IllegalStateException - if this team has been unregistered\

另请参阅:

• getEntries()

getEntries

Set<String> getEntries()
                throws IllegalStateException

Gets the Set of entries on the team

返回:

entries on the team

抛出:

IllegalStateException - if this entries has been unregistered\

getSize

int getSize()
     throws IllegalStateException

Gets the size of the team

返回:

number of entries on the team

抛出:

IllegalStateException - if this team has been unregistered

getScoreboard

Scoreboard getScoreboard()

Gets the Scoreboard to which this team is attached

返回:

Owning scoreboard, or null if this team has been unregistered

addPlayer

@Deprecated
void addPlayer(OfflinePlayer player)
        throws IllegalStateException,
IllegalArgumentException

已过时。

Teams can contain entries that aren't players

This puts the specified player onto this team for the scoreboard.

This will remove the player from any other team on the scoreboard.

参数:

player - the player to add

抛出:

IllegalArgumentException - if player is null

IllegalStateException - if this team has been unregistered

另请参阅:

• addEntry(String)

addEntry

void addEntry(String entry)
       throws IllegalStateException,
IllegalArgumentException

This puts the specified entry onto this team for the scoreboard.

This will remove the entry from any other team on the scoreboard.

参数:

entry - the entry to add

抛出:

IllegalArgumentException - if entry is null

IllegalStateException - if this team has been unregistered

removePlayer

@Deprecated
boolean removePlayer(OfflinePlayer player)
              throws IllegalStateException,
IllegalArgumentException

已过时。

Teams can contain entries that aren't players

Removes the player from this team.

参数:

player - the player to remove

返回:

if the player was on this team

抛出:

IllegalArgumentException - if player is null

IllegalStateException - if this team has been unregistered

另请参阅:

• removeEntry(String)

removeEntry

boolean removeEntry(String entry)
             throws IllegalStateException,
IllegalArgumentException

Removes the entry from this team.

参数:

entry - the entry to remove

返回:

if the entry was a part of this team

抛出:

IllegalArgumentException - if entry is null

IllegalStateException - if this team has been unregistered

unregister

void unregister()
         throws IllegalStateException

Unregisters this team from the Scoreboard

抛出:

IllegalStateException - if this team has been unregistered

hasPlayer

@Deprecated
boolean hasPlayer(OfflinePlayer player)
           throws IllegalArgumentException,
IllegalStateException

已过时。

Teams can contain entries that aren't players

Checks to see if the specified player is a member of this team.

参数:

player - the player to search for

返回:

true if the player is a member of this team

抛出:

IllegalArgumentException - if player is null

IllegalStateException - if this team has been unregistered

另请参阅:

• hasEntry(String)

hasEntry

boolean hasEntry(String entry)
          throws IllegalArgumentException,
IllegalStateException

Checks to see if the specified entry is a member of this team.

参数:

entry - the entry to search for

返回:

true if the entry is a member of this team

抛出:

IllegalArgumentException - if entry is null

IllegalStateException - if this team has been unregistered

getOption

Team.OptionStatus getOption(Team.Option option)
                     throws IllegalStateException

Get an option for this team

参数:

option - the option to get

返回:

the option status

抛出:

IllegalStateException - if this team has been unregistered

setOption

void setOption(Team.Option option,
 Team.OptionStatus status)
        throws IllegalStateException

Set an option for this team

参数:

option - the option to set

status - the new option status

抛出:

IllegalStateException - if this team has been unregistered