Class PlayerKickEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

org.bukkit.event.player.PlayerKickEvent

All Implemented Interfaces:

Cancellable

@NullMarked
public class PlayerKickEvent
extends PlayerEvent
implements Cancellable

Called when a player gets kicked from the server

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PlayerKickEvent.Cause

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields inherited from class PlayerEvent

player

Constructor Summary

Constructors

Constructor	Description
PlayerKickEvent(Player playerKicked, String kickReason, String leaveMessage)	Deprecated, for removal: This API element is subject to removal in a future version.
PlayerKickEvent(Player playerKicked, Component kickReason, Component leaveMessage)	Deprecated, for removal: This API element is subject to removal in a future version.
PlayerKickEvent(Player playerKicked, Component kickReason, Component leaveMessage, PlayerKickEvent.Cause cause)

Method Summary

Modifier and Type	Method	Description
PlayerKickEvent.Cause	getCause()	Gets the cause of this kick
static HandlerList	getHandlerList()
HandlerList	getHandlers()
@Nullable String	getLeaveMessage()	Deprecated. in favour of leaveMessage()
String	getReason()	Deprecated. in favour of reason()
boolean	isCancelled()	Gets the cancellation state of this event.
@Nullable Component	leaveMessage()	Gets the leave message send to all online players
void	leaveMessage(@Nullable Component leaveMessage)	Sets the leave message send to all online players
Component	reason()	Gets the reason why the player is getting kicked
void	reason(Component kickReason)	Sets the reason why the player is getting kicked
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.
void	setLeaveMessage(@Nullable String leaveMessage)	Deprecated. in favour of leaveMessage(Component)
void	setReason(String kickReason)	Deprecated. in favour of reason(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

PlayerKickEvent

@Internal
@Deprecated(forRemoval=true)
public PlayerKickEvent(Player playerKicked,
 String kickReason,
 String leaveMessage)

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

PlayerKickEvent

@Internal
@Deprecated(forRemoval=true)
public PlayerKickEvent(Player playerKicked,
 Component kickReason,
 Component leaveMessage)

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

PlayerKickEvent

@Internal
public PlayerKickEvent(Player playerKicked,
 Component kickReason,
 Component leaveMessage,
 PlayerKickEvent.Cause cause)

Method Details

reason

public Component reason()

Gets the reason why the player is getting kicked

Returns:

string kick reason

reason

public void reason(Component kickReason)

Sets the reason why the player is getting kicked

Parameters:

kickReason - kick reason

getReason

@Deprecated
public String getReason()

Deprecated.

in favour of reason()

Gets the reason why the player is getting kicked

Returns:

string kick reason

setReason

@Deprecated
public void setReason(String kickReason)

Deprecated.

in favour of reason(Component)

Sets the reason why the player is getting kicked

Parameters:

kickReason - kick reason

leaveMessage

public @Nullable Component leaveMessage()

Gets the leave message send to all online players

Returns:

string kick reason

leaveMessage

public void leaveMessage(@Nullable Component leaveMessage)

Sets the leave message send to all online players

Parameters:

leaveMessage - leave message. If null, no message will be sent

getLeaveMessage

@Deprecated
public @Nullable String getLeaveMessage()

Deprecated.

in favour of leaveMessage()

Gets the leave message send to all online players

Returns:

string kick reason

setLeaveMessage

@Deprecated
public void setLeaveMessage(@Nullable String leaveMessage)

Deprecated.

in favour of leaveMessage(Component)

Sets the leave message send to all online players

Parameters:

leaveMessage - leave message. If null, no message will be sent

getCause

public PlayerKickEvent.Cause getCause()

Gets the cause of this kick

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 interface Cancellable

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 interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()