Package me.neznamy.tab.api

Class TabAPI

java.lang.Object
me.neznamy.tab.api.TabAPI
public abstract class TabAPI extends Object
The primary API class to get instances of other API classes

  • Constructor Details

    • TabAPI

      public TabAPI()

  • Method Details

    • getInstance

      public static TabAPI getInstance()
      Returns API instance. If instance was not set by the plugin, throws IllegalStateException. This is usually caused by shading the API into own project, which is not allowed. Another option is calling the method before plugin was able to load.
      Returns:
      API instance
      Throws:
      IllegalStateException - If instance is null

    • setInstance

      public static void setInstance(TabAPI instance)
      Instance setter for internal use by the plugin only.
      Parameters:
      instance - API instance

    • getPlayer

      public abstract TabPlayer getPlayer(UUID id)
      Returns player object from given UUID
      Parameters:
      id - Player UUID
      Returns:
      player object from given UUID

    • getPlayer

      public abstract TabPlayer getPlayer(String name)
      Returns player object from given name
      Parameters:
      name - Player name
      Returns:
      player object from given name

    • getOnlinePlayers

      public abstract TabPlayer[] getOnlinePlayers()
      Returns collection of all online players. Will return empty list if plugin is disabled (due to a broken configuration file for example).
      Returns:
      collection of online players

    • getBossBarManager

      public abstract BossBarManager getBossBarManager()
      Return BossBar manager instance if the feature is enabled. If not, returns null.
      Returns:
      BossBar manager

    • getScoreboardManager

      public abstract ScoreboardManager getScoreboardManager()
      Returns scoreboard manager instance if the feature is enabled. If not, returns null.
      Returns:
      scoreboard manager

    • getTeamManager

      public abstract TeamManager getTeamManager()
      Returns team manager instance if the feature is enabled. If not, returns null.
      Returns:
      team manager

    • getHeaderFooterManager

      public abstract HeaderFooterManager getHeaderFooterManager()
      Returns header/footer manager instance if the feature is enabled. If not, returns null.
      Returns:
      Header/footer manager

    • getPlaceholderManager

      public abstract PlaceholderManager getPlaceholderManager()
      Returns PlaceholderManager instance
      Returns:
      PlaceholderManager instance

    • getFeatureManager

      public abstract FeatureManager getFeatureManager()
      Returns feature manager instance
      Returns:
      feature manager instance

    • getTablistFormatManager

      public abstract TablistFormatManager getTablistFormatManager()
      Returns Tablist name format manager instance if the feature is enabled. If not, returns null.
      Returns:
      Tablist name format manager

    • getEventBus

      public abstract EventBus getEventBus()
      Gets the event bus for registering listeners for TAB events.
      Returns:
      the event bus

    • getServerVersion

      public abstract ProtocolVersion getServerVersion()
      Returns server version. On proxy installation returns PROXY.
      Returns:
      server version

    • sendConsoleMessage

      public abstract void sendConsoleMessage(String message, boolean translateColors)
      Prints message into console
      Parameters:
      message - message to print
      translateColors - true if colors should be translated, false if not

    • getThreadManager

      public abstract ThreadManager getThreadManager()
      Returns TAB's Thread manager, which allows task submitting
      Returns:
      ThreadManager instance

    • getPlayerCache

      public abstract ConfigurationFile getPlayerCache()
      Returns TAB's cache file used to store player toggle data
      Returns:
      TAB's player cache file

    • getConfig

      public abstract ConfigurationFile getConfig()
      Returns TAB's config.yml file
      Returns:
      config.yml file

    • getGroups

      public abstract PropertyConfiguration getGroups()
      Returns TAB's group configuration
      Returns:
      TAB's group configuration

    • getUsers

      public abstract PropertyConfiguration getUsers()
      Returns TAB's user configuration
      Returns:
      TAB's user configuration

    • debug

      public abstract void debug(String message)
      Sends a debug message into console if the option is enabled in config.
      Parameters:
      message - Message to send

    • logError

      public abstract void logError(String message, Throwable t)
      Logs an error into errors.log file
      Parameters:
      message - Error message
      t - Thrown error

    • setBrokenFile

      public abstract void setBrokenFile(String file)
      Sets name of file with syntax error, which prevented the plugin from enabling. Internal use only.
      Parameters:
      file - Name of file with syntax error