Package org.spongepowered.api.command.manager

Interface CommandManager.Mutable

All Superinterfaces:

CommandManager

Enclosing interface:

CommandManager

public static interface CommandManager.Mutable
extends CommandManager

A mutable view of the command manager, allowing additional commands to be registered.

This view exists for access through CommandRegistrars. To register commands, see the RegisterCommandEvent.

Nested Class Summary

Nested classes/interfaces inherited from interface org.spongepowered.api.command.manager.CommandManager

CommandManager.Mutable

Method Summary

Modifier and Type	Method	Description
CommandMapping	registerAlias(CommandRegistrar<?> registrar, org.spongepowered.plugin.PluginContainer container, CommandTreeNode.Root commandTree, java.lang.String primaryAlias, java.lang.String... secondaryAliases)	Registers a set of command aliases with this manager.

Methods inherited from interface org.spongepowered.api.command.manager.CommandManager

commandMapping, complete, complete, complete, knownAliases, knownMappings, plugins, process, process, process, registrar, registrar, updateCommandTreeForPlayer

Method Detail

registerAlias

CommandMapping registerAlias(CommandRegistrar<?> registrar,
                             org.spongepowered.plugin.PluginContainer container,
                             CommandTreeNode.Root commandTree,
                             java.lang.String primaryAlias,
                             java.lang.String... secondaryAliases)
                      throws CommandFailedRegistrationException

Registers a set of command aliases with this manager. This method should only be used by plugins that implement their own command framework, as described in the description of the CommandRegistrar class.

When registering a command, any aliases provided are prefixed with the plugin's ID, followed by a colon to provide command namespacing in addition to the unnamespaced aliases. As an example, if a plugin with ID foo tries to register the command bar, the command manager will attempt to register the commands /bar and /foo:bar.

Command aliases may not contain whitespace.

If you wish to inspect the aliases that were registered, you may inspect the returned CommandMapping for the registered aliases.

Parameters:

registrar - The CommandRegistrar that is requesting the aliases

container - The PluginContainer to register the command for

commandTree - The CommandTreeNode that represents this command structure.

primaryAlias - The first command alias to register

secondaryAliases - Secondary aliases to register, if any

Returns:

The CommandMapping containing the command mapping information.

Throws:

CommandFailedRegistrationException - thrown if the command could not be registered.