Package xyz.janboerman.scalaloader.paper.plugin

Class ScalaPlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

xyz.janboerman.scalaloader.paper.plugin.ScalaPlugin

All Implemented Interfaces:

CommandExecutor, TabCompleter, TabExecutor, Plugin, IScalaPlugin

public abstract class ScalaPlugin
extends JavaPlugin
implements IScalaPlugin

Representation of a ScalaPlugin when running on Paper. ScalaLoader's bytecode transformer will ensure that subclasses of xyz.janboerman.scalaloader.plugin.ScalaPlugin will be subclasses of xyz.janboerman.scalalaoder.paper.plugin.ScalaPlugin at runtime when ScalaLoader runs on Paper.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ScalaPlugin()	Use this super constructor if you have a plugin.yml or paper-plugin.yml.
protected	ScalaPlugin(ScalaPluginDescription description)	Use this super constructor if you don't want to describe your plugin using a Yaml file.

Method Summary

Modifier and Type	Method	Description
ScalaPluginClassLoader	classLoader()	Get the ClassLoader of this plugin.
File	getConfigFile()	Get the configuration file of this ScalaPlugin.
final String	getDeclaredApiVersion()	Get the api-version that was declared by this plugin.
final String	getDeclaredScalaVersion()	Get the version of Scala declared by this plugin.
EventBus	getEventBus()	Get the Server's event bus.
String	getPrefix()	Get the prefix of this plugin, used for logging.
String	getScalaVersion()	Get the version of Scala used by this plugin.
ScalaPluginLoader	pluginLoader()	Get the PluginLoader of this plugin.
String	toString()

Methods inherited from class org.bukkit.plugin.java.JavaPlugin

getClassLoader, getCommand, getConfig, getDataFolder, getDefaultBiomeProvider, getDefaultWorldGenerator, getDescription, getFile, getLogger, getPlugin, getPluginLoader, getProvidingPlugin, getResource, getServer, getTextResource, isEnabled, isNaggable, onCommand, onDisable, onEnable, onLoad, onTabComplete, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setEnabled, setNaggable

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.bukkit.command.CommandExecutor

onCommand

Methods inherited from interface xyz.janboerman.scalaloader.compat.IScalaPlugin

getName, getScalaRelease

Methods inherited from interface org.bukkit.plugin.Plugin

getConfig, getDataFolder, getDefaultBiomeProvider, getDefaultWorldGenerator, getDescription, getLogger, getPluginLoader, getResource, getServer, isEnabled, isNaggable, onDisable, onEnable, onLoad, reloadConfig, saveConfig, saveDefaultConfig, saveResource, setNaggable

Methods inherited from interface org.bukkit.command.TabCompleter

onTabComplete

Constructor Details

ScalaPlugin

protected ScalaPlugin(ScalaPluginDescription description)

Use this super constructor if you don't want to describe your plugin using a Yaml file. You can *just* provide the description directly as an argument.

Parameters:

description - your plugin's description

ScalaPlugin

protected ScalaPlugin()

Use this super constructor if you have a plugin.yml or paper-plugin.yml.

Method Details

getPrefix

public String getPrefix()

Get the prefix of this plugin, used for logging.

Specified by:

getPrefix in interface IScalaPlugin

Returns:

the prefix

classLoader

public ScalaPluginClassLoader classLoader()

Get the ClassLoader of this plugin.

Specified by:

classLoader in interface IScalaPlugin

Returns:

the class loader

pluginLoader

public ScalaPluginLoader pluginLoader()

Get the PluginLoader of this plugin.

Specified by:

pluginLoader in interface IScalaPlugin

Returns:

the plugin loader

getConfigFile

public File getConfigFile()

Get the configuration file of this ScalaPlugin.

Specified by:

getConfigFile in interface IScalaPlugin

Returns:

the configuration file

getEventBus

public EventBus getEventBus()

Get the Server's event bus.

Specified by:

getEventBus in interface IScalaPlugin

Returns:

the event bus

getScalaVersion

public String getScalaVersion()

Get the version of Scala used by this plugin.

Specified by:

getScalaVersion in interface IScalaPlugin

Returns:

the scala version

getDeclaredScalaVersion

public final String getDeclaredScalaVersion()

Get the version of Scala declared by this plugin.

Specified by:

getDeclaredScalaVersion in interface IScalaPlugin

Returns:

the declared scala version

getDeclaredApiVersion

public final String getDeclaredApiVersion()

Get the api-version that was declared by this plugin.

Returns:

the bukkit api version

toString

public String toString()

Overrides:

toString in class JavaPlugin