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

Interface TabList

public interface TabList

Represents a Player's tab list.

Method Summary

Modifier and Type	Method and Description
TabList	addEntry(TabListEntry entry) Adds an entry to the list.
Collection<TabListEntry>	getEntries() Gets the entries on the list.
Optional<TabListEntry>	getEntry(UUID uniqueId) Gets a TabListEntry matching the specified unique id.
Optional<Text>	getFooter() Gets this list's footer.
Optional<Text>	getHeader() Gets this list's header.
Player	getPlayer() Gets the associated Player with this TabList.
Optional<TabListEntry>	removeEntry(UUID uniqueId) Removes an entry from the list.
TabList	setFooter(Text footer) Sets this list's footer.
TabList	setHeader(Text header) Sets this list's header.
default TabList	setHeaderAndFooter(Text header, Text footer) Sets this list's header and footer.

Method Detail

getPlayer

Player getPlayer()

Gets the associated Player with this TabList.

Returns:

The associated player

getHeader

Optional<Text> getHeader()

Gets this list's header.

Returns:

The current header

setHeader

TabList setHeader(@Nullable
                  Text header)

Sets this list's header.

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

Parameters:

header - The new header

Returns:

This tab list, for chaining

getFooter

Optional<Text> getFooter()

Gets this list's footer.

Returns:

The current footer

setFooter

TabList setFooter(@Nullable
                  Text footer)

Sets this list's footer.

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

Parameters:

footer - The new footer

Returns:

This tab list, for chaining

setHeaderAndFooter

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

Sets this list's header and footer.

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

Parameters:

header - The new header

footer - The new footer

Returns:

This tab list, for chaining

getEntries

Collection<TabListEntry> getEntries()

Gets the entries on the list.

The returned collection should be immutable.

Returns:

The entries on the list

getEntry

Optional<TabListEntry> getEntry(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