TabListEntry (velocity-api 1.1.0 API)

```
public interface TabListEntry
```
Represents a single entry in a TabList.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class TabListEntry.Builder
Represents a builder which creates TabListEntrys.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`TabListEntry.Builder` Represents a builder which creates `TabListEntry`s.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`static TabListEntry.Builder`	`builder()` Returns a `TabListEntry.Builder` to create a `TabListEntry`.
`Optional<net.kyori.text.Component>`	`getDisplayName()` Deprecated. Use `getDisplayNameComponent()` instead
`Optional<net.kyori.adventure.text.Component>`	`getDisplayNameComponent()` Returns `Optional` text `Component`, which if present is the text displayed for `this` entry in the `TabList`, otherwise `GameProfile.getName()` is shown.
`int`	`getGameMode()` Gets the game mode `this` entry has been set to.
`int`	`getLatency()` Returns the latency for `this` entry.
`GameProfile`	`getProfile()` 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`	`getTabList()` Returns the parent `TabList` of this `this` `TabListEntry`.
`TabListEntry`	`setDisplayName(net.kyori.text.Component displayName)` Deprecated. Use `setDisplayName(Component)` instead
`TabListEntry`	`setDisplayName(@Nullable net.kyori.adventure.text.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`	`setLatency(int latency)` Sets the latency for `this` entry to the specified value.

- Method Detail
  - getTabList
```
TabList getTabList()
```
    Returns the parent TabList of this this TabListEntry.
    
    Returns:
    
    parent TabList
  - getProfile
```
GameProfile getProfile()
```
    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
  - getDisplayName
```
@Deprecated
Optional<net.kyori.text.Component> getDisplayName()
```
    Deprecated. Use getDisplayNameComponent() instead
    
    Returns Optional text Component, which if present is the text displayed for this entry in the TabList, otherwise GameProfile.getName() is shown.
    
    Returns:
    
    Optional text Component of name displayed in the tab list
  - getDisplayNameComponent
```
Optional<net.kyori.adventure.text.Component> getDisplayNameComponent()
```
    Returns Optional text Component, which if present is the text displayed for this entry in the TabList, otherwise GameProfile.getName() is shown.
    
    Returns:
    
    Optional text Component of name displayed in the tab list
  - setDisplayName
```
@Deprecated
TabListEntry setDisplayName(net.kyori.text.Component displayName)
```
    Deprecated. Use setDisplayName(Component) instead
    
    Sets the text Component to be displayed for this TabListEntry. If null, GameProfile.getName() will be shown.
    
    Parameters:
    
    displayName - to show in the TabList for this entry
    
    Returns:
    
    this, for chaining
  - setDisplayName
```
TabListEntry setDisplayName(@Nullable net.kyori.adventure.text.Component displayName)
```
    Sets the text Component to be displayed for this TabListEntry. If null, GameProfile.getName() will be shown.
    
    Parameters:
    
    displayName - to show in the TabList for this entry
    
    Returns:
    
    this, for chaining
  - getLatency
```
int getLatency()
```
    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
  - setLatency
```
TabListEntry setLatency(int latency)
```
    Sets the latency for this entry to the specified value.
    
    Parameters:
    
    latency - to changed to
    
    Returns:
    
    this, for chaining
    
    See Also:
    
    getLatency()
  - getGameMode
```
int getGameMode()
```
    Gets the game mode this entry has been set to.
    The number corresponds to the game mode in the following way:
    1. Survival
    2. Creative
    3. Adventure
    4. 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:
    
    getGameMode()
  - builder
```
static TabListEntry.Builder builder()
```
    Returns a TabListEntry.Builder to create a TabListEntry.
    
    Returns:
    
    TabListEntry builder

Interface TabListEntry

Nested Class Summary

Method Summary

Method Detail

getTabList

getProfile

getDisplayName

getDisplayNameComponent

setDisplayName

setDisplayName

getLatency

setLatency

getGameMode

setGameMode

builder