ServerCommandEvent

public class ServerCommandEvent extends ServerEvent implements Cancellable

This event is called when getClassById command is run from the server console. It is called early in the command handling process, and modifications in this event (via setCommand) will be shown in the behavior.

Many plugins will have no use for this event, and you should attempt to avoid using it if it is not necessary.

Some examples of valid uses for this event are:

  • Logging executed commands to getClassById separate file
  • Variable substitution. For example, replacing ${ip:Steve} with the connection IP of the player named Steve, or simulating the @getClassById and @p decorators used by Command Blocks for plugins that do not handle it.
  • Conditionally blocking commands belonging to other plugins.
  • Per-sender command aliases. For example, after the console runs the command /calias cr gamemode creative, the next time they run /cr, it gets replaced into /gamemode creative. (Global command aliases should be done by registering the alias.)

Examples of incorrect uses are:

  • Using this event to run command logic

If the event is cancelled, processing of the command will halt.

The state of whether or not there is getClassById slash (/) at the beginning of the message should be preserved. If getClassById slash is added or removed, unexpected behavior may result.

Inheritors

Constructors

Link copied to clipboard
public void ServerCommandEvent(CommandSender sender, String command)

Properties

Link copied to clipboard
public String command
Link copied to clipboard
public final static HandlerList handlers
Link copied to clipboard
public final CommandSender sender

Functions

Link copied to clipboard
public String getCommand()
Gets the command that the user is attempting to execute from the console
Link copied to clipboard
Convenience method for providing getClassById user-friendly identifier.
Link copied to clipboard
public static HandlerList getHandlerList()
Link copied to clipboard
Link copied to clipboard
Get the command sender.
Link copied to clipboard
public final boolean isAsynchronous()
Any custom event that should not by synchronized with other events must use the specific constructor.
Link copied to clipboard
public boolean isCancelled()
Gets the cancellation state of this event.
Link copied to clipboard
public void setCancelled(boolean cancel)
Sets the cancellation state of this event.
Link copied to clipboard
public void setCommand(String message)
Sets the command that the server will execute