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
public class PlayerKickEvent extends PlayerEvent implements Cancellable
Called when a player gets kicked from the server

  • 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

      @Internal public PlayerKickEvent(@NotNull @NotNull Player playerKicked, @NotNull @NotNull Component kickReason, @NotNull @NotNull Component leaveMessage, @NotNull @NotNull PlayerKickEvent.Cause cause)

  • Method Details

    • reason

      @NotNull public @NotNull Component reason()
      Gets the reason why the player is getting kicked
      Returns:
      string kick reason

    • reason

      public void reason(@NotNull @NotNull Component kickReason)
      Sets the reason why the player is getting kicked
      Parameters:
      kickReason - kick reason

    • getReason

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

    • setReason

      @Deprecated public void setReason(@NotNull @NotNull String kickReason)
      Deprecated.
      in favour of reason(net.kyori.adventure.text.Component)
      Sets the reason why the player is getting kicked
      Parameters:
      kickReason - kick reason

    • leaveMessage

      @NotNull public @NotNull Component leaveMessage()
      Gets the leave message send to all online players
      Returns:
      string kick reason

    • leaveMessage

      public void leaveMessage(@NotNull @NotNull Component leaveMessage)
      Sets the leave message send to all online players
      Parameters:
      leaveMessage - leave message

    • getLeaveMessage

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

    • setLeaveMessage

      @Deprecated public void setLeaveMessage(@NotNull @NotNull String leaveMessage)
      Deprecated.
      in favour of leaveMessage(net.kyori.adventure.text.Component)
      Sets the leave message send to all online players
      Parameters:
      leaveMessage - leave message

    • getCause

      @NotNull public PlayerKickEvent.Cause getCause()
      Gets the cause of this kick

    • 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

    • 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

    • getHandlers

      @NotNull public @NotNull HandlerList getHandlers()
      Specified by:
      getHandlers in class Event

    • getHandlerList

      @NotNull public static @NotNull HandlerList getHandlerList()