Class ServerPreConnectEvent

java.lang.Object

me.internalizable.numdrassl.api.event.server.ServerPreConnectEvent

All Implemented Interfaces:

ResultedEvent<ServerPreConnectEvent.ServerResult>

public class ServerPreConnectEvent
extends Object
implements ResultedEvent<ServerPreConnectEvent.ServerResult>

Event fired before a player connects to a backend server. This includes initial connections and server transfers.

Setting the result allows you to redirect the player to a different server or cancel the connection entirely.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ServerPreConnectEvent.ServerResult	Result for a server pre-connect event.

Nested classes/interfaces inherited from interface ResultedEvent

ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

Constructor	Description
ServerPreConnectEvent(Player player, RegisteredServer server)

Method Summary

Modifier and Type	Method	Description
RegisteredServer	getOriginalServer()	Get the server that was originally requested.
Player	getPlayer()	Get the player being connected.
ServerPreConnectEvent.ServerResult	getResult()	Get the current result.
void	setResult(ServerPreConnectEvent.ServerResult result)	Set the result.

Methods inherited from class Object

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

Constructor Details

ServerPreConnectEvent

public ServerPreConnectEvent(@Nonnull
 Player player,
 @Nonnull
 RegisteredServer server)

Method Details

getPlayer

@Nonnull
public Player getPlayer()

Get the player being connected.

Returns:

the player

getOriginalServer

@Nonnull
public RegisteredServer getOriginalServer()

Get the server that was originally requested.

Returns:

the original target server

getResult

public ServerPreConnectEvent.ServerResult getResult()

Description copied from interface: ResultedEvent

Get the current result.

Specified by:

getResult in interface ResultedEvent<ServerPreConnectEvent.ServerResult>

Returns:

the result

setResult

public void setResult(ServerPreConnectEvent.ServerResult result)

Description copied from interface: ResultedEvent

Set the result.

Specified by:

setResult in interface ResultedEvent<ServerPreConnectEvent.ServerResult>

Parameters:

result - the new result