Package studio.mevera.imperat.events.types

Class CommandPreProcessEvent<S extends CommandSource>

java.lang.Object

studio.mevera.imperat.events.CommandEvent<S>

studio.mevera.imperat.events.types.CommandPreProcessEvent<S>

All Implemented Interfaces:

CancellableEvent, Event

public final class CommandPreProcessEvent<S extends CommandSource>
extends CommandEvent<S>
implements CancellableEvent

Field Summary

Fields inherited from class studio.mevera.imperat.events.CommandEvent

command

Constructor Summary

Constructors

Constructor	Description
CommandPreProcessEvent(Command<S> command, CommandContext<S> context)	Constructs a new command event.

Method Summary

Modifier and Type	Method	Description
CommandContext<S>	getContext()
boolean	isCancelled()	Checks if this event has been cancelled.
void	setCancelled(boolean cancelled)	Sets the cancellation state of this event.

Methods inherited from class studio.mevera.imperat.events.CommandEvent

getCommand

Methods inherited from class java.lang.Object

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

Constructor Details

CommandPreProcessEvent

public CommandPreProcessEvent(Command<S> command,
 CommandContext<S> context)

Constructs a new command event.

Parameters:

command - the command associated with this event

Method Details

getContext

public CommandContext<S> getContext()

isCancelled

public boolean isCancelled()

Description copied from interface: CancellableEvent

Checks if this event has been cancelled.

Specified by:

isCancelled in interface CancellableEvent

Returns:

true if the event is cancelled, false otherwise

setCancelled

public void setCancelled(boolean cancelled)

Description copied from interface: CancellableEvent

Sets the cancellation state of this event.

Setting this to true typically indicates that the main action associated with this event should not proceed. However, handlers must explicitly check CancellableEvent.isCancelled() and decide how to respond.

Specified by:

setCancelled in interface CancellableEvent

Parameters:

cancelled - true to cancel the event, false to un-cancel it