org.bukkit.event.player.PlayerKickEvent Class Reference

Called when a player gets kicked from the server. More...

Inheritance diagram for org.bukkit.event.player.PlayerKickEvent:

Collaboration diagram for org.bukkit.event.player.PlayerKickEvent:

Public Member Functions
	PlayerKickEvent (final Player playerKicked, final String kickReason, final String leaveMessage)
String	getReason ()
	Gets the reason why the player is getting kicked.
String	getLeaveMessage ()
	Gets the leave message send to all online players.
boolean	isCancelled ()
void	setCancelled (boolean cancel)
void	setReason (String kickReason)
	Sets the reason why the player is getting kicked.
void	setLeaveMessage (String leaveMessage)
	Sets the leave message send to all online players.
HandlerList	getHandlers ()
Public Member Functions inherited from org.bukkit.event.player.PlayerEvent
	PlayerEvent (final Player who)
final Player	getPlayer ()
	Returns the player involved in this event.
Public Member Functions inherited from org.bukkit.event.Event
	Event ()
	The default constructor is defined for cleaner code.
	Event (boolean isAsync)
	This constructor is used to explicitly declare an event as synchronous or asynchronous.
String	getEventName ()
	Convenience method for providing a user-friendly identifier.
final boolean	isAsynchronous ()
	Any custom event that should not by synchronized with other events must use the specific constructor.
Public Member Functions inherited from org.bukkit.event.Cancellable
boolean	isCancelled ()
	Gets the cancellation state of this event.
void	setCancelled (boolean cancel)
	Sets the cancellation state of this event.

Static Public Member Functions
static HandlerList	getHandlerList ()

Additional Inherited Members
Protected Attributes inherited from org.bukkit.event.player.PlayerEvent
Player	player

Detailed Description

Called when a player gets kicked from the server.

Definition at line 10 of file PlayerKickEvent.java.

Constructor & Destructor Documentation

org.bukkit.event.player.PlayerKickEvent.PlayerKickEvent	(	final Player	playerKicked,
		final String	kickReason,
		final String	leaveMessage
	)

Definition at line 16 of file PlayerKickEvent.java.

Member Function Documentation

static HandlerList org.bukkit.event.player.PlayerKickEvent.getHandlerList ( )

static

Definition at line 72 of file PlayerKickEvent.java.

HandlerList org.bukkit.event.player.PlayerKickEvent.getHandlers ( )

virtual

Implements org.bukkit.event.Event.

Definition at line 68 of file PlayerKickEvent.java.

String org.bukkit.event.player.PlayerKickEvent.getLeaveMessage

(

)

Gets the leave message send to all online players.

Returns

string kick reason

Definition at line 37 of file PlayerKickEvent.java.

String org.bukkit.event.player.PlayerKickEvent.getReason

(

)

Gets the reason why the player is getting kicked.

Returns

string kick reason

Definition at line 28 of file PlayerKickEvent.java.

boolean org.bukkit.event.player.PlayerKickEvent.isCancelled

(

)

Definition at line 41 of file PlayerKickEvent.java.

void org.bukkit.event.player.PlayerKickEvent.setCancelled

(

boolean

cancel

)

Definition at line 45 of file PlayerKickEvent.java.

void org.bukkit.event.player.PlayerKickEvent.setLeaveMessage

(

String

leaveMessage

)

Sets the leave message send to all online players.

Parameters

leaveMessage

leave message

Definition at line 63 of file PlayerKickEvent.java.

void org.bukkit.event.player.PlayerKickEvent.setReason

(

String

kickReason

)

Sets the reason why the player is getting kicked.

Parameters

kickReason

kick reason

Definition at line 54 of file PlayerKickEvent.java.

---

The documentation for this class was generated from the following file:

• org/bukkit/event/player/PlayerKickEvent.java