Package org.bukkit.event.player

Class PlayerQuitEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

org.bukkit.event.player.PlayerQuitEvent

public class PlayerQuitEvent
extends PlayerEvent

Called when a player leaves a server

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlayerQuitEvent.QuitReason

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
PlayerQuitEvent(Player who, String quitMessage)
PlayerQuitEvent(Player who, String quitMessage, PlayerQuitEvent.QuitReason quitReason)

Method Summary

Modifier and Type	Method	Description
static HandlerList	getHandlerList()
HandlerList	getHandlers()
String	getQuitMessage()	Gets the quit message to send to all online players
PlayerQuitEvent.QuitReason	getReason()
void	setQuitMessage(String quitMessage)	Sets the quit message to send to all online players

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

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

getPlayer

Constructor Detail

PlayerQuitEvent

public PlayerQuitEvent(@NotNull
                       Player who,
                       @Nullable
                       String quitMessage)

PlayerQuitEvent

public PlayerQuitEvent(@NotNull
                       Player who,
                       @Nullable
                       String quitMessage,
                       @Nullable
                       PlayerQuitEvent.QuitReason quitReason)

Method Detail

getQuitMessage

@Nullable
public String getQuitMessage()

Gets the quit message to send to all online players

Returns:

string quit message

setQuitMessage

public void setQuitMessage(@Nullable
                           String quitMessage)

Sets the quit message to send to all online players

Parameters:

quitMessage - quit message

getHandlers

@NotNull
public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static HandlerList getHandlerList()

getReason

@NotNull
public PlayerQuitEvent.QuitReason getReason()