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

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(@NotNull PlayerProfile playerProfile, @NotNull WhitelistStateUpdateEvent.WhitelistStatus status)

Method Summary

Modifier and Type	Method	Description
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull OfflinePlayer	getPlayer()	Gets the player whose whitelist status is being changed
@NotNull PlayerProfile	getPlayerProfile()	Gets the player profile whose whitelist status is being changed
@NotNull 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, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

WhitelistStateUpdateEvent

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

Method Details

getPlayer

@NotNull
public @NotNull OfflinePlayer getPlayer()

Gets the player whose whitelist status is being changed

Returns:

the player whose status is being changed

getPlayerProfile

@NotNull
public @NotNull PlayerProfile getPlayerProfile()

Gets the player profile whose whitelist status is being changed

Returns:

the player profile whose status is being changed

getStatus

@NotNull
public @NotNull 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

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()