Interface Plugin

public interface Plugin

  • Method Details

    • getPluginLogger

      static PluginLogger getPluginLogger()
      The plugin is automatically determined using the caller class.
      Calls are expensive, please cache the result.
      Returns:
      a new logger for this plugin.

    • getPluginLogger

      static PluginLogger getPluginLogger(Class<?> topicClass)
      The plugin is automatically determined using the caller class.
      Calls are expensive, please cache the result.
      Returns:
      a new logger for this plugin with the specified topicClass.

    • getPluginLogger

      static PluginLogger getPluginLogger(String topic)
      The plugin is automatically determined using the caller class.
      Calls are expensive, please cache the result.
      Returns:
      a new logger for this plugin with the specified topic.

    • getLogger

      default PluginLogger getLogger()
      Returns:
      a new logger for this plugin.

    • getLogger

      default PluginLogger getLogger(Class<?> topicClass)
      Returns:
      a new logger for this plugin with the specified topicClass.

    • getLogger

      default PluginLogger getLogger(String topic)
      Returns:
      a new logger for this plugin with the specified topic.

    • getConfigFolder

      default arc.files.Fi getConfigFolder()
      Returns:
      the folder where configuration files for this plugin should go.

    • getConfig

      default JsonSettings getConfig()
      Returns:
      a settings handle for this plugin, of file 'plugins/<plugin-name>/config.json'.

    • getMeta

      default Plugins.PluginMeta getMeta()
      Returns:
      the meta data of this plugin .

    • init

      default void init()
      Called after all plugins have been created and commands have been registered.

    • registerCommands

      default void registerCommands(arc.util.CommandHandler handler)
      Register any commands.

    • dispose

      default void dispose()
      Dispose any resources created by the plugin.