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

  • 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

    Constructors 
    Constructor Description
    PlayerKickEvent​(Player playerKicked, java.lang.String kickReason, java.lang.String leaveMessage)  

  • Method Summary

    Modifier and Type Method Description
    static HandlerList getHandlerList()  
    HandlerList getHandlers()  
    java.lang.String getLeaveMessage()
    Gets the leave message send to all online players
    java.lang.String getReason()
    Gets the reason why the player is getting kicked
    boolean isCancelled()
    Gets the cancellation state of this event.
    void setCancelled​(boolean cancel)
    Sets the cancellation state of this event.
    void setLeaveMessage​(java.lang.String leaveMessage)
    Sets the leave message send to all online players
    void setReason​(java.lang.String kickReason)
    Sets the reason why the player is getting kicked

    Methods inherited from class org.bukkit.event.player.PlayerEvent

    getPlayer

    Methods inherited from class org.bukkit.event.Event

    getEventName, isAsynchronous

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PlayerKickEvent

      public PlayerKickEvent​(Player playerKicked, java.lang.String kickReason, java.lang.String leaveMessage)

  • Method Details

    • getReason

      public java.lang.String getReason()
      Gets the reason why the player is getting kicked
      Returns:
      string kick reason

    • getLeaveMessage

      public java.lang.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​(java.lang.String kickReason)
      Sets the reason why the player is getting kicked
      Parameters:
      kickReason - kick reason

    • setLeaveMessage

      public void setLeaveMessage​(java.lang.String leaveMessage)
      Sets the leave message send to all online players
      Parameters:
      leaveMessage - leave message

    • getHandlers

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

    • getHandlerList

      public static HandlerList getHandlerList()