Package me.neznamy.tab.shared.features

Class PlayerList

java.lang.Object
me.neznamy.tab.api.TabFeature
me.neznamy.tab.shared.features.PlayerList
All Implemented Interfaces:
me.neznamy.tab.api.TablistFormatManager
Direct Known Subclasses:
AlignedPlayerList
public class PlayerList extends me.neznamy.tab.api.TabFeature implements me.neznamy.tab.api.TablistFormatManager
Feature handler for TabList display names

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final boolean
    antiOverrideTabList
    Config option toggling anti-override which prevents other plugins from overriding TAB

    Fields inherited from class me.neznamy.tab.api.TabFeature

    disabledServers, disabledWorlds

  • Constructor Summary

    Constructors
    Constructor
    Description
    PlayerList()
    Constructs new instance and sends debug message that feature loaded.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCustomName(me.neznamy.tab.api.TabPlayer player)
     
    String
    getCustomPrefix(me.neznamy.tab.api.TabPlayer player)
     
    String
    getCustomSuffix(me.neznamy.tab.api.TabPlayer player)
     
    String
    getOriginalName(me.neznamy.tab.api.TabPlayer player)
     
    String
    getOriginalPrefix(me.neznamy.tab.api.TabPlayer player)
     
    String
    getOriginalSuffix(me.neznamy.tab.api.TabPlayer player)
     
    me.neznamy.tab.api.chat.IChatBaseComponent
    getTabFormat(me.neznamy.tab.api.TabPlayer p, me.neznamy.tab.api.TabPlayer viewer)
    Returns TabList format of player for viewer
    UUID
    getTablistUUID(me.neznamy.tab.api.TabPlayer p, me.neznamy.tab.api.TabPlayer viewer)
    Returns UUID of tablist entry representing this player.
    void
    load()
     
    void
    onJoin(me.neznamy.tab.api.TabPlayer connectedPlayer)
     
    void
    onPlayerInfo(me.neznamy.tab.api.TabPlayer receiver, me.neznamy.tab.api.protocol.PacketPlayOutPlayerInfo info)
     
    void
    onServerChange(me.neznamy.tab.api.TabPlayer p, String from, String to)
     
    void
    onWorldChange(me.neznamy.tab.api.TabPlayer p, String from, String to)
     
    void
    refresh(me.neznamy.tab.api.TabPlayer refreshed, boolean force)
     
    void
    resetName(me.neznamy.tab.api.TabPlayer player)
     
    void
    resetPrefix(me.neznamy.tab.api.TabPlayer player)
     
    void
    resetSuffix(me.neznamy.tab.api.TabPlayer player)
     
    void
    setName(me.neznamy.tab.api.TabPlayer player, String customName)
     
    void
    setPrefix(me.neznamy.tab.api.TabPlayer player, String prefix)
     
    void
    setSuffix(me.neznamy.tab.api.TabPlayer player, String suffix)
     
    void
    unload()
     
    protected void
    updatePlayer(me.neznamy.tab.api.TabPlayer p, boolean format)
    Updates TabList format of requested player to everyone.
    protected boolean
    updateProperties(me.neznamy.tab.api.TabPlayer p)
    Loads all properties from config and returns true if at least one of them either wasn't loaded or changed value, false otherwise.

    Methods inherited from class me.neznamy.tab.api.TabFeature

    addDisabledPlayer, addUsedPlaceholders, contains, getFeatureName, getRefreshDisplayName, isDisabled, isDisabledPlayer, onCommand, onDisplayObjective, onLoginPacket, onObjective, onPacketReceive, onPacketSend, onQuit, onVanishStatusChange, overridesMethod, removeDisabledPlayer

    Methods inherited from class java.lang.Object

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

  • Field Details

    • antiOverrideTabList

      protected final boolean antiOverrideTabList
      Config option toggling anti-override which prevents other plugins from overriding TAB

  • Constructor Details

    • PlayerList

      public PlayerList()
      Constructs new instance and sends debug message that feature loaded.

  • Method Details

    • getTablistUUID

      public UUID getTablistUUID(me.neznamy.tab.api.TabPlayer p, me.neznamy.tab.api.TabPlayer viewer)
      Returns UUID of tablist entry representing this player. If layout feature is enabled, returns UUID of the layout slot where the player should be. When it's not enabled, returns player's TabList UUID, which may not match with player's actual UUID due to velocity.
      Parameters:
      p - Player to get tablist UUID of
      viewer - TabList viewer
      Returns:
      UUID of TabList entry representing requested player

    • updateProperties

      protected boolean updateProperties(me.neznamy.tab.api.TabPlayer p)
      Loads all properties from config and returns true if at least one of them either wasn't loaded or changed value, false otherwise.
      Parameters:
      p - Player to update properties of
      Returns:
      true if at least one property changed, false if not

    • updatePlayer

      protected void updatePlayer(me.neznamy.tab.api.TabPlayer p, boolean format)
      Updates TabList format of requested player to everyone.
      Parameters:
      p - Player to update
      format - Whether player's actual format should be used or null for reset

    • getTabFormat

      public me.neznamy.tab.api.chat.IChatBaseComponent getTabFormat(me.neznamy.tab.api.TabPlayer p, me.neznamy.tab.api.TabPlayer viewer)
      Returns TabList format of player for viewer
      Parameters:
      p - Player to get format of
      viewer - Viewer seeing the format
      Returns:
      Format of specified player for viewer

    • load

      public void load()
      Overrides:
      load in class me.neznamy.tab.api.TabFeature

    • unload

      public void unload()
      Overrides:
      unload in class me.neznamy.tab.api.TabFeature

    • onServerChange

      public void onServerChange(me.neznamy.tab.api.TabPlayer p, String from, String to)
      Overrides:
      onServerChange in class me.neznamy.tab.api.TabFeature

    • onWorldChange

      public void onWorldChange(me.neznamy.tab.api.TabPlayer p, String from, String to)
      Overrides:
      onWorldChange in class me.neznamy.tab.api.TabFeature

    • refresh

      public void refresh(me.neznamy.tab.api.TabPlayer refreshed, boolean force)
      Overrides:
      refresh in class me.neznamy.tab.api.TabFeature

    • onJoin

      public void onJoin(me.neznamy.tab.api.TabPlayer connectedPlayer)
      Overrides:
      onJoin in class me.neznamy.tab.api.TabFeature

    • onPlayerInfo

      public void onPlayerInfo(me.neznamy.tab.api.TabPlayer receiver, me.neznamy.tab.api.protocol.PacketPlayOutPlayerInfo info)
      Overrides:
      onPlayerInfo in class me.neznamy.tab.api.TabFeature

    • setPrefix

      public void setPrefix(me.neznamy.tab.api.TabPlayer player, String prefix)
      Specified by:
      setPrefix in interface me.neznamy.tab.api.TablistFormatManager

    • setName

      public void setName(me.neznamy.tab.api.TabPlayer player, String customName)
      Specified by:
      setName in interface me.neznamy.tab.api.TablistFormatManager

    • setSuffix

      public void setSuffix(me.neznamy.tab.api.TabPlayer player, String suffix)
      Specified by:
      setSuffix in interface me.neznamy.tab.api.TablistFormatManager

    • resetPrefix

      public void resetPrefix(me.neznamy.tab.api.TabPlayer player)
      Specified by:
      resetPrefix in interface me.neznamy.tab.api.TablistFormatManager

    • resetName

      public void resetName(me.neznamy.tab.api.TabPlayer player)
      Specified by:
      resetName in interface me.neznamy.tab.api.TablistFormatManager

    • resetSuffix

      public void resetSuffix(me.neznamy.tab.api.TabPlayer player)
      Specified by:
      resetSuffix in interface me.neznamy.tab.api.TablistFormatManager

    • getCustomPrefix

      public String getCustomPrefix(me.neznamy.tab.api.TabPlayer player)
      Specified by:
      getCustomPrefix in interface me.neznamy.tab.api.TablistFormatManager

    • getCustomName

      public String getCustomName(me.neznamy.tab.api.TabPlayer player)
      Specified by:
      getCustomName in interface me.neznamy.tab.api.TablistFormatManager

    • getCustomSuffix

      public String getCustomSuffix(me.neznamy.tab.api.TabPlayer player)
      Specified by:
      getCustomSuffix in interface me.neznamy.tab.api.TablistFormatManager

    • getOriginalPrefix

      public String getOriginalPrefix(me.neznamy.tab.api.TabPlayer player)
      Specified by:
      getOriginalPrefix in interface me.neznamy.tab.api.TablistFormatManager

    • getOriginalName

      public String getOriginalName(me.neznamy.tab.api.TabPlayer player)
      Specified by:
      getOriginalName in interface me.neznamy.tab.api.TablistFormatManager

    • getOriginalSuffix

      public String getOriginalSuffix(me.neznamy.tab.api.TabPlayer player)
      Specified by:
      getOriginalSuffix in interface me.neznamy.tab.api.TablistFormatManager