net.minecraftforge.event

Class CommandEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.event.CommandEvent

public class CommandEvent
extends Event

CommandEvent is fired whenever a command is scheduled to be executed. This event is fired during the invocation of CommandHandler.executeCommand(ICommandSender, String) and ClientCommandHandler.executeCommand(ICommandSender, String).

command contains the instance of ICommand which is representative of the currently executing command.
sender contains the instance of ICommandSender for the given command sender.
parameters contains the arguments passed for the command execution.
exception begins null, but can be populated with an exception to be thrown within the command.

This event is Cancelable.
If the event is canceled, the execution of the command does not occur.

This event does not have a result. HasResult

This event is fired on the MinecraftForge.EVENT_BUS.

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

Event.HasResult, Event.Result

Field Summary

Fields

Modifier and Type	Field and Description
private ICommand	command
private java.lang.Throwable	exception
private java.lang.String[]	parameters
private ICommandSender	sender

Constructor Summary

Constructors

Constructor and Description
CommandEvent(ICommand command, ICommandSender sender, java.lang.String[] parameters)

Method Summary

Modifier and Type	Method and Description
ICommand	getCommand()
java.lang.Throwable	getException()
java.lang.String[]	getParameters()
ICommandSender	getSender()
void	setException(java.lang.Throwable exception)
void	setParameters(java.lang.String[] parameters)

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult, setup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

command

private final ICommand command

sender

private final ICommandSender sender

parameters

private java.lang.String[] parameters

exception

private java.lang.Throwable exception

Constructor Detail

CommandEvent

public CommandEvent(ICommand command,
                    ICommandSender sender,
                    java.lang.String[] parameters)

Method Detail

getCommand

public ICommand getCommand()

getSender

public ICommandSender getSender()

getParameters

public java.lang.String[] getParameters()

setParameters

public void setParameters(java.lang.String[] parameters)

getException

public java.lang.Throwable getException()

setException

public void setException(java.lang.Throwable exception)