Package net.md_5.bungee.api.plugin

Class Plugin

java.lang.Object
net.md_5.bungee.api.plugin.Plugin
public class Plugin extends Object
Represents any Plugin that may be loaded at runtime to enhance existing functionality.

  • Constructor Details

  • Method Details

    • getSLF4JLogger

      public org.slf4j.Logger getSLF4JLogger()

    • onLoad

      public void onLoad()
      Called when the plugin has just been loaded. Most of the proxy will not be initialized, so only use it for registering ConfigurationAdapter's and other predefined behavior.

    • onEnable

      public void onEnable()
      Called when this plugin is enabled.

    • onDisable

      public void onDisable()
      Called when this plugin is disabled.

    • loadConfig

      public void loadConfig(Class<? extends ConfigurationProvider> configType)
      (Re)loads a default config.
      Parameters:
      configType - type of the config, which should be supported by default

    • getConfig

      public Configuration getConfig()
      Gets the default configuration
      Returns:
      configuration
      Throws:
      IllegalArgumentException - if config not loaded

    • saveConfig

      public void saveConfig()
      Saves the configuration changes (if have)
      Throws:
      IllegalArgumentException - if config not loaded

    • getDataFolder

      public final File getDataFolder()
      Gets the data folder where this plugin may store arbitrary data. It will be a child of ProxyServer.getPluginsFolder().
      Returns:
      the data folder of this plugin

    • getResourceAsStream

      public final InputStream getResourceAsStream(String name)
      Get a resource from within this plugins jar or container. Care must be taken to close the returned stream.
      Parameters:
      name - the full path name of this resource
      Returns:
      the stream for getting this resource, or null if it does not exist

    • isEnabled

      public boolean isEnabled()
      Returns whenever this plugin is enabled.
      Returns:
      true if enabled

    • getExecutorService

      @Deprecated public ExecutorService getExecutorService()
      Deprecated.

    • getDescription

      public PluginDescription getDescription()

    • getProxy

      public ProxyServer getProxy()

    • getFile

      public File getFile()

    • getLogger

      public Logger getLogger()