Package com.velocitypowered.api.event.player

Class ServerPreConnectEvent

java.lang.Object

com.velocitypowered.api.event.player.ServerPreConnectEvent

All Implemented Interfaces:

ResultedEvent<ServerPreConnectEvent.ServerResult>

@AwaitingEvent
public final class ServerPreConnectEvent
extends Object
implements ResultedEvent<ServerPreConnectEvent.ServerResult>

This event is fired before the player connects to a server. Velocity will wait on this event to finish firing before initiating the connection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServerPreConnectEvent.ServerResult	Represents the result of the ServerPreConnectEvent.

Nested classes/interfaces inherited from interface com.velocitypowered.api.event.ResultedEvent

ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

Constructor	Description
ServerPreConnectEvent(Player player, RegisteredServer originalServer)	Creates the ServerPreConnectEvent.
ServerPreConnectEvent(Player player, RegisteredServer originalServer, @Nullable RegisteredServer previousServer)	Creates the ServerPreConnectEvent.

Method Summary

Modifier and Type	Method	Description
RegisteredServer	getOriginalServer()	Returns the server that the player originally tried to connect to.
Player	getPlayer()	Returns the player connecting to the server.
@Nullable RegisteredServer	getPreviousServer()	Returns the server that the player is currently connected to.
ServerPreConnectEvent.ServerResult	getResult()	Returns the result associated with this event.
void	setResult(ServerPreConnectEvent.ServerResult result)	Sets the result of this event.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerPreConnectEvent

public ServerPreConnectEvent(Player player,
                             RegisteredServer originalServer)

Creates the ServerPreConnectEvent.

Parameters:

player - the player who is connecting to a server

originalServer - the server the player was trying to connect to

ServerPreConnectEvent

public ServerPreConnectEvent(Player player,
                             RegisteredServer originalServer,
                             @Nullable RegisteredServer previousServer)

Creates the ServerPreConnectEvent.

Parameters:

player - the player who is connecting to a server

originalServer - the server the player was trying to connect to

previousServer - the server the player ís connected to

Method Detail

getPlayer

public Player getPlayer()

Returns the player connecting to the server.

Returns:

the player connecting to the server

getResult

public ServerPreConnectEvent.ServerResult getResult()

Description copied from interface: ResultedEvent

Returns the result associated with this event.

Specified by:

getResult in interface ResultedEvent<ServerPreConnectEvent.ServerResult>

Returns:

the result of this event

setResult

public void setResult(ServerPreConnectEvent.ServerResult result)

Description copied from interface: ResultedEvent

Sets the result of this event. The result must be non-null.

Specified by:

setResult in interface ResultedEvent<ServerPreConnectEvent.ServerResult>

Parameters:

result - the new result

getOriginalServer

public RegisteredServer getOriginalServer()

Returns the server that the player originally tried to connect to. To get the server the player will connect to, see the ServerPreConnectEvent.ServerResult of this event. To get the server the player is currently on when this event is fired, use getPreviousServer().

Returns:

the server that the player originally tried to connect to

getPreviousServer

public @Nullable RegisteredServer getPreviousServer()

Returns the server that the player is currently connected to. Prefer this method over using Player.getCurrentServer() as the current server might get reset after server kicks to prevent connection issues. This is null if they were not connected to another server beforehand (for instance, if the player has just joined the proxy).

Returns:

the server the player is currently connected to.

toString

public String toString()

Overrides:

toString in class Object