api/org.kryptonmc.api.scoreboard/Team

Team

interface Team : ScoreboardBound

A team on a Scoreboard.

Teams are groups of entities that have a name, prefix, suffix, colour, and a specific set of rules they follow.

Types

Link copied to clipboard
interface Builder

A builder for building teams.

Functions

Link copied to clipboard
abstract fun addMember(member: Component): Boolean

Adds a member to the list of members in this team.

Link copied to clipboard
abstract fun formatName(name: Component): Component

Formats the given name according to the options in this team.

Link copied to clipboard
abstract fun removeMember(member: Component): Boolean

Removes a member from the list of members in this team.

Properties

Link copied to clipboard
@get:JvmName(name = "allowFriendlyFire")
abstract var allowFriendlyFire: Boolean

If this team allows members to attack each other.

Link copied to clipboard
@get:JvmName(name = "canSeeInvisibleMembers")
abstract var canSeeInvisibleMembers: Boolean

If this team allows members to see members that are invisible.

Link copied to clipboard
abstract var collisionRule: CollisionRule

The collision rule for the team.

Link copied to clipboard
abstract var color: NamedTextColor

The colour of the team that is displayed on the scoreboard.

Link copied to clipboard
abstract var deathMessageVisibility: Visibility

The visibility of death messages in the team.

Link copied to clipboard
abstract var displayName: Component

The name that is displayed on the scoreboard to clients.

Link copied to clipboard
abstract val members: List<Component>

All of the members in this team.

Link copied to clipboard
abstract val name: String

The name of this team.

Link copied to clipboard
abstract var nameTagVisibility: Visibility

The visibility of name tags in the team.

Link copied to clipboard
abstract var prefix: Component

The prefix prepended to the display name of members of this team.

Link copied to clipboard
abstract val scoreboard: Scoreboard

The scoreboard that this object is bound to.

Link copied to clipboard
abstract var suffix: Component

The suffix appended to the display name of members of this team.