Package com.velocitypowered.api.event.command

Class CommandExecuteEvent.CommandResult

java.lang.Object

com.velocitypowered.api.event.command.CommandExecuteEvent.CommandResult

All Implemented Interfaces:

ResultedEvent.Result

Enclosing class:

CommandExecuteEvent

public static final class CommandExecuteEvent.CommandResult
extends Object
implements ResultedEvent.Result

Represents the result of the CommandExecuteEvent.

Method Summary

Modifier and Type	Method	Description
static CommandExecuteEvent.CommandResult	allowed()	Allows the command to be sent, without modification.
static CommandExecuteEvent.CommandResult	command(@NonNull String newCommand)	Allows the command to be executed, but silently replaces the command with a different command.
static CommandExecuteEvent.CommandResult	denied()	Prevents the command from being executed.
static CommandExecuteEvent.CommandResult	forwardToServer()	Forwards the command to server instead of executing it on the proxy.
static CommandExecuteEvent.CommandResult	forwardToServer(@NonNull String newCommand)	Prevents the command from being executed on proxy, but forward command to server.
Optional<String>	getCommand()
boolean	isAllowed()	Returns whether or not the event is allowed to proceed.
boolean	isForwardToServer()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

getCommand

public Optional<String> getCommand()

isForwardToServer

public boolean isForwardToServer()

isAllowed

public boolean isAllowed()

Description copied from interface: ResultedEvent.Result

Returns whether or not the event is allowed to proceed. Plugins may choose to skip denied events, and the proxy will respect the result of this method.

Specified by:

isAllowed in interface ResultedEvent.Result

Returns:

whether or not the event is allowed to proceed

toString

public String toString()

Overrides:

toString in class Object

allowed

public static CommandExecuteEvent.CommandResult allowed()

Allows the command to be sent, without modification.

Returns:

the allowed result

denied

public static CommandExecuteEvent.CommandResult denied()

Prevents the command from being executed.

Returns:

the denied result

forwardToServer

public static CommandExecuteEvent.CommandResult forwardToServer()

Forwards the command to server instead of executing it on the proxy. This is the default behavior when a command is not registered on Velocity.

Returns:

the forward result

forwardToServer

public static CommandExecuteEvent.CommandResult forwardToServer(@NonNull String newCommand)

Prevents the command from being executed on proxy, but forward command to server.

Parameters:

newCommand - the command without first slash to use instead

Returns:

a result with a new command being forwarded to server

command

public static CommandExecuteEvent.CommandResult command(@NonNull String newCommand)

Allows the command to be executed, but silently replaces the command with a different command.

Parameters:

newCommand - the command to use instead without first slash

Returns:

a result with a new command