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

  • Method Details

    • getReason

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

    • getLeaveMessage

      @NotNull public String getLeaveMessage()
      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 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

    • setReason

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

    • setLeaveMessage

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

    • getHandlers

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

    • getHandlerList

      @NotNull public static HandlerList getHandlerList()