Package com.velocitypowered.api.event.connection

Class PluginMessageEvent.ForwardResult

java.lang.Object

com.velocitypowered.api.event.connection.PluginMessageEvent.ForwardResult

All Implemented Interfaces:

ResultedEvent.Result

Enclosing class:

PluginMessageEvent

public static final class PluginMessageEvent.ForwardResult
extends Object
implements ResultedEvent.Result

A result determining whether or not to forward this message on.

Method Summary

Modifier and Type	Method	Description
static PluginMessageEvent.ForwardResult	forward()	Returns a result that forwards the plugin message to the target.
static PluginMessageEvent.ForwardResult	handled()	Returns a result that marks the plugin message as handled at the proxy.
boolean	isAllowed()	Returns whether or not the event is allowed to proceed.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

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

forward

public static PluginMessageEvent.ForwardResult forward()

Returns a result that forwards the plugin message to the target.

Returns:

the forward result

handled

public static PluginMessageEvent.ForwardResult handled()

Returns a result that marks the plugin message as handled at the proxy. This prevents it from being forwarded.

Returns:

the handled result