api/org.kryptonmc.api.entity.player/TabList

TabList

interface TabList

A tab list that is used to display information to players.

While the proper name for it is the player list, it is commonly referred to as the tab list, due to the fact that it is generally displayed by pressing the tab key.

Functions

Link copied to clipboard
abstract fun createEntryBuilder(uuid: UUID, profile: GameProfile): TabListEntry.Builder

Creates a new builder for building a tab list entry.

Link copied to clipboard
abstract fun getEntry(uuid: UUID): TabListEntry?

Gets the entry with the given uuid, if it exists.

Link copied to clipboard
abstract fun removeEntry(uuid: UUID): Boolean

Removes the entry with the given uuid from the tab list, returning whether the entry was removed successfully or not.

Link copied to clipboard
abstract fun setHeaderAndFooter(header: Component, footer: Component)

Sets the header and footer of the tab list to the given header and footer values.

Properties

Link copied to clipboard
abstract val entries: Collection<TabListEntry>

The entries shown in the tab list.

Link copied to clipboard
abstract val footer: Component

The footer of the tab list, shown below the entries.

Link copied to clipboard
abstract val header: Component

The header of the tab list, shown above the entries.