Package com.velocitypowered.api.proxy.player

Interface TabListEntry

public interface TabListEntry

Represents a single entry in a TabList.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TabListEntry.Builder	Represents a builder which creates TabListEntrys.

Method Summary

Modifier and Type	Method	Description
static TabListEntry.Builder	builder()	Returns a TabListEntry.Builder to create a TabListEntry.
@Nullable Component	displayName()	Returns an optional text Component, which if present is the text displayed for this entry in the TabList, otherwise GameProfile.name() is shown.
int	gameMode()	Gets the game mode this entry has been set to.
GameProfile	gameProfile()	Returns the GameProfile of the entry, which uniquely identifies the entry with the containing UUID, as well as deciding what is shown as the player head in the tab list.
TabList	parent()	Returns the parent TabList of this this TabListEntry.
int	ping()	Returns the latency for this entry.
TabListEntry	setDisplayName(@Nullable Component displayName)	Sets the text Component to be displayed for this TabListEntry.
TabListEntry	setGameMode(int gameMode)	Sets the game mode for this entry to the specified value.
TabListEntry	setPing(int latency)	Sets the latency for this entry to the specified value.

Method Detail

parent

TabList parent()

Returns the parent TabList of this this TabListEntry.

Returns:

parent TabList

gameProfile

GameProfile gameProfile()

Returns the GameProfile of the entry, which uniquely identifies the entry with the containing UUID, as well as deciding what is shown as the player head in the tab list.

Returns:

GameProfile of the entry

displayName

@Nullable Component displayName()

Returns an optional text Component, which if present is the text displayed for this entry in the TabList, otherwise GameProfile.name() is shown.

Returns:

text Component of name displayed in the tab list

setDisplayName

TabListEntry setDisplayName(@Nullable Component displayName)

Sets the text Component to be displayed for this TabListEntry. If null, GameProfile.name() will be shown.

Parameters:

displayName - to show in the TabList for this entry

Returns:

this, for chaining

ping

int ping()

Returns the latency for this entry.

The icon shown in the tab list is calculated by the latency as follows:

• A negative latency will display the no connection icon
• 0-150 will display 5 bars
• 150-300 will display 4 bars
• 300-600 will display 3 bars
• 600-1000 will display 2 bars
• A latency move than 1 second will display 1 bar

Returns:

latency set for this entry

setPing

TabListEntry setPing(int latency)

Sets the latency for this entry to the specified value.

Parameters:

latency - to changed to

Returns:

this, for chaining

See Also:

ping()

gameMode

int gameMode()

Gets the game mode this entry has been set to.

The number corresponds to the game mode in the following way:

0. Survival
1. Creative
2. Adventure
3. Spectator

Returns:

the game mode

setGameMode

TabListEntry setGameMode(int gameMode)

Sets the game mode for this entry to the specified value.

Parameters:

gameMode - to change to

Returns:

this, for chaining

See Also:

gameMode()

builder

static TabListEntry.Builder builder()

Returns a TabListEntry.Builder to create a TabListEntry.

Returns:

TabListEntry builder