Class KickedFromServerEvent
java.lang.Object
com.velocitypowered.api.event.player.KickedFromServerEvent
- All Implemented Interfaces:
ResultedEvent<KickedFromServerEvent.ServerKickResult>
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 ClassesModifier and TypeClassDescriptionstatic final class
Tells the proxy to disconnect the player with the specified reason.static final class
Notifies the player with the specified message but does nothing else.static final class
Tells the proxy to redirect the player to another server.static interface
Represents the base interface forKickedFromServerEvent
results.Nested classes/interfaces inherited from interface com.velocitypowered.api.event.ResultedEvent
ResultedEvent.ComponentResult, ResultedEvent.GenericResult, ResultedEvent.Result
-
Constructor Summary
ConstructorsConstructorDescriptionKickedFromServerEvent
(Player player, RegisteredServer server, @Nullable Component originalReason, boolean duringServerConnect, KickedFromServerEvent.ServerKickResult result) Creates aKickedFromServerEvent
instance. -
Method Summary
Modifier and TypeMethodDescriptionReturns the result associated with this event.boolean
Deprecated.boolean
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.
-
Constructor Details
-
KickedFromServerEvent
public KickedFromServerEvent(Player player, RegisteredServer server, @Nullable Component originalReason, boolean duringServerConnect, KickedFromServerEvent.ServerKickResult result) Creates aKickedFromServerEvent
instance.- Parameters:
player
- the player affectedserver
- the server the player disconnected fromoriginalReason
- the reason for being kicked, optionalduringServerConnect
- whether or not the player was kicked during the connection processresult
- the initial result
-
-
Method Details
-
getResult
Description copied from interface:ResultedEvent
Returns the result associated with this event.- Specified by:
getResult
in interfaceResultedEvent<KickedFromServerEvent.ServerKickResult>
- Returns:
- the result of this event
-
setResult
Description copied from interface:ResultedEvent
Sets the result of this event. The result must be non-null.- Specified by:
setResult
in interfaceResultedEvent<KickedFromServerEvent.ServerKickResult>
- Parameters:
result
- the new result
-
getPlayer
-
getServer
-
getServerKickReason
-
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.kickedDuringServerConnect()
has a better name and reflects the actual resultReturns whether or not the player got kicked while logging in.- Returns:
- whether or not the player got kicked
-
kickedDuringServerConnect()
has a better name and reflects the actual result