Team

interface Team

Represents a team within Housing.

Provides accessors and mutators for the team's metadata (name, tag, color), friendly-fire setting and lifecycle operations.

Implementations perform sequential behavior and therefore expose suspend functions for better interaction with Housing.

Inheritors

Types

Link copied to clipboard

Available display colors for a team.

Properties

Link copied to clipboard
abstract var name: String

The unique name of the team.

Functions

Link copied to clipboard
abstract suspend fun delete()

Deletes this team.

Link copied to clipboard
abstract suspend fun getColor(): Team.TeamColor

Returns the team's display color.

Link copied to clipboard
abstract suspend fun getFriendlyFire(): Boolean

Returns whether friendly fire is enabled for this team.

Link copied to clipboard
open suspend fun getName(): String

Returns the current team name.

Link copied to clipboard
abstract suspend fun getTag(): String

Returns the team's chat/tag string, omitting the brackets.

Link copied to clipboard
abstract suspend fun setColor(newColor: Team.TeamColor): Team

Sets the team's display color.

Link copied to clipboard
abstract suspend fun setFriendlyFire(newFriendlyFire: Boolean): Team

Sets the friendly fire flag for this team.

Link copied to clipboard
abstract suspend fun setName(newName: String): Team

Sets a new name for the team.

Link copied to clipboard
abstract suspend fun setTag(newTag: String): Team

Sets the team's chat/tag string.