Package com.velocitypowered.api.event

Class ResultedEvent.ComponentResult

java.lang.Object

com.velocitypowered.api.event.ResultedEvent.ComponentResult

All Implemented Interfaces:

ResultedEvent.Result

Enclosing interface:

ResultedEvent<R extends ResultedEvent.Result>

public static final class ResultedEvent.ComponentResult
extends Object
implements ResultedEvent.Result

Represents an "allowed/denied" result with a reason allowed for denial.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ComponentResult(boolean status, @Nullable Component reason)	Represents an allowed or denied result that may include a denial reason.

Method Summary

Modifier and Type	Method	Description
static ResultedEvent.ComponentResult	allowed()	Returns a result indicating the event is allowed to proceed.
static ResultedEvent.ComponentResult	denied(Component reason)	Returns a result indicating the event is denied, with the given reason component.
Optional<Component>	getReasonComponent()	Returns the denial reason component, if present.
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

Constructor Details

ComponentResult

protected ComponentResult(boolean status,
 @Nullable Component reason)

Represents an allowed or denied result that may include a denial reason.

Parameters:

status - whether the result is allowed

reason - the component explaining why the result was denied, or null

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

getReasonComponent

public Optional<Component> getReasonComponent()

Returns the denial reason component, if present.

Returns:

an Optional containing the reason component if the result is denied

toString

public String toString()

Overrides:

toString in class Object

allowed

public static ResultedEvent.ComponentResult allowed()

Returns a result indicating the event is allowed to proceed.

Returns:

an allowed ResultedEvent.ComponentResult

denied

public static ResultedEvent.ComponentResult denied(Component reason)

Returns a result indicating the event is denied, with the given reason component.

Parameters:

reason - the denial reason to show

Returns:

a denied ResultedEvent.ComponentResult

Throws:

NullPointerException - if the reason is null