Package com.velocitypowered.api.event.player

Class KickedFromServerEvent

java.lang.Object

com.velocitypowered.api.event.player.KickedFromServerEvent

All Implemented Interfaces:

ResultedEvent<KickedFromServerEvent.ServerKickResult>

@AwaitingEvent
public final class KickedFromServerEvent
extends Object
implements ResultedEvent<KickedFromServerEvent.ServerKickResult>

Fired when a player is kicked from a server. You may either allow Velocity to kick the player (with an optional reason override) or redirect the player to a separate server. By default, Velocity will notify the user (if they are already connected to a server) or disconnect them (if they are not on a server and no other servers are available). Velocity will wait on this event to finish firing before taking the specified action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	KickedFromServerEvent.DisconnectPlayer	Tells the proxy to disconnect the player with the specified reason.
static final class	KickedFromServerEvent.Notify	Notifies the player with the specified message but does nothing else.
static final class	KickedFromServerEvent.RedirectPlayer	Tells the proxy to redirect the player to another server.
static interface	KickedFromServerEvent.ServerKickResult	Represents the base interface for KickedFromServerEvent results.

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

ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result

Constructor Summary

Constructors

Constructor	Description
KickedFromServerEvent(Player player, RegisteredServer server, @Nullable Component originalReason, boolean duringServerConnect, KickedFromServerEvent.ServerKickResult result)	Creates a KickedFromServerEvent instance.

Method Summary

Modifier and Type	Method	Description
@NonNull Player	getPlayer()	The player who has been kicked out.
@NonNull KickedFromServerEvent.ServerKickResult	getResult()	Returns the result associated with this event.
@NonNull RegisteredServer	getServer()	The server from which the player has been kicked.
Optional<Component>	getServerKickReason()	The reason why the player was kicked, the server may or may not provide this reason.
boolean	kickedDuringLogin()	Deprecated. kickedDuringServerConnect() has a better name and reflects the actual result
boolean	kickedDuringServerConnect()	Returns whether or not the player got kicked while connecting to another server.
void	setResult(@NonNull KickedFromServerEvent.ServerKickResult result)	Sets the result of this event.

Methods inherited from class java.lang.Object

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

Constructor Details

KickedFromServerEvent

public KickedFromServerEvent(Player player,
 RegisteredServer server,
 @Nullable Component originalReason,
 boolean duringServerConnect,
 KickedFromServerEvent.ServerKickResult result)

Creates a KickedFromServerEvent instance.

Parameters:

player - the player affected

server - the server the player disconnected from

originalReason - the reason for being kicked, optional

duringServerConnect - whether or not the player was kicked during the connection process

result - the initial result

Method Details

getResult

public @NonNull KickedFromServerEvent.ServerKickResult getResult()

Description copied from interface: ResultedEvent

Returns the result associated with this event.

Specified by:

getResult in interface ResultedEvent<KickedFromServerEvent.ServerKickResult>

Returns:

the result of this event

setResult

public void setResult(@NonNull KickedFromServerEvent.ServerKickResult result)

Description copied from interface: ResultedEvent

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

Specified by:

setResult in interface ResultedEvent<KickedFromServerEvent.ServerKickResult>

Parameters:

result - the new result

getPlayer

public @NonNull Player getPlayer()

The player who has been kicked out.

Returns:

the player affected

getServer

public @NonNull RegisteredServer getServer()

The server from which the player has been kicked.

Returns:

the server the player disconnected from

getServerKickReason

public Optional<Component> getServerKickReason()

The reason why the player was kicked, the server may or may not provide this reason.

Returns:

the reason for being kicked, optional

kickedDuringServerConnect

public boolean kickedDuringServerConnect()

Returns whether or not the player got kicked while connecting to another server.

Returns:

whether or not the player got kicked

kickedDuringLogin

@Deprecated
public boolean kickedDuringLogin()

Deprecated.

kickedDuringServerConnect() has a better name and reflects the actual result

Returns whether or not the player got kicked while logging in.

Returns:

whether or not the player got kicked