Package xyz.janboerman.scalaloader.compat

Interface IScalaPlugin

All Superinterfaces:
CommandExecutor, Plugin, TabCompleter, TabExecutor
All Known Implementing Classes:
DescriptionPlugin, ScalaPlugin, ScalaPlugin
public interface IScalaPlugin extends Plugin
ScalaPlugin abstraction. Not meant to be implemented directly.

When you implement your own ScalaPlugin, please inherit from xyz.janboerman.scalaloader.plugin.ScalaPlugin. Alternatively, if your plugin is only meant to run on Paper, you can inherit from xyz.janboerman.scalaloader.paper.plugin.ScalaPlugin instead`.

  • Method Details

    • getConfigFile

      File getConfigFile()
      Get the configuration file of this ScalaPlugin.
      Returns:
      the configuration file

    • getEventBus

      EventBus getEventBus()
      Get the Server's event bus.
      Returns:
      the event bus

    • getScalaVersion

      String getScalaVersion()
      Get the version of Scala used by this plugin.
      Returns:
      the scala version

    • getScalaRelease

      default ScalaRelease getScalaRelease()
      Get the Scala Release cycle associated with this plugin
      Returns:
      the scala release

    • getDeclaredScalaVersion

      String getDeclaredScalaVersion()
      Get the version of Scala declared by this plugin.
      Returns:
      the declared scala version

    • getName

      String getName()
      Get the name of the ScalaPlugin.
      Specified by:
      getName in interface Plugin
      Returns:
      this plugin's name

    • classLoader

      default IScalaPluginClassLoader classLoader()
      Get the ClassLoader of this plugin.
      Returns:
      the class loader

    • pluginLoader

      default IScalaPluginLoader pluginLoader()
      Get the PluginLoader of this plugin.
      Returns:
      the plugin loader

    • getPrefix

      String getPrefix()
      Get the prefix of this plugin, used for logging.
      Returns:
      the prefix