Class KickedFromServerEvent
- java.lang.Object
-
- com.velocitypowered.api.event.player.KickedFromServerEvent
-
- All Implemented Interfaces:
ResultedEvent<KickedFromServerEvent.ServerKickResult>
public final class KickedFromServerEvent extends java.lang.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).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
KickedFromServerEvent.DisconnectPlayer
Tells the proxy to disconnect the player with the specified reason.static class
KickedFromServerEvent.Notify
Notifies the player with the specified message but does nothing else.static class
KickedFromServerEvent.RedirectPlayer
Tells the proxy to redirect the player to another server.static interface
KickedFromServerEvent.ServerKickResult
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
Constructors Constructor Description KickedFromServerEvent(Player player, RegisteredServer server, @Nullable net.kyori.adventure.text.Component originalReason, boolean duringServerConnect, KickedFromServerEvent.ServerKickResult result)
Creates aKickedFromServerEvent
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Player
getPlayer()
KickedFromServerEvent.ServerKickResult
getResult()
Returns the result associated with this event.RegisteredServer
getServer()
java.util.Optional<net.kyori.adventure.text.Component>
getServerKickReason()
Gets the reason the server kicked the player from the server.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.
-
-
-
Constructor Detail
-
KickedFromServerEvent
public KickedFromServerEvent(Player player, RegisteredServer server, @Nullable net.kyori.adventure.text.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 Detail
-
getResult
public KickedFromServerEvent.ServerKickResult 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
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 interfaceResultedEvent<KickedFromServerEvent.ServerKickResult>
- Parameters:
result
- the new result
-
getPlayer
public Player getPlayer()
-
getServer
public RegisteredServer getServer()
-
getServerKickReason
public java.util.Optional<net.kyori.adventure.text.Component> getServerKickReason()
Gets the reason the server kicked the player from the server.- Returns:
- the server kicked the player from the server
-
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
-
-