Package com.velocitypowered.api.event.player

Class ServerPreConnectEvent.ServerResult

java.lang.Object

com.velocitypowered.api.event.player.ServerPreConnectEvent.ServerResult

All Implemented Interfaces:

ResultedEvent.Result

Enclosing class:

ServerPreConnectEvent

public static class ServerPreConnectEvent.ServerResult
extends Object
implements ResultedEvent.Result

Represents the result of the ServerPreConnectEvent.

Method Summary

Modifier and Type	Method	Description
static ServerPreConnectEvent.ServerResult	allowed(RegisteredServer server)	Allows the player to connect to the specified server.
static ServerPreConnectEvent.ServerResult	denied()	Returns a result that will prevent players from connecting to another server.
Optional<RegisteredServer>	getServer()	Returns the server the player will be connected to if the result is allowed.
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

getServer

public Optional<RegisteredServer> getServer()

Returns the server the player will be connected to if the result is allowed.

Returns:

the server to connect to, or an empty Optional if the connection is denied

toString

public String toString()

Overrides:

toString in class Object

denied

public static ServerPreConnectEvent.ServerResult denied()

Returns a result that will prevent players from connecting to another server. If this result is used, then ConnectionRequestBuilder.connect()'s result will have the status ConnectionRequestBuilder.Status.CONNECTION_CANCELLED.

Returns:

a result to deny conneections

allowed

public static ServerPreConnectEvent.ServerResult allowed(RegisteredServer server)

Allows the player to connect to the specified server.

Parameters:

server - the new server to connect to

Returns:

a result to allow the player to connect to the specified server