Class PlayerKickEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerKickEvent
All Implemented Interfaces:
Cancellable
@NullMarked public class PlayerKickEvent extends PlayerEvent implements Cancellable
Called when a player gets kicked from the server
Since:
1.0.0

  • Constructor Details

    • PlayerKickEvent

      @Internal @Deprecated(forRemoval=true) public PlayerKickEvent(Player playerKicked, String kickReason, String leaveMessage)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • PlayerKickEvent

      @Internal @Deprecated(forRemoval=true) public PlayerKickEvent(Player playerKicked, net.kyori.adventure.text.Component kickReason, net.kyori.adventure.text.Component leaveMessage)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • PlayerKickEvent

      @Internal public PlayerKickEvent(Player playerKicked, net.kyori.adventure.text.Component kickReason, net.kyori.adventure.text.Component leaveMessage, PlayerKickEvent.Cause cause)

  • Method Details

    • reason

      public net.kyori.adventure.text.Component reason()
      Gets the reason why the player is getting kicked
      Returns:
      string kick reason
      Since:
      1.16.5

    • reason

      public void reason(net.kyori.adventure.text.Component kickReason)
      Sets the reason why the player is getting kicked
      Parameters:
      kickReason - kick reason
      Since:
      1.16.5

    • getReason

      @Deprecated public String getReason()
      Deprecated.
      in favour of reason()
      Gets the reason why the player is getting kicked
      Returns:
      string kick reason
      Since:
      1.0.0

    • setReason

      @Deprecated public void setReason(String kickReason)
      Deprecated.
      in favour of reason(Component)
      Sets the reason why the player is getting kicked
      Parameters:
      kickReason - kick reason
      Since:
      1.0.0

    • leaveMessage

      public @Nullable net.kyori.adventure.text.Component leaveMessage()
      Gets the leave message send to all online players
      Returns:
      string kick reason
      Since:
      1.16.5

    • leaveMessage

      public void leaveMessage(@Nullable net.kyori.adventure.text.Component leaveMessage)
      Sets the leave message send to all online players
      Parameters:
      leaveMessage - leave message. If null, no message will be sent
      Since:
      1.16.5

    • getLeaveMessage

      @Deprecated public @Nullable String getLeaveMessage()
      Deprecated.
      in favour of leaveMessage()
      Gets the leave message send to all online players
      Returns:
      string kick reason
      Since:
      1.0.0

    • setLeaveMessage

      @Deprecated public void setLeaveMessage(@Nullable String leaveMessage)
      Deprecated.
      in favour of leaveMessage(Component)
      Sets the leave message send to all online players
      Parameters:
      leaveMessage - leave message. If null, no message will be sent
      Since:
      1.0.0

    • getCause

      public PlayerKickEvent.Cause getCause()
      Gets the cause of this kick
      Since:
      1.16.5

    • 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 interface Cancellable
      Returns:
      true if this event is cancelled
      Since:
      1.0.0

    • 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 interface Cancellable
      Parameters:
      cancel - true if you wish to cancel this event
      Since:
      1.0.0

    • getHandlers

      public HandlerList getHandlers()
      Specified by:
      getHandlers in class Event
      Since:
      1.1.0

    • getHandlerList

      public static HandlerList getHandlerList()
      Since:
      1.1.0