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 ClassesNested 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
ConstructorsConstructorDescriptionPlayerKickEvent(@NotNull Player playerKicked, @NotNull String kickReason, @NotNull String leaveMessage) Deprecated, for removal: This API element is subject to removal in a future version.PlayerKickEvent(@NotNull Player playerKicked, @NotNull Component kickReason, @NotNull Component leaveMessage) Deprecated, for removal: This API element is subject to removal in a future version.PlayerKickEvent(@NotNull Player playerKicked, @NotNull Component kickReason, @NotNull Component leaveMessage, @NotNull PlayerKickEvent.Cause cause) -
Method Summary
Modifier and TypeMethodDescriptiongetCause()Gets the cause of this kickstatic @NotNull HandlerListDeprecated.Deprecated.in favour ofreason()booleanGets the cancellation state of this event.Gets the leave message send to all online playersvoidleaveMessage(@NotNull Component leaveMessage) Sets the leave message send to all online playersreason()Gets the reason why the player is getting kickedvoidSets the reason why the player is getting kickedvoidsetCancelled(boolean cancel) Sets the cancellation state of this event.voidsetLeaveMessage(@NotNull String leaveMessage) Deprecated.in favour ofleaveMessage(net.kyori.adventure.text.Component)voidDeprecated.in favour ofreason(net.kyori.adventure.text.Component)Methods inherited from class org.bukkit.event.player.PlayerEvent
getPlayerMethods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerKickEvent
@Internal @Deprecated(forRemoval=true) public PlayerKickEvent(@NotNull @NotNull Player playerKicked, @NotNull @NotNull String kickReason, @NotNull @NotNull String leaveMessage) Deprecated, for removal: This API element is subject to removal in a future version. -
PlayerKickEvent
@Internal @Deprecated(forRemoval=true) public PlayerKickEvent(@NotNull @NotNull Player playerKicked, @NotNull @NotNull Component kickReason, @NotNull @NotNull Component leaveMessage) Deprecated, for removal: This API element is subject to removal in a future version. -
PlayerKickEvent
-
-
Method Details
-
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
-
setReason
Deprecated.in favour ofreason(net.kyori.adventure.text.Component)Sets the reason why the player is getting kicked- Parameters:
kickReason- kick reason
-
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
-
getLeaveMessage
Deprecated.in favour ofleaveMessage()Gets the leave message send to all online players- Returns:
- string 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
-
getCause
Gets the cause of this kick -
isCancelled
public boolean isCancelled()Description copied from interface:CancellableGets 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:
isCancelledin interfaceCancellable- Returns:
trueif this event is cancelled
-
setCancelled
public void setCancelled(boolean cancel) Description copied from interface:CancellableSets 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:
setCancelledin interfaceCancellable- Parameters:
cancel-trueif you wish to cancel this event
-
getHandlers
- Specified by:
getHandlersin classEvent
-
getHandlerList
-
leaveMessage()