io.github.nucleuspowered.nucleus.api.core.event

Interface NucleusModuleEvent.AboutToConstruct

All Superinterfaces:

org.spongepowered.api.event.Event, NucleusModuleEvent

Enclosing interface:

NucleusModuleEvent

public static interface NucleusModuleEvent.AboutToConstruct
extends NucleusModuleEvent

Fired just before modules are loaded. This is the last chance to disable modules.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.nucleuspowered.nucleus.api.core.event.NucleusModuleEvent

NucleusModuleEvent.AboutToConstruct, NucleusModuleEvent.AboutToEnable, NucleusModuleEvent.Complete, NucleusModuleEvent.Enabled, NucleusModuleEvent.ModuleEnableState, NucleusModuleEvent.PreEnable

Method Summary

Modifier and Type	Method and Description
void	disableModule(java.lang.String module, org.spongepowered.api.plugin.PluginContainer plugin) Disables the named module.

Methods inherited from interface io.github.nucleuspowered.nucleus.api.core.event.NucleusModuleEvent

getModuleList

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Method Detail

disableModule

void disableModule(java.lang.String module,
                   org.spongepowered.api.plugin.PluginContainer plugin)
            throws UnremovableModuleException,
                   NoModuleException

Disables the named module.

Parameters:

module - The id of the module to disable.

plugin - The plugin that is requesting to disable the module. Used for logging purposes - telling the user who is disabling the plugin.

Throws:

UnremovableModuleException - Thrown if the module has been marked "cannot be disabled". Plugins are expected to honour this, NucleusPlugin does not mark any module (apart from the core) as "unable to be disabled" by default, so plugin authors are requested to not try to override any behaviour that a user has explicitly turned on.

NoModuleException - Thrown if the module does not exist.