Package io.papermc.paper.event.block

Class VaultChangeStateEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.block.BlockEvent

io.papermc.paper.event.block.VaultChangeStateEvent

All Implemented Interfaces:

Cancellable

@NullMarked
public class VaultChangeStateEvent
extends BlockEvent
implements Cancellable

Called when a vault block changes state.

Nested Class Summary

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

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.block.BlockEvent

block

Constructor Summary

Constructors

Constructor	Description
VaultChangeStateEvent(Block vaultBlock, @Nullable Player player, Vault.State currentState, Vault.State newState)

Method Summary

Modifier and Type	Method	Description
Vault.State	getCurrentState()	Gets the state the vault is currently in.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
Vault.State	getNewState()	Gets the state the vault is attempting to transition to.
@Nullable Player	getPlayer()	Gets the player associated with this state change, if applicable.
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.block.BlockEvent

getBlock

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

VaultChangeStateEvent

@Internal
public VaultChangeStateEvent(Block vaultBlock,
 @Nullable Player player,
 Vault.State currentState,
 Vault.State newState)

Method Details

getPlayer

public @Nullable Player getPlayer()

Gets the player associated with this state change, if applicable.

Returns:

The associated player, or null if not known.

getCurrentState

public Vault.State getCurrentState()

Gets the state the vault is currently in.

Returns:

The current vault state.

getNewState

public Vault.State getNewState()

Gets the state the vault is attempting to transition to.

Returns:

The new vault state.

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