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 and Description
protected	ComponentResult(boolean status, @Nullable net.kyori.adventure.text.Component reason)

Method Summary

Modifier and Type	Method and Description
static ResultedEvent.ComponentResult	allowed()
static ResultedEvent.ComponentResult	denied(net.kyori.adventure.text.Component reason)
static ResultedEvent.ComponentResult	denied(net.kyori.text.Component reason) Deprecated.
Optional<net.kyori.text.Component>	getReason() Deprecated.
Optional<net.kyori.adventure.text.Component>	getReasonComponent()
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 Detail

ComponentResult

protected ComponentResult(boolean status,
                          @Nullable net.kyori.adventure.text.Component reason)

Method Detail

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

getReason

@Deprecated
public Optional<net.kyori.text.Component> getReason()

Deprecated.

getReasonComponent

public Optional<net.kyori.adventure.text.Component> getReasonComponent()

toString

public String toString()

Overrides:

toString in class Object

allowed

public static ResultedEvent.ComponentResult allowed()

denied

public static ResultedEvent.ComponentResult denied(net.kyori.adventure.text.Component reason)

denied

@Deprecated
public static ResultedEvent.ComponentResult denied(net.kyori.text.Component reason)

Deprecated.