- All Superinterfaces:
- Enclosing interface:
public static interface CommandManager.Mutable extends CommandManagerA mutable view of the command manager, allowing additional commands to be registered.
This view exists for access through
CommandRegistrars. To register commands, see the
Nested Class Summary
Nested classes/interfaces inherited from interface org.spongepowered.api.command.manager.CommandManager
All Methods Instance Methods Abstract Methods Modifier and Type Method Description
registerAlias(CommandRegistrar<?> registrar, org.spongepowered.plugin.PluginContainer container, CommandTreeNode.Root commandTree, String primaryAlias, 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
CommandMapping registerAlias(CommandRegistrar<?> registrar, org.spongepowered.plugin.PluginContainer container, CommandTreeNode.Root commandTree, String primaryAlias, String... secondaryAliases) throws CommandFailedRegistrationExceptionRegisters 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
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
footries to register the command
bar, the command manager will attempt to register the commands
Command aliases may not contain whitespace.
If you wish to inspect the aliases that were registered, you may inspect the returned
CommandMappingfor the registered aliases.
CommandRegistrarthat is requesting the aliases
PluginContainerto register the command for
CommandTreeNodethat represents this command structure.
primaryAlias- The first command alias to register
secondaryAliases- Secondary aliases to register, if any
CommandMappingcontaining the command mapping information.
CommandFailedRegistrationException- thrown if the command could not be registered.