|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.bukkit.event.Event org.bukkit.event.player.PlayerEvent org.bukkit.event.player.PlayerKickEvent
public class PlayerKickEvent
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 | |
---|---|
PlayerKickEvent(Player playerKicked,
String kickReason,
String leaveMessage)
|
Method Summary | |
---|---|
static HandlerList |
getHandlerList()
|
HandlerList |
getHandlers()
|
String |
getLeaveMessage()
Gets the leave message send to all online players |
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(String leaveMessage)
Sets the leave message send to all online players |
void |
setReason(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 Detail |
---|
public PlayerKickEvent(Player playerKicked, String kickReason, String leaveMessage)
Method Detail |
---|
public String getReason()
public String getLeaveMessage()
public boolean isCancelled()
Cancellable
isCancelled
in interface Cancellable
public void setCancelled(boolean cancel)
Cancellable
setCancelled
in interface Cancellable
cancel
- true if you wish to cancel this eventpublic void setReason(String kickReason)
kickReason
- kick reasonpublic void setLeaveMessage(String leaveMessage)
leaveMessage
- leave messagepublic HandlerList getHandlers()
getHandlers
in class Event
public static HandlerList getHandlerList()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |