Package kr.toxicity.hud.api

Interface BetterHud

public interface BetterHud
Represents the main class of BetterHud.

  • Field Details

  • Method Details

    • getInstance

      @NotNull static @NotNull BetterHud getInstance()
      Supports legacy api.
      Returns:
      BetterHud main instance.

    • reload

      @NotNull default @NotNull ReloadState reload(@NotNull @NotNull ReloadFlagType... args)
      Executes reload.
      Parameters:
      args - reload args
      Returns:
      result of reload.

    • reload

      @NotNull default @NotNull ReloadState reload(@NotNull @NotNull kr.toxicity.command.BetterCommandSource sender, @NotNull @NotNull ReloadFlagType... args)
      Executes reload.
      Parameters:
      sender - log handler.
      args - reload args.
      Returns:
      result of reload.

    • isDevVersion

      boolean isDevVersion()
      Checks whether this build is a dev version.
      Returns:
      whether this build is a dev version

    • bootstrap

      @NotNull @NotNull BetterHudBootstrap bootstrap()
      Gets a bootstrap.
      Returns:
      bootstrap.

    • reload

      @NotNull @NotNull ReloadState reload(@NotNull @NotNull ReloadInfo info)
      Executes reload.
      Parameters:
      info - reload info.
      Returns:
      result of reload.

    • isMergeBossBar

      boolean isMergeBossBar()
      Returns whether this plugin merges the first bossbar.
      Returns:
      whether to merge

    • loadAssets

      void loadAssets(@NotNull @NotNull String prefix, @NotNull @NotNull File dir)
      Loads plugin's resource to some directory
      Parameters:
      prefix - resource folder
      dir - target directory

    • loadAssets

      void loadAssets(@NotNull @NotNull String prefix, @NotNull @NotNull BiConsumer<String,InputStream> consumer)
      Loads plugin's resource to some directory
      Parameters:
      prefix - resource folder
      consumer - for each callback

    • getWidth

      int getWidth(int codepoint)
      Gets the width of default font's char
      Parameters:
      codepoint - target codepoint
      Returns:
      width

    • getPlaceholderManager

      @NotNull @NotNull PlaceholderManager getPlaceholderManager()
      Gets placeholder manager.
      Returns:
      placeholder manager

    • getListenerManager

      @NotNull @NotNull ListenerManager getListenerManager()
      Gets listener manager.
      Returns:
      listener manager

    • getPopupManager

      @NotNull @NotNull PopupManager getPopupManager()
      Gets popup manager.
      Returns:
      popup manager

    • getConfigManager

      @NotNull @NotNull ConfigManager getConfigManager()
      Gets config manager.
      Returns:
      config manager

    • getCompassManager

      @NotNull @NotNull CompassManager getCompassManager()
      Gets compass manager.
      Returns:
      compass manager

    • getTriggerManager

      @NotNull @NotNull TriggerManager getTriggerManager()
      Gets trigger manager.
      Returns:
      trigger manager

    • getHudManager

      @NotNull @NotNull HudManager getHudManager()
      Gets hud manager.
      Returns:
      hud manager

    • getDatabaseManager

      @NotNull @NotNull DatabaseManager getDatabaseManager()
      Gets database manager.
      Returns:
      database manager

    • getShaderManager

      @NotNull @NotNull ShaderManager getShaderManager()
      Gets shader manager.
      Returns:
      shader manager

    • getPlayerManager

      @NotNull @NotNull PlayerManager getPlayerManager()
      Gets player manager.
      Returns:
      player manager

    • getTextManager

      @NotNull @NotNull TextManager getTextManager()
      Gets text manager.
      Returns:
      text manager

    • isOnReload

      boolean isOnReload()
      Returns this plugin is currently on reload.
      Returns:
      whether to this plugin is on reload

    • getEncodedNamespace

      @NotNull @NotNull String getEncodedNamespace()
      Returns encoded namespace.
      Returns:
      namespace.

    • getDefaultKey

      @NotNull @NotNull net.kyori.adventure.key.Key getDefaultKey()
      Returns default font key.
      Returns:
      font key

    • translate

      @Nullable @Nullable String translate(@NotNull @NotNull String locale, @NotNull @NotNull String key)
      Get a translated result of a key.
      Parameters:
      locale - locale
      key - key
      Returns:
      translated value

    • addReloadStartTask

      void addReloadStartTask(@NotNull @NotNull Runnable runnable)
      Adds some task when reload is started.
      Parameters:
      runnable - reload start task

    • addReloadEndTask

      void addReloadEndTask(@NotNull @NotNull Consumer<ReloadState> runnable)
      Adds some task when reload is ended.
      Parameters:
      runnable - reload end task