Package com.velocitypowered.api.proxy.player

Class TabListEntry.Builder

java.lang.Object

com.velocitypowered.api.proxy.player.TabListEntry.Builder

Enclosing interface:

TabListEntry

public static class TabListEntry.Builder
extends Object

Represents a builder which creates TabListEntrys.

See Also:

• TabListEntry

Method Summary

Modifier and Type	Method	Description
TabListEntry	build()	Constructs the TabListEntry specified by this TabListEntry.Builder.
TabListEntry.Builder	chatSession(ChatSession chatSession)	Sets the IdentifiedKey of the TabListEntry.
TabListEntry.Builder	displayName(@Nullable Component displayName)	Sets the displayed name of the TabListEntry.
TabListEntry.Builder	gameMode(int gameMode)	Sets the game mode of the TabListEntry.
TabListEntry.Builder	latency(int latency)	Sets the latency of the TabListEntry.
TabListEntry.Builder	listed(boolean listed)	Sets whether this entry should be visible.
TabListEntry.Builder	listOrder(int order)	Sets the order/priority of this entry in the tab list.
TabListEntry.Builder	profile(GameProfile profile)	Sets the GameProfile of the TabListEntry.
TabListEntry.Builder	tabList(TabList tabList)	Sets the parent TabList for this entry, the entry will only be able to be added to that specific TabList.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

tabList

public TabListEntry.Builder tabList(TabList tabList)

Sets the parent TabList for this entry, the entry will only be able to be added to that specific TabList.

Parameters:

tabList - to set

Returns:

this, for chaining

profile

public TabListEntry.Builder profile(GameProfile profile)

Sets the GameProfile of the TabListEntry.

Parameters:

profile - to set

Returns:

this, for chaining

See Also:

• TabListEntry.getProfile()

chatSession

public TabListEntry.Builder chatSession(ChatSession chatSession)

Sets the IdentifiedKey of the TabListEntry.

This only works for players currently not connected to this proxy.

For any player currently connected to this proxy this will be filled automatically.

Will ignore mismatching key revisions data.

Parameters:

chatSession - session to set

Returns:

this, for chaining

See Also:

• TabListEntry.getChatSession()

displayName

public TabListEntry.Builder displayName(@Nullable Component displayName)

Sets the displayed name of the TabListEntry.

Parameters:

displayName - to set

Returns:

this, for chaining

See Also:

• ()

latency

public TabListEntry.Builder latency(int latency)

Sets the latency of the TabListEntry.

Parameters:

latency - to set

Returns:

this, for chaining

See Also:

• TabListEntry.getLatency()

gameMode

public TabListEntry.Builder gameMode(int gameMode)

Sets the game mode of the TabListEntry.

Parameters:

gameMode - to set

Returns:

this, for chaining

See Also:

• TabListEntry.getGameMode()

listed

public TabListEntry.Builder listed(boolean listed)

Sets whether this entry should be visible.

Parameters:

listed - to set

Returns:

${code this}, for chaining

See Also:

• TabListEntry.isListed()

listOrder

public TabListEntry.Builder listOrder(int order)

Sets the order/priority of this entry in the tab list.

Parameters:

order - to set

Returns:

${code this}, for chaining

See Also:

• TabListEntry.getListOrder()

Since Minecraft:

1.21.2

build

public TabListEntry build()

Constructs the TabListEntry specified by this TabListEntry.Builder.

Returns:

the constructed TabListEntry