com.velocitypowered.api.proxy

Interface ConnectionRequestBuilder.Result

Enclosing interface:

ConnectionRequestBuilder

public static interface ConnectionRequestBuilder.Result

Represents the result of a connection request.

Method Summary

Modifier and Type	Method and Description
RegisteredServer	getAttemptedConnection() Returns the server we actually tried to connect to.
Optional<Component>	getReason() Returns an (optional) textual reason for the failure to connect to the server.
ConnectionRequestBuilder.Status	getStatus() Returns the status associated with this result.
default boolean	isSuccessful() Determines whether or not the connection request was successful.

Method Detail

isSuccessful

default boolean isSuccessful()

Determines whether or not the connection request was successful.

Returns:

whether or not the request succeeded

getStatus

ConnectionRequestBuilder.Status getStatus()

Returns the status associated with this result.

Returns:

the status for this result

getReason

Optional<Component> getReason()

Returns an (optional) textual reason for the failure to connect to the server.

Returns:

the reason why the user could not connect to the server

getAttemptedConnection

RegisteredServer getAttemptedConnection()

Returns the server we actually tried to connect to.

Returns:

the server we actually tried to connect to