Package org.spongepowered.api.entity.living.player.tab

Interface TabList

public interface TabList

Represents a Player's tab list.

Method Summary

Modifier and Type	Method	Description
TabList	addEntry(TabListEntry entry)	Adds an entry to the list.
Collection<TabListEntry>	entries()	Gets the entries on the list.
Optional<TabListEntry>	entry(UUID uniqueId)	Gets a TabListEntry matching the specified unique id.
Optional<Component>	footer()	Gets this list's footer.
Optional<Component>	header()	Gets this list's header.
ServerPlayer	player()	Gets the associated player with this TabList.
Optional<TabListEntry>	removeEntry(UUID uniqueId)	Removes an entry from the list.
TabList	setFooter(@Nullable Component footer)	Sets this list's footer.
TabList	setHeader(@Nullable Component header)	Sets this list's header.
default TabList	setHeaderAndFooter(@Nullable Component header, @Nullable Component footer)	Sets this list's header and footer.

Method Detail

player

ServerPlayer player()

Gets the associated player with this TabList.

Returns:

The associated player

header

Optional<Component> header()

Gets this list's header.

Returns:

The current header

setHeader

TabList setHeader(@Nullable Component header)

Sets this list's header.

When null is passed, an empty Component will be sent.

Parameters:

header - The new header

Returns:

This tab list, for chaining

footer

Optional<Component> footer()

Gets this list's footer.

Returns:

The current footer

setFooter

TabList setFooter(@Nullable Component footer)

Sets this list's footer.

When null is passed, an empty Component will be sent.

Parameters:

footer - The new footer

Returns:

This tab list, for chaining

setHeaderAndFooter

default TabList setHeaderAndFooter(@Nullable Component header,
                                   @Nullable Component footer)

Sets this list's header and footer.

When null is passed, an empty Component will be sent.

Parameters:

header - The new header

footer - The new footer

Returns:

This tab list, for chaining

entries

Collection<TabListEntry> entries()

Gets the entries on the list.

The returned collection should be immutable.

Returns:

The entries on the list

entry

Optional<TabListEntry> entry(UUID uniqueId)

Gets a TabListEntry matching the specified unique id.

Parameters:

uniqueId - The unique id to search for

Returns:

The entry if present, otherwise Optional.empty()

addEntry

TabList addEntry(TabListEntry entry)
          throws IllegalArgumentException

Adds an entry to the list.

Parameters:

entry - The entry to add

Returns:

This tab list, for chaining

Throws:

IllegalArgumentException - if an entry already with the same unique id exists on the list

IllegalStateException - if the provided entry was not

removeEntry

Optional<TabListEntry> removeEntry(UUID uniqueId)

Removes an entry from the list.

Note that if this is used on a player, but they remain visible in-game, their skin will not work.

Parameters:

uniqueId - The unique id of the entry to remove

Returns:

The entry that was associated with the unique id