net.md_5.bungee.api.plugin

Class PluginManager

java.lang.Object

net.md_5.bungee.api.plugin.PluginManager

public final class PluginManager
extends Object

Class to manage bridging between plugin duties and implementation duties, for example event handling and plugin management.

Constructor Summary

Constructors

Constructor and Description
PluginManager(ProxyServer proxy, MethodHandles.Lookup lookup, Consumer<Object> additionalEventListenerRegistration)
PluginManager(ProxyServer proxy, org.yaml.snakeyaml.Yaml yaml, EventBus eventBus, net.md_5.bungee.api.plugin.LibraryLoader libraryLoader, CommandDispatcherProxy commandDispatcher, MethodHandles.Lookup lookup, Consumer<Object> additionalEventListenerRegistration)

Method Summary

Modifier and Type	Method and Description
<T extends Event> T	callEvent(T event) Dispatch an event to all subscribed listeners and return the event once it has been handled by these listeners.
void	detectPlugins(File folder) Load all plugins from the specified folder.
void	disablePlugin(Plugin plugin) Disables the specified plugin, if it is enabled.
void	disablePlugin(String pluginName)
boolean	dispatchCommand(CommandSender sender, String commandLine)
boolean	dispatchCommand(CommandSender sender, String commandLine, List<String> tabResults) Execute a command if it is registered, else return false.
void	enablePlugins()
CompletableFuture<com.mojang.brigadier.suggestion.Suggestions>	getBrigadierCompletions(CommandSender sender, String commandLine)
Command	getCommand(String name) Deprecated. internal use only in order to support waterfall's ProxyDefineCommandsEvent
Collection<Map.Entry<String,Command>>	getCommands() Get an unmodifiable collection of all registered commands.
Collection<com.mojang.brigadier.tree.CommandNode<CommandSender>>	getCommandsAsBrigadier() Gets all registered commands as brigadier commands.
Plugin	getPlugin(String name) Returns a loaded plugin identified by the specified name.
Collection<Plugin>	getPlugins() Returns the Plugin objects corresponding to all loaded plugins.
boolean	isExecutableCommand(String commandName, CommandSender sender) Checks if the command is registered and can possibly be executed by the sender (without taking permissions into account).
boolean	isPluginEnabled(Plugin plugin) Returns whenever a plugin is enabled
boolean	isPluginEnabled(String pluginName)
void	loadPlugins()
void	registerCommand(BrigadierCommand command)
void	registerCommand(Plugin plugin, Command command) Register a command so that it may be executed.
void	registerListener(Plugin plugin, Listener listener) Register a Listener for receiving called events.
List<String>	tabCompleteCommand(CommandSender sender, String commandLine) Searches for tab-complete suggestions for the given command line.
void	unregisterCommand(BrigadierCommand command)
void	unregisterCommand(Command command) Unregister a command so it will no longer be executed.
void	unregisterCommands(Plugin plugin) Unregister all commands owned by a Plugin
void	unregisterListener(Listener listener) Unregister a Listener so that the events do not reach it anymore.
void	unregisterListeners(Plugin plugin) Unregister all of a Plugin's listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginManager

public PluginManager(ProxyServer proxy,
                     MethodHandles.Lookup lookup,
                     Consumer<Object> additionalEventListenerRegistration)

PluginManager

public PluginManager(ProxyServer proxy,
                     org.yaml.snakeyaml.Yaml yaml,
                     EventBus eventBus,
                     net.md_5.bungee.api.plugin.LibraryLoader libraryLoader,
                     CommandDispatcherProxy commandDispatcher,
                     MethodHandles.Lookup lookup,
                     Consumer<Object> additionalEventListenerRegistration)

Method Detail

registerCommand

public void registerCommand(Plugin plugin,
                            Command command)

Register a command so that it may be executed.

Parameters:

plugin - the plugin owning this command

command - the command to register

registerCommand

public void registerCommand(BrigadierCommand command)

unregisterCommand

public void unregisterCommand(BrigadierCommand command)

unregisterCommand

public void unregisterCommand(Command command)

Unregister a command so it will no longer be executed.

Parameters:

command - the command to unregister

unregisterCommands

public void unregisterCommands(Plugin plugin)

Unregister all commands owned by a Plugin

Parameters:

plugin - the plugin to register the commands of

isExecutableCommand

public boolean isExecutableCommand(String commandName,
                                   CommandSender sender)

Checks if the command is registered and can possibly be executed by the sender (without taking permissions into account).

Parameters:

commandName - the name of the command

sender - the sender executing the command

Returns:

whether the command will be handled

getCommand

@Deprecated
public Command getCommand(String name)

Deprecated. internal use only in order to support waterfall's ProxyDefineCommandsEvent

Retrieves command in a legacy form by the name/alias specified.

Parameters:

name - command name/alias

Returns:

command or null

dispatchCommand

public boolean dispatchCommand(CommandSender sender,
                               String commandLine)

dispatchCommand

public boolean dispatchCommand(CommandSender sender,
                               String commandLine,
                               List<String> tabResults)

Execute a command if it is registered, else return false.

Parameters:

sender - the sender executing the command

commandLine - the complete command line including command name and arguments

tabResults - list to place tab results into. If this list is non null then the command will not be executed and tab results will be returned instead.

Returns:

whether the command was handled

tabCompleteCommand

public List<String> tabCompleteCommand(CommandSender sender,
                                       String commandLine)

Searches for tab-complete suggestions for the given command line.

This is similar to dispatchCommand(CommandSender, String, List) called with a list, but it also handles completing the command names itself instead of just the arguments.

Parameters:

sender - The command sender

commandLine - The current command line

Returns:

The tab-complete suggestions

getBrigadierCompletions

public CompletableFuture<com.mojang.brigadier.suggestion.Suggestions> getBrigadierCompletions(CommandSender sender,
                                                                                              String commandLine)

getPlugins

public Collection<Plugin> getPlugins()

Returns the Plugin objects corresponding to all loaded plugins.

Returns:

the set of loaded plugins

getPlugin

public Plugin getPlugin(String name)

Returns a loaded plugin identified by the specified name.

Parameters:

name - of the plugin to retrieve

Returns:

the retrieved plugin or null if not loaded

loadPlugins

public void loadPlugins()

enablePlugins

public void enablePlugins()

detectPlugins

public void detectPlugins(File folder)

Load all plugins from the specified folder.

Parameters:

folder - the folder to search for plugins in

callEvent

public <T extends Event> T callEvent(T event)

Dispatch an event to all subscribed listeners and return the event once it has been handled by these listeners.

Type Parameters:

T - the type bounds, must be a class which extends event

Parameters:

event - the event to call

Returns:

the called event

registerListener

public void registerListener(Plugin plugin,
                             Listener listener)

Register a Listener for receiving called events. Methods in this Object which wish to receive events must be annotated with the EventHandler annotation.

Parameters:

plugin - the owning plugin

listener - the listener to register events for

unregisterListener

public void unregisterListener(Listener listener)

Unregister a Listener so that the events do not reach it anymore.

Parameters:

listener - the listener to unregister

unregisterListeners

public void unregisterListeners(Plugin plugin)

Unregister all of a Plugin's listener.

Parameters:

plugin - target plugin

getCommands

public Collection<Map.Entry<String,Command>> getCommands()

Get an unmodifiable collection of all registered commands.

Returns:

commands

disablePlugin

public void disablePlugin(String pluginName)

Parameters:

pluginName - the plugin's name you want to disable

Throws:

IllegalArgumentException - if plugin name is null/empty || found plugin is null

See Also:

disablePlugin(Plugin)

disablePlugin

public void disablePlugin(Plugin plugin)

Disables the specified plugin, if it is enabled.

Parameters:

plugin - the plugin you want to disable

Throws:

IllegalArgumentException - if the plugin is null

isPluginEnabled

public boolean isPluginEnabled(String pluginName)

Parameters:

pluginName - the plugin's name you want to check

Returns:

true if enabled, otherwise false

Throws:

IllegalArgumentException - if plugin name is null/empty || found plugin is null

See Also:

isPluginEnabled(Plugin)

isPluginEnabled

public boolean isPluginEnabled(Plugin plugin)

Returns whenever a plugin is enabled

Parameters:

plugin - plugin

Returns:

true if enabled, otherwise false

Throws:

IllegalArgumentException - if plugin is null

getCommandsAsBrigadier

public Collection<com.mojang.brigadier.tree.CommandNode<CommandSender>> getCommandsAsBrigadier()

Gets all registered commands as brigadier commands.

Returns:

unmodifiable collection of brigadier commands