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

Since:

1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlayerQuitEvent.QuitReason

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields inherited from class PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
PlayerQuitEvent(@NotNull Player player, @Nullable String quitMessage)	Deprecated, for removal: This API element is subject to removal in a future version.
PlayerQuitEvent(@NotNull Player player, @Nullable String quitMessage, @Nullable PlayerQuitEvent.QuitReason quitReason)	Deprecated, for removal: This API element is subject to removal in a future version.
PlayerQuitEvent(@NotNull Player player, @Nullable Component quitMessage)	Deprecated, for removal: This API element is subject to removal in a future version.
PlayerQuitEvent(@NotNull Player player, @Nullable Component quitMessage, @Nullable PlayerQuitEvent.QuitReason quitReason)

Method Summary

Modifier and Type	Method	Description
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@Nullable String	getQuitMessage()	Deprecated. in favour of quitMessage()
@NotNull PlayerQuitEvent.QuitReason	getReason()
@Nullable Component	quitMessage()	Gets the quit message to send to all online players
void	quitMessage(@Nullable Component quitMessage)	Sets the quit message to send to all online players
void	setQuitMessage(@Nullable String quitMessage)	Deprecated. in favour of quitMessage(Component)

Methods inherited from class PlayerEvent

getPlayer

Methods inherited from class Event

callEvent, getEventName, isAsynchronous

Methods inherited from class Object

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

Constructor Details

PlayerQuitEvent

@Internal
@Deprecated(forRemoval=true)
public PlayerQuitEvent(@NotNull
 @NotNull Player player,
 @Nullable
 @Nullable String quitMessage)

Deprecated, for removal: This API element is subject to removal in a future version.

PlayerQuitEvent

@Internal
@Deprecated(forRemoval=true)
public PlayerQuitEvent(@NotNull
 @NotNull Player player,
 @Nullable
 @Nullable String quitMessage,
 @Nullable
 @Nullable PlayerQuitEvent.QuitReason quitReason)

Deprecated, for removal: This API element is subject to removal in a future version.

PlayerQuitEvent

@Internal
@Deprecated(forRemoval=true)
public PlayerQuitEvent(@NotNull
 @NotNull Player player,
 @Nullable
 @Nullable Component quitMessage)

Deprecated, for removal: This API element is subject to removal in a future version.

PlayerQuitEvent

@Internal
public PlayerQuitEvent(@NotNull
 @NotNull Player player,
 @Nullable
 @Nullable Component quitMessage,
 @Nullable
 @Nullable PlayerQuitEvent.QuitReason quitReason)

Method Details

quitMessage

@Nullable
public @Nullable Component quitMessage()

Gets the quit message to send to all online players

Returns:

string quit message

Since:

1.16.5

quitMessage

public void quitMessage(@Nullable
 @Nullable Component quitMessage)

Sets the quit message to send to all online players

Parameters:

quitMessage - quit message

Since:

1.16.5

getQuitMessage

@Nullable
@Deprecated
public @Nullable String getQuitMessage()

Deprecated.

in favour of quitMessage()

Gets the quit message to send to all online players

Returns:

string quit message

Since:

1.0.0

setQuitMessage

@Deprecated
public void setQuitMessage(@Nullable
 @Nullable String quitMessage)

Deprecated.

in favour of quitMessage(Component)

Sets the quit message to send to all online players

Parameters:

quitMessage - quit message

Since:

1.0.0

getReason

@NotNull
public @NotNull PlayerQuitEvent.QuitReason getReason()

Since:

1.16.4

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

Since:

1.1.0

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()

Since:

1.1.0