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
This event gets called when the whitelist status of a player is changed
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
Enum for the whitelist status changesNested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Constructor Summary
ConstructorDescriptionWhitelistStateUpdateEvent
(@NotNull PlayerProfile who, @NotNull WhitelistStateUpdateEvent.WhitelistStatus status) -
Method Summary
Modifier and TypeMethodDescriptionstatic @NotNull HandlerList
Gets the player whose whitelist status is being changedGets the player profile whose whitelist status is being changedGets the status change of the player profileboolean
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
asynchronous, callEvent, getEventName, isAsynchronous
-
Constructor Details
-
WhitelistStateUpdateEvent
public WhitelistStateUpdateEvent(@NotNull @NotNull PlayerProfile who, @NotNull @NotNull WhitelistStateUpdateEvent.WhitelistStatus status)
-
-
Method Details
-
getPlayer
Gets the player whose whitelist status is being changed- Returns:
- the player whose status is being changed
-
getPlayerProfile
Gets the player profile whose whitelist status is being changed- Returns:
- the player profile whose status is being changed
-
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 interfaceCancellable
- 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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-