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
-
Field Summary
-
Constructor Summary
Constructors Constructor Description PlayerKickEvent(Player playerKicked, String kickReason, String leaveMessage)
-
Method Summary
Modifier and Type Method Description static HandlerList
getHandlerList()
HandlerList
getHandlers()
String
getLeaveMessage()
Gets the leave message send to all online playersString
getReason()
Gets the reason why the player is getting kickedboolean
isCancelled()
Gets the cancellation state of this event.void
setCancelled(boolean cancel)
Sets the cancellation state of this event.void
setLeaveMessage(String leaveMessage)
Sets the leave message send to all online playersvoid
setReason(String kickReason)
Sets the reason why the player is getting kicked
-
Constructor Details
-
Method Details
-
getReason
Gets the reason why the player is getting kicked- Returns:
- string kick reason
-
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 interfaceCancellable
- 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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
setReason
Sets the reason why the player is getting kicked- Parameters:
kickReason
- kick reason
-
setLeaveMessage
Sets the leave message send to all online players- Parameters:
leaveMessage
- leave message
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-