com.moderocky.mask.template

Class BukkitPlugin

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

com.moderocky.mask.template.BukkitPlugin

All Implemented Interfaces:

IPlugin, CommandExecutor, TabCompleter, TabExecutor, Plugin

Direct Known Subclasses:

Plugin

public abstract class BukkitPlugin
extends JavaPlugin
implements IPlugin

This is a template plugin class. You can extend it instead of JavaPlugin in your plugins.

A few useful methods are provided within this, though mainly registration bits and bobs.

IPlugin.startup() and IPlugin.disable() are used instead of onEnable and onDisable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BukkitPlugin.ClosedListener<T extends Event> Stub class to be used anonymously by consumer listeners.

Nested classes/interfaces inherited from interface com.moderocky.mask.template.IPlugin

IPlugin.PluginType

Constructor Summary

Constructors

Modifier	Constructor and Description
	BukkitPlugin()
protected	BukkitPlugin(@NotNull JavaPluginLoader loader, @NotNull PluginDescriptionFile description, @NotNull File dataFolder, @NotNull File file)

Method Summary

Modifier and Type	Method and Description
boolean	areDependenciesMet()
static <Z extends Event> void	callEvent(Z event) Calls a Bukkit event
void	disablePlugin()
ch.njol.skript.SkriptAddon	getAddon()
String	getAPIVersion()
String	getConfigPath()
String	getCraftVersion()
String	getFullName()
static BukkitPlugin	getInstance()
static FixedMetadataValue	getMetaValue(Object object) Returns a metadata value for the object attached to your plugin.
static NamespacedKey	getNamespacedKey(String string) Generates a NamespacedKey for your plugin
String	getPluginDescription()
String	getPrefix()
String	getVersion()
static boolean	isPaper()
protected boolean	isRegistered(CompleteCommand command)
protected boolean	isRegistered(String command)
void	onDisable() This is called on disable.
void	onEnable() This is called on enable.
protected void	register(CompleteCommand... commands) This registers your CompleteCommands.
protected void	register(CompleteRecipe... recipes) This registers your complete recipes.
protected void	register(Listener... listeners) This registers your listeners.
protected Listener[]	register(Listener<?>... listeners) Used to register Mask Listeners, which are based on functional interfaces.
protected Listener	register(Listener<?> listener)
protected Listener	register(Listener<?> listener, long lifetime)
protected Listener[]	register(long lifetime, Listener<?>... listeners) Used to register Mask Listeners, which are based on functional interfaces.
protected void	register(MenuGUI... guis) This registers your menu templates.
protected void	register(WrappedCommand... commands) This registers multiple WrappedCommands at once.
protected void	registerCommands() This is called during enable.
protected void	registerEvents() This is called during enable.
protected void	registerListeners() This is called during enable.
protected void	registerManagers() This is called during enable.
protected void	registerProtocol() This is called during enable.
protected void	registerRecipes() This is called during enable.
protected void	registerSyntax() This is called during enable.
void	resetConfig() Stub
protected void	setInstance(BukkitPlugin plugin)

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

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

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 com.moderocky.mask.template.IPlugin

disable, getName, getPluginType, getResource, isBukkit, isBungee, startup

Methods inherited from interface org.bukkit.plugin.Plugin

getSLF4JLogger

Constructor Detail

BukkitPlugin

public BukkitPlugin()

BukkitPlugin

protected BukkitPlugin(@NotNull
                       @NotNull JavaPluginLoader loader,
                       @NotNull
                       @NotNull PluginDescriptionFile description,
                       @NotNull
                       @NotNull File dataFolder,
                       @NotNull
                       @NotNull File file)

Method Detail

getInstance

public static BukkitPlugin getInstance()

setInstance

protected void setInstance(@Nullable
                           BukkitPlugin plugin)

callEvent

public static <Z extends Event> void callEvent(Z event)

Calls a Bukkit event

Type Parameters:

Z - The type

Parameters:

event - The event

getMetaValue

public static FixedMetadataValue getMetaValue(Object object)

Returns a metadata value for the object attached to your plugin.

Parameters:

object - The object

Returns:

The metadata value

getNamespacedKey

public static NamespacedKey getNamespacedKey(String string)

Generates a NamespacedKey for your plugin

Parameters:

string - The key

Returns:

The namespaced key.

isPaper

public static boolean isPaper()

Returns:

True if this server is running paper, otherwise false

getVersion

public String getVersion()

Returns:

Your plugin version from the plugin.yml

getAPIVersion

public String getAPIVersion()

Returns:

Your plugin API version from the plugin.yml

getPluginDescription

public String getPluginDescription()

Returns:

Your plugin description from the plugin.yml

getFullName

public String getFullName()

Returns:

Your plugin's full name from the plugin.yml

getPrefix

public String getPrefix()

Returns:

Your plugin's prefix from the plugin.yml

areDependenciesMet

public boolean areDependenciesMet()

Returns:

Whether all the soft dependencies of your plugin are met

getCraftVersion

public String getCraftVersion()

Returns:

The craftbukkit version of the server, with a format like 'v1_15_R1'

disablePlugin

public void disablePlugin()

onEnable

public void onEnable()

This is called on enable.

It performs some internal operations, then calls the IPlugin.startup() method.

Specified by:

onEnable in interface Plugin

Overrides:

onEnable in class JavaPlugin

onDisable

public void onDisable()

This is called on disable.

It performs some internal operations, then calls the IPlugin.disable() method.

Specified by:

onDisable in interface Plugin

Overrides:

onDisable in class JavaPlugin

getAddon

public ch.njol.skript.SkriptAddon getAddon()

Returns:

This plugin as a Skript addon (iff Skript is present)

getConfigPath

public String getConfigPath()

Specified by:

getConfigPath in interface IPlugin

Returns:

The plugin's "config" folder location

resetConfig

public void resetConfig()

Stub

register

protected void register(WrappedCommand... commands)

This registers multiple WrappedCommands at once.

Wrapped commands are able to be configured entirely in their own class, and do not need to be added to your plugin.yml file.

They are registered to Bukkit's command map as regular plugin commands.

Parameters:

commands - Your wrapped commands

isRegistered

protected boolean isRegistered(CompleteCommand command)

isRegistered

protected boolean isRegistered(String command)

register

protected void register(CompleteCommand... commands)

This registers your CompleteCommands. You might find the register(WrappedCommand...) method more palatable.

Parameters:

commands - Commands

register

protected void register(MenuGUI... guis)

This registers your menu templates. You can also just register them as listeners using register(org.bukkit.event.Listener...).

Parameters:

guis - Menus

register

protected void register(Listener... listeners)

This registers your listeners.

Parameters:

listeners - Listeners

register

protected void register(CompleteRecipe... recipes)

This registers your complete recipes. These cut down on some overhead but have very little difference from normal recipes.

Parameters:

recipes - Recipes

register

protected Listener[] register(Listener<?>... listeners)

Used to register Mask Listeners, which are based on functional interfaces.

Parameters:

listeners - Register fast, functional, consumer-based listeners.

Returns:

The Bukkit listeners, if required.

register

protected Listener[] register(long lifetime,
                              Listener<?>... listeners)

Used to register Mask Listeners, which are based on functional interfaces.

Parameters:

listeners - Register fast, functional, consumer-based listeners.

lifetime - The lifetime of the listener in ticks, until it is unregistered.

Returns:

The Bukkit listeners, if required.

register

protected Listener register(Listener<?> listener)

register

protected Listener register(Listener<?> listener,
                            long lifetime)

registerRecipes

protected void registerRecipes()

This is called during enable. It exists purely as a structural thing, if needed.

registerListeners

protected void registerListeners()

This is called during enable. It exists purely as a structural thing, if needed.

registerCommands

protected void registerCommands()

This is called during enable. It exists purely as a structural thing, if needed.

registerManagers

protected void registerManagers()

This is called during enable. It exists purely as a structural thing, if needed.

registerProtocol

protected void registerProtocol()

This is called during enable. It exists purely as a structural thing, if needed.

registerSyntax

protected void registerSyntax()

This is called during enable. It exists purely as a structural thing, if needed.

registerEvents

protected void registerEvents()

This is called during enable. It exists purely as a structural thing, if needed.