Package de.marcely.bedwars.api.hook

Interface Hook

All Known Subinterfaces:
CloudSystemHook, NicknamingHook, PartiesHook
public interface Hook
Represents an extension handler for third-party plugins by hooking into their feature-set.

  • Method Summary

    Modifier and Type
    Method
    Description
    HookCategory
    getCategory()
    Get the category of the hook.
    @Nullable Plugin
    getHookedPlugin()
    Get the plugin into which this hook class is hooking into.
    Plugin
    getManagingPlugin()
    Get the plugin that is managing and created this hook.
    default boolean
    isActive()
    Get whether the hook is currently registered and active.

  • Method Details

    • getCategory

      HookCategory getCategory()
      Get the category of the hook.
      Returns:
      The category of the hook

    • getManagingPlugin

      Plugin getManagingPlugin()
      Get the plugin that is managing and created this hook.
      Returns:
      The plugin that created this hook

    • getHookedPlugin

      @Nullable @Nullable Plugin getHookedPlugin()
      Get the plugin into which this hook class is hooking into.
      Returns:
      The plugin that we hook into. May be null if it's not a Bukkit plugin (e.g. if it's being handled by BungeeCord)

    • isActive

      default boolean isActive()
      Get whether the hook is currently registered and active.
      Returns:
      true in case the hook is active