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 TypeMethodDescriptionallowed()
Allows the command to be sent, without modification.Allows the command to be executed, but silently replaced old command with another.denied()
Prevents the command from being executed.Prevents the command from being executed, but forward command to server.forwardToServer
(@NonNull String newCommand) Prevents the command from being executed on proxy, but forward command to server.boolean
Returns whether or not the event is allowed to proceed.boolean
toString()
-
Method Details
-
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 interfaceResultedEvent.Result
- Returns:
- whether or not the event is allowed to proceed
-
toString
-
allowed
Allows the command to be sent, without modification.- Returns:
- the allowed result
-
denied
Prevents the command from being executed.- Returns:
- the denied result
-
forwardToServer
Prevents the command from being executed, but forward command to server.- Returns:
- the forward result
-
forwardToServer
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
Allows the command to be executed, but silently replaced old command with another.- Parameters:
newCommand
- the command to use instead without first slash- Returns:
- a result with a new command
-