Package org.mvplugins.multiverse.core.module

Class MultiverseModule

java.lang.Object

org.bukkit.plugin.PluginBase

org.bukkit.plugin.java.JavaPlugin

org.mvplugins.multiverse.core.module.MultiverseModule

All Implemented Interfaces:

io.papermc.paper.plugin.lifecycle.event.LifecycleEventOwner, net.kyori.adventure.key.Namespaced, org.bukkit.command.CommandExecutor, org.bukkit.command.TabCompleter, org.bukkit.command.TabExecutor, org.bukkit.plugin.Plugin

Direct Known Subclasses:

MultiverseCore

@Contract
public abstract class MultiverseModule
extends org.bukkit.plugin.java.JavaPlugin

Common plugin class for all Multiverse plugins.

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.inject.Provider<MVCommandManager>	commandManagerProvider
protected jakarta.inject.Provider<DynamicListenerRegistration>	dynamicListenerRegistrationProvider
protected PluginServiceLocator	serviceLocator

Constructor Summary

Constructors

Constructor	Description
MultiverseModule()

Method Summary

Modifier and Type	Method	Description
PluginServiceLocator	getServiceLocator()	Gets the PluginServiceLocator for this plugin.
abstract double	getTargetCoreVersion()	The minimum version that this plugin is compatible with Multiverse-Core.
protected double	getVersionAsNumber()
protected void	initializeDependencyInjection(MultiverseModuleBinder<? extends MultiverseModule> pluginBinder)	Initializes the dependency injection for this plugin.
void	onDisable()
void	onEnable()
protected void	registerCommands(Class<? extends MultiverseCommand> commandClass)	Register all commands to Command Manager.
protected void	registerDynamicListeners(Class<? extends DynamicListener> listenerClass)
protected void	registerEvents(Class<? extends org.bukkit.event.Listener> listenerClass)	Deprecated, for removal: This API element is subject to removal in a future version. Use registerDynamicListeners(Class) with the new DynamicListener API.
protected void	setUpLocales()	Register locales.
protected void	shutdownDependencyInjection()

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

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

Methods inherited from class org.bukkit.plugin.PluginBase

equals, getName, hashCode, namespace

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bukkit.plugin.Plugin

getComponentLogger, getDataPath, getLog4JLogger, getSLF4JLogger

Field Details

serviceLocator

protected PluginServiceLocator serviceLocator

commandManagerProvider

@Inject
protected jakarta.inject.Provider<MVCommandManager> commandManagerProvider

dynamicListenerRegistrationProvider

@Inject
protected jakarta.inject.Provider<DynamicListenerRegistration> dynamicListenerRegistrationProvider

Constructor Details

MultiverseModule

public MultiverseModule()

Method Details

onEnable

public void onEnable()

Specified by:

onEnable in interface org.bukkit.plugin.Plugin

Overrides:

onEnable in class org.bukkit.plugin.java.JavaPlugin

onDisable

public void onDisable()

Specified by:

onDisable in interface org.bukkit.plugin.Plugin

Overrides:

onDisable in class org.bukkit.plugin.java.JavaPlugin

getTargetCoreVersion

public abstract double getTargetCoreVersion()

The minimum version that this plugin is compatible with Multiverse-Core.

Returns:

The version number.

getServiceLocator

public PluginServiceLocator getServiceLocator()

Gets the PluginServiceLocator for this plugin.

Returns:

The PluginServiceLocator

getVersionAsNumber

protected double getVersionAsNumber()

initializeDependencyInjection

protected void initializeDependencyInjection(MultiverseModuleBinder<? extends MultiverseModule> pluginBinder)

Initializes the dependency injection for this plugin.

Parameters:

pluginBinder - The plugin binder

shutdownDependencyInjection

protected void shutdownDependencyInjection()

registerEvents

@Deprecated(since="5.0",
            forRemoval=true)
@ScheduledForRemoval(inVersion="6.0")
protected void registerEvents(Class<? extends org.bukkit.event.Listener> listenerClass)

Deprecated, for removal: This API element is subject to removal in a future version.

Use registerDynamicListeners(Class) with the new DynamicListener API.

Function to Register all the Events needed.

registerDynamicListeners

protected void registerDynamicListeners(Class<? extends DynamicListener> listenerClass)

registerCommands

protected void registerCommands(Class<? extends MultiverseCommand> commandClass)

Register all commands to Command Manager.

setUpLocales

protected void setUpLocales()

Register locales.