Interface CommandManager.Mutable
- All Superinterfaces:
CommandManager
- Enclosing interface:
CommandManager
A mutable view of the command manager, allowing additional commands
to be registered.
This view exists for access through CommandRegistrar
s. 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 TypeMethodDescriptionregisterAlias
(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
-
Method Details
-
registerAlias
CommandMapping registerAlias(CommandRegistrar<?> registrar, org.spongepowered.plugin.PluginContainer container, CommandTreeNode.Root commandTree, String primaryAlias, 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 theCommandRegistrar
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 commandbar
, 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
- TheCommandRegistrar
that is requesting the aliasescontainer
- ThePluginContainer
to register the command forcommandTree
- TheCommandTreeNode
that represents this command structure.primaryAlias
- The first command alias to registersecondaryAliases
- Secondary aliases to register, if any- Returns:
- The
CommandMapping
containing the command mapping information. - Throws:
CommandFailedRegistrationException
- thrown if the command could not be registered.
-