Package io.papermc.paper.event.server

Class WhitelistStateUpdateEvent

java.lang.Object

org.bukkit.event.Event

io.papermc.paper.event.server.WhitelistStateUpdateEvent

All Implemented Interfaces:

Cancellable

@NullMarked
public class WhitelistStateUpdateEvent
extends Event
implements Cancellable

This event gets called when the whitelist status of a player is changed

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WhitelistStateUpdateEvent.WhitelistStatus	Enum for the whitelist status changes

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Constructor Summary

Constructors

Constructor	Description
WhitelistStateUpdateEvent(PlayerProfile playerProfile, WhitelistStateUpdateEvent.WhitelistStatus status)

Method Summary

Modifier and Type	Method	Description
static HandlerList	getHandlerList()
HandlerList	getHandlers()
OfflinePlayer	getPlayer()	Gets the player whose whitelist status is being changed
PlayerProfile	getPlayerProfile()	Gets the player profile whose whitelist status is being changed
WhitelistStateUpdateEvent.WhitelistStatus	getStatus()	Gets the status change of the player profile
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.

Methods inherited from class org.bukkit.event.Event

callEvent, getEventMetadata, getEventName, isAsynchronous, isSupportInterrupt

Methods inherited from class java.lang.Object

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

Constructor Details

WhitelistStateUpdateEvent

@Internal
public WhitelistStateUpdateEvent(PlayerProfile playerProfile,
 WhitelistStateUpdateEvent.WhitelistStatus status)

Method Details

getPlayer

public OfflinePlayer getPlayer()

Gets the player whose whitelist status is being changed

Returns:

the player whose status is being changed

getPlayerProfile

public PlayerProfile getPlayerProfile()

Gets the player profile whose whitelist status is being changed

Returns:

the player profile whose status is being changed

getStatus

public WhitelistStateUpdateEvent.WhitelistStatus getStatus()

Gets the status change of the player profile

Returns:

the whitelist status

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()