Class BlockPistonEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.block.BlockEvent

org.bukkit.event.block.BlockPistonEvent

All Implemented Interfaces:

Cancellable

Direct Known Subclasses:

BlockPistonExtendEvent, BlockPistonRetractEvent

public abstract class BlockPistonEvent
extends BlockEvent
implements Cancellable

Called when a piston block is triggered

Nested Class Summary

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields inherited from class BlockEvent

block

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BlockPistonEvent(@NotNull Block block, @NotNull BlockFace direction)

Method Summary

Modifier and Type	Method	Description
@NotNull BlockFace	getDirection()	Return the direction in which the piston will operate.
boolean	isCancelled()	Gets the cancellation state of this event.
boolean	isSticky()	Returns true if the Piston in the event is sticky.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.

Methods inherited from class BlockEvent

getBlock

Methods inherited from class Event

callEvent, getEventName, getHandlers, isAsynchronous

Methods inherited from class Object

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

Constructor Details

BlockPistonEvent

protected BlockPistonEvent(@NotNull
 @NotNull Block block,
 @NotNull
 @NotNull BlockFace direction)

Method Details

isSticky

public boolean isSticky()

Returns true if the Piston in the event is sticky.

Returns:

stickiness of the piston

getDirection

@NotNull
public @NotNull BlockFace getDirection()

Return the direction in which the piston will operate.

Returns:

direction of the piston

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