org.spongepowered.api.event.command

Interface SendCommandEvent

All Superinterfaces:

Cancellable, Event

public interface SendCommandEvent
extends Event, Cancellable

Fired when a command is sent.

Method Summary

Modifier and Type	Method and Description
String	getArguments() Gets the arguments as a string.
String	getCommand() Gets the command as a string, without any sort of command prefix.
CommandResult	getResult() The result of the command.
void	setArguments(String arguments) Sets the arguments as a string.
void	setCommand(String command) Sets the command as a string, without any sort of command prefix.
void	setResult(CommandResult result) Sets the result of the command.

Methods inherited from interface org.spongepowered.api.event.Event

getCause, getContext, getSource

Methods inherited from interface org.spongepowered.api.event.Cancellable

isCancelled, setCancelled

Method Detail

getCommand

String getCommand()

Gets the command as a string, without any sort of command prefix.

For example, if the message was /example bob 3 -f, then the command would be example.

Returns:

The command

setCommand

void setCommand(String command)

Sets the command as a string, without any sort of command prefix.

For example, if the message was /example bob 3 -f, then the command would be example.

Parameters:

command - The command

getArguments

String getArguments()

Gets the arguments as a string.

For example, if the message was /example bob 3 -f, then the arguments would be bob 3 -f.

Returns:

The arguments

setArguments

void setArguments(String arguments)

Sets the arguments as a string.

For example, if the message was /example bob 3 -f, then the arguments would be bob 3 -f.

Parameters:

arguments - The arguments

getResult

CommandResult getResult()

The result of the command.

Returns:

The result of the command

setResult

void setResult(CommandResult result)

Sets the result of the command.

Parameters:

result - The result of the command