Package org.geysermc.geyser.api.extension

Interface Extension

All Superinterfaces:
EventRegistrar
public interface Extension extends EventRegistrar
Represents an extension within Geyser.

  • Method Details

    • isEnabled

      default boolean isEnabled()
      Gets if the extension is enabled
      Returns:
      true if the extension is enabled

    • setEnabled

      default void setEnabled(boolean enabled)
      Enables or disables the extension
      Parameters:
      enabled - if the extension should be enabled

    • dataFolder

      default Path dataFolder()
      Gets the extension's data folder
      Returns:
      the extension's data folder

    • eventBus

      default ExtensionEventBus eventBus()
      Gets the ExtensionEventBus.
      Returns:
      the extension event bus

    • extensionManager

      default ExtensionManager extensionManager()
      Gets the ExtensionManager.
      Returns:
      the extension manager

    • name

      default String name()
      Gets the extension's name
      Returns:
      the extension's name

    • description

      default ExtensionDescription description()
      Gets this extension's ExtensionDescription.
      Returns:
      the extension's description

    • rootCommand

      default String rootCommand()
      Returns:
      the root command that all of this extension's commands will stem from. By default, this is the extension's id.

    • logger

      default ExtensionLogger logger()
      Gets the extension's logger
      Returns:
      the extension's logger

    • extensionLoader

      default ExtensionLoader extensionLoader()
      Gets the ExtensionLoader.
      Returns:
      the extension loader

    • geyserApi

      default GeyserApi geyserApi()
      Gets the GeyserApiBase instance
      Returns:
      the geyser api instance

    • disable

      default void disable()
      Disable the extension.