Package org.purpurmc.purpur.event

Class ExecuteCommandEvent

java.lang.Object

org.bukkit.event.Event

org.purpurmc.purpur.event.ExecuteCommandEvent

All Implemented Interfaces:

Cancellable

public class ExecuteCommandEvent
extends Event
implements Cancellable

This event is called whenever someone runs a command

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Constructor Summary

Constructors

Constructor	Description
ExecuteCommandEvent(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @Nullable String[] args)

Method Summary

Modifier and Type	Method	Description
@NotNull String[]	getArgs()	Get the args passed to the command
@NotNull Command	getCommand()	Gets the command that the player is attempting to execute.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull String	getLabel()	Get the label used to execute this command
@NotNull CommandSender	getSender()	Gets the sender that this command will be executed as.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setArgs(@NotNull String[] args)	Set the args passed to the command
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setCommand(@NotNull Command command)	Sets the command that the player will execute.
void	setLabel(@NotNull String label)	Set the label used to execute this command
void	setSender(@NotNull CommandSender sender)	Sets the sender that this command will be executed as.

Methods inherited from class org.bukkit.event.Event

asynchronous, callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

ExecuteCommandEvent

public ExecuteCommandEvent(@NotNull
 @NotNull CommandSender sender,
 @NotNull
 @NotNull Command command,
 @NotNull
 @NotNull String label,
 @Nullable
 @Nullable String[] args)

Method Details

getCommand

@NotNull
public @NotNull Command getCommand()

Gets the command that the player is attempting to execute.

Returns:

Command the player is attempting to execute

setCommand

public void setCommand(@NotNull
 @NotNull Command command)
                throws IllegalArgumentException

Sets the command that the player will execute.

Parameters:

command - New command that the player will execute

Throws:

IllegalArgumentException - if command is null or empty

getSender

@NotNull
public @NotNull CommandSender getSender()

Gets the sender that this command will be executed as.

Returns:

Sender this command will be executed as

setSender

public void setSender(@NotNull
 @NotNull CommandSender sender)
               throws IllegalArgumentException

Sets the sender that this command will be executed as.

Parameters:

sender - New sender which this event will execute as

Throws:

IllegalArgumentException - if the sender provided is null

getLabel

@NotNull
public @NotNull String getLabel()

Get the label used to execute this command

Returns:

Label used to execute this command

setLabel

public void setLabel(@NotNull
 @NotNull String label)

Set the label used to execute this command

Parameters:

label - Label used

getArgs

@NotNull
public @NotNull String[] getArgs()

Get the args passed to the command

Returns:

Args passed to the command

setArgs

public void setArgs(@NotNull
 @NotNull String[] args)

Set the args passed to the command

Parameters:

args - Args passed to the command

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Cancellable

Returns:

true if this event is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()