Class UnknownCommandEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.command.UnknownCommandEvent

@NullMarked
public class UnknownCommandEvent
extends Event

Thrown when a player executes a command that is not defined

Since:

1.12

Nested Class Summary

Nested classes/interfaces inherited from class Event

Event.Result

Constructor Summary

Constructors

Constructor	Description
UnknownCommandEvent(CommandSourceStack commandSource, String commandLine, @Nullable net.kyori.adventure.text.Component message)

Method Summary

Modifier and Type	Method	Description
String	getCommandLine()	Gets the command that was sent
CommandSourceStack	getCommandSource()	Gets the command source associated with this event
static HandlerList	getHandlerList()
HandlerList	getHandlers()
@Nullable String	getMessage()	Deprecated. use message()
CommandSender	getSender()	Gets the CommandSender
@Nullable net.kyori.adventure.text.Component	message()	Gets the message that will be returned
void	message(@Nullable net.kyori.adventure.text.Component message)	Sets the message that will be returned
void	setMessage(@Nullable String message)	Deprecated. use message(Component)

Methods inherited from class Event

callEvent, getEventName, isAsynchronous

Methods inherited from class Object

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

Constructor Details

UnknownCommandEvent

@Internal
public UnknownCommandEvent(CommandSourceStack commandSource,
 String commandLine,
 @Nullable net.kyori.adventure.text.Component message)

Method Details

getSender

public CommandSender getSender()

Gets the CommandSender

Returns:

sender of the command

Since:

1.12

getCommandSource

public CommandSourceStack getCommandSource()

Gets the command source associated with this event

Returns:

the CommandSourceStack

Since:

1.21.10

getCommandLine

public String getCommandLine()

Gets the command that was sent

Returns:

command sent

Since:

1.12

getMessage

@Deprecated
public @Nullable String getMessage()

Deprecated.

use message()

Gets the message that will be returned

Returns:

unknown command message

Since:

1.12

setMessage

@Deprecated
public void setMessage(@Nullable String message)

Deprecated.

use message(Component)

Sets the message that will be returned

Set to null to avoid any message being sent

Parameters:

message - the message to be returned, or null

Since:

1.12

message

@Contract(pure=true)
public @Nullable net.kyori.adventure.text.Component message()

Gets the message that will be returned

Returns:

unknown command message

Since:

1.16.5

message

public void message(@Nullable net.kyori.adventure.text.Component message)

Sets the message that will be returned

Set to null to avoid any message being sent

Parameters:

message - the message to be returned, or null

Since:

1.16.5

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

Since:

1.12

getHandlerList

public static HandlerList getHandlerList()

Since:

1.12