Class ClaimWhitelistChangeEvent

java.lang.Object

org.bukkit.event.Event

net.mathias2246.buildmc.api.event.CustomEvent

net.mathias2246.buildmc.api.event.claims.ClaimWhitelistChangeEvent

All Implemented Interfaces:

org.bukkit.event.Cancellable

public class ClaimWhitelistChangeEvent
extends CustomEvent
implements org.bukkit.event.Cancellable

Called when the whitelist of a Claim is about to change.

This event is fired before the whitelist is actually updated. It is cancellable, allowing other plugins to prevent the whitelist change from occurring.

This event is called when a plugin, or player adds or removes a member from the whitelist of a claim.

If this event is cancelled, the whitelist will remain unchanged.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ClaimWhitelistChangeEvent.ChangeAction	Defines which action was applied on the whitelist.

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

org.bukkit.event.Event.Result

Field Summary

Fields inherited from class CustomEvent

metadataHolder

Constructor Summary

Constructors

Constructor	Description
ClaimWhitelistChangeEvent(@NotNull Claim claim, @NotNull org.bukkit.OfflinePlayer whitelistedPlayer, @NotNull ClaimWhitelistChangeEvent.ChangeAction action)	The default constructor for creating this event.

Method Summary

Modifier and Type	Method	Description
@NotNull ClaimWhitelistChangeEvent.ChangeAction	getAction()	Gets the kind of action that will be used on the player in the whitelist.
@NotNull Claim	getClaim()	Gets the claim where the whitelist is about to be changed.
static org.bukkit.event.HandlerList	getHandlerList()	Gets the static list of handlers for this event type.
@NotNull org.bukkit.event.HandlerList	getHandlers()	Returns the HandlerList for this event type.
long	getTimestamp()	Gets when the change occurred.
@NotNull org.bukkit.OfflinePlayer	getWhitelistedPlayer()	Gets the player that is about to be added or removed from the whitelist depending on the action.
boolean	isAddedAction()	If the action of this event is ClaimWhitelistChangeEvent.ChangeAction.ADDED.
boolean	isCancelled()	Gets the cancellation state of this event.
boolean	isRemovedAction()	If the action of this event is ClaimWhitelistChangeEvent.ChangeAction.REMOVED.
void	setCancelled(boolean b)	Sets the cancellation state of this event.

Methods inherited from class CustomEvent

getMetadata, putMetadata, removeMetadata

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class Object

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

Constructor Details

ClaimWhitelistChangeEvent

public ClaimWhitelistChangeEvent(@NotNull
 @NotNull Claim claim,
 @NotNull
 @NotNull org.bukkit.OfflinePlayer whitelistedPlayer,
 @NotNull
 @NotNull ClaimWhitelistChangeEvent.ChangeAction action)

The default constructor for creating this event.

Parameters:

claim - The claim where the whitelist is about to be changed.

whitelistedPlayer - The player that will be added or removed from the whitelist depending on the action.

action - The action that will be used on the player in the whitelist

Method Details

getAction

@NotNull
public @NotNull ClaimWhitelistChangeEvent.ChangeAction getAction()

Gets the kind of action that will be used on the player in the whitelist.

getWhitelistedPlayer

@NotNull
public @NotNull org.bukkit.OfflinePlayer getWhitelistedPlayer()

Gets the player that is about to be added or removed from the whitelist depending on the action.

A player must not be online to be added or removed from the whitelist.

getClaim

@NotNull
public @NotNull Claim getClaim()

Gets the claim where the whitelist is about to be changed.

getTimestamp

public long getTimestamp()

Gets when the change occurred.

isAddedAction

public boolean isAddedAction()

If the action of this event is ClaimWhitelistChangeEvent.ChangeAction.ADDED.

See Also:

• getAction()

isRemovedAction

public boolean isRemovedAction()

If the action of this event is ClaimWhitelistChangeEvent.ChangeAction.REMOVED.

See Also:

• getAction()

isCancelled

public boolean isCancelled()

Gets the cancellation state of this event.

If this event is cancelled, the whitelist will remain unchanged.

Specified by:

isCancelled in interface org.bukkit.event.Cancellable

Returns:

If this event is cancelled

setCancelled

public void setCancelled(boolean b)

Sets the cancellation state of this event.

If this event is cancelled, the whitelist will remain unchanged.

Specified by:

setCancelled in interface org.bukkit.event.Cancellable

Parameters:

b - If the event should be cancelled or not

getHandlers

@NotNull
public @NotNull org.bukkit.event.HandlerList getHandlers()

Description copied from class: CustomEvent

Returns the HandlerList for this event type.

Bukkit requires each concrete event class to define its own static HandlerList instance and to return it from this method. This is necessary for Bukkit’s event registration and dispatch system.

Specified by:

getHandlers in class CustomEvent

Returns:

the handler list for this event (never null)

getHandlerList

public static org.bukkit.event.HandlerList getHandlerList()

Gets the static list of handlers for this event type.

Required by the Bukkit event system for registration.

Returns:

the handler list