Interface TabList


  • public interface TabList
    Represents the tab list of a Player.
    • Method Detail

      • setHeaderAndFooter

        void setHeaderAndFooter​(net.kyori.adventure.text.Component header,
                                net.kyori.adventure.text.Component footer)
        Sets the tab list header and footer for the player.
        Parameters:
        header - the header component
        footer - the footer component
      • clearHeaderAndFooter

        void clearHeaderAndFooter()
        Clears the tab list header and footer for the player.
      • removeEntry

        java.util.Optional<TabListEntry> removeEntry​(java.util.UUID uuid)
        Removes the TabListEntry from the tab list with the GameProfile identified with the specified UUID.
        Parameters:
        uuid - of the entry
        Returns:
        Optional containing the removed TabListEntry if present, otherwise Optional.empty()
      • containsEntry

        boolean containsEntry​(java.util.UUID uuid)
        Determines if the specified entry exists in the tab list.
        Parameters:
        uuid - the UUID of the entry
        Returns:
        true if it exists, false if it does not
      • getEntries

        java.util.Collection<TabListEntry> getEntries()
        Returns an immutable Collection of the TabListEntrys in the tab list.
        Returns:
        immutable Collection of tab list entries
      • buildEntry

        @Deprecated
        TabListEntry buildEntry​(GameProfile profile,
                                @Nullable net.kyori.adventure.text.Component displayName,
                                int latency,
                                int gameMode)
        Deprecated.
        Internal usage. Use TabListEntry.Builder instead.
        Builds a tab list entry.
        Parameters:
        profile - profile
        displayName - display name
        latency - latency
        gameMode - game mode
        Returns:
        entry