Package org.bukkit.event.player
Class PlayerKickEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerKickEvent
- All Implemented Interfaces:
Cancellable
Called when a player gets kicked from the server
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.player.PlayerEvent
player
-
Constructor Summary
ConstructorDescriptionPlayerKickEvent
(@NotNull Player playerKicked, @NotNull String kickReason, @NotNull String leaveMessage) Deprecated.PlayerKickEvent
(@NotNull Player playerKicked, Component kickReason, Component leaveMessage) Deprecated.PlayerKickEvent
(@NotNull Player playerKicked, Component kickReason, Component leaveMessage, @NotNull PlayerKickEvent.Cause cause) -
Method Summary
Modifier and TypeMethodDescriptiongetCause()
Gets the cause of this kickstatic @NotNull HandlerList
Deprecated.Deprecated.in favour ofreason()
boolean
Gets the cancellation state of this event.Gets the leave message send to all online playersvoid
leaveMessage
(@NotNull Component leaveMessage) Sets the leave message send to all online playersreason()
Gets the reason why the player is getting kickedvoid
Sets the reason why the player is getting kickedvoid
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setLeaveMessage
(@NotNull String leaveMessage) Deprecated.in favour ofleaveMessage(net.kyori.adventure.text.Component)
void
Deprecated.in favour ofreason(net.kyori.adventure.text.Component)
Methods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerKickEvent
@Deprecated public PlayerKickEvent(@NotNull @NotNull Player playerKicked, @NotNull @NotNull String kickReason, @NotNull @NotNull String leaveMessage) Deprecated. -
PlayerKickEvent
@Deprecated public PlayerKickEvent(@NotNull @NotNull Player playerKicked, @NotNull Component kickReason, @NotNull Component leaveMessage) Deprecated. -
PlayerKickEvent
-
-
Method Details
-
leaveMessage
Gets the leave message send to all online players- Returns:
- string kick reason
-
leaveMessage
Sets the leave message send to all online players- Parameters:
leaveMessage
- leave message
-
reason
Gets the reason why the player is getting kicked- Returns:
- string kick reason
-
reason
Sets the reason why the player is getting kicked- Parameters:
kickReason
- kick reason
-
getReason
Deprecated.in favour ofreason()
Gets the reason why the player is getting kicked- Returns:
- string kick reason
-
getLeaveMessage
Deprecated.in favour ofleaveMessage()
Gets the leave message send to all online players- Returns:
- string kick reason
-
isCancelled
public boolean isCancelled()Description copied from interface:Cancellable
Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins- Specified by:
isCancelled
in interfaceCancellable
- Returns:
- true if this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel) Description copied from interface:Cancellable
Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.- Specified by:
setCancelled
in interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
setReason
Deprecated.in favour ofreason(net.kyori.adventure.text.Component)
Sets the reason why the player is getting kicked- Parameters:
kickReason
- kick reason
-
setLeaveMessage
Deprecated.in favour ofleaveMessage(net.kyori.adventure.text.Component)
Sets the leave message send to all online players- Parameters:
leaveMessage
- leave message
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-
getCause
Gets the cause of this kick- Returns:
-
leaveMessage()