Package org.bukkit.event.block

Class BlockBrushEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.block.BlockEvent

org.bukkit.event.block.BlockBrushEvent

All Implemented Interfaces:

Cancellable

@Experimental
public class BlockBrushEvent
extends BlockEvent
implements Cancellable

Called when a block is brushed by a player.

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
BlockBrushEvent(Block theBlock, BlockState newState, Player player)

Method Summary

Modifier and Type	Method	Description
static HandlerList	getHandlerList()
HandlerList	getHandlers()
BlockState	getNewState()	Gets the state of the block that this block will turn into.
Player	getPlayer()	Gets the Player that is brushing the block involved in this event.
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

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

BlockBrushEvent

public BlockBrushEvent(@NotNull
 Block theBlock,
 @NotNull
 BlockState newState,
 @NotNull
 Player player)

Method Details

getPlayer

@NotNull
public Player getPlayer()

Gets the Player that is brushing the block involved in this event.

Returns:

The Player that is brushing the block involved in this event

getNewState

@NotNull
public BlockState getNewState()

Gets the state of the block that this block will turn into.

Returns:

The block state that the block will become

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

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static HandlerList getHandlerList()