Package org.spongepowered.api.event.lifecycle

Interface RegisterCommandEvent.Result<C>

Enclosing interface:

RegisterCommandEvent<C>

public static interface RegisterCommandEvent.Result<C>

The RegisterCommandEvent.Result of a command registration, allowing for the chaining of other command registrations, or the retrival of the CommandMapping generated from the registration that returned this result.

Method Summary

Modifier and Type	Method	Description
CommandMapping	mapping()	The CommandMapping generated for the previous registration.
RegisterCommandEvent.Result<C>	register(org.spongepowered.plugin.PluginContainer container, C command, String alias, String... aliases)	Registers a command with the appropriate CommandRegistrar.

Method Details

register

RegisterCommandEvent.Result<C> register(org.spongepowered.plugin.PluginContainer container,
 C command,
 String alias,
 String... aliases)
                                 throws CommandFailedRegistrationException

Registers a command with the appropriate CommandRegistrar.

Parameters:

container - The PluginContainer

command - The command to register

alias - The first alias to register for this command

aliases - Any other aliases to register

Returns:

The RegisterCommandEvent.Result, which contains the CommandMapping for this registration, while also allowing for chaining of other command registrations.

Throws:

CommandFailedRegistrationException - if registration failed

mapping

CommandMapping mapping()

The CommandMapping generated for the previous registration.

Returns:

The CommandMapping