net.tridentsdk.event.block

Class BlockPistonEvent

java.lang.Object

net.tridentsdk.event.Event

net.tridentsdk.event.block.BlockEvent

net.tridentsdk.event.block.BlockPistonEvent

All Implemented Interfaces:

Cancellable

Direct Known Subclasses:

PistonExtendEvent, PistonRetractEvent

public abstract class BlockPistonEvent
extends BlockEvent
implements Cancellable

Called whenever a piston extends or retracts

This is an umbrella event, do not listen to it

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Constructor Summary

Constructors

Constructor and Description
BlockPistonEvent(Block block, BlockDirection direction, boolean retract, Block influenced)

Method Summary

Modifier and Type	Method and Description
void	cancel(boolean cancelled)
BlockDirection	direction() Returns the direction that the piston is facing, for example if the piston head face of a block is on the north end of a block, then the Direction that this event returns will be north, does not change depending on whether this piston is extending or retracting, so a block may actually be moving south if this is returns north
Block	influencedBlock() Gets the block that is being moved by this piston, if any
boolean	isExtending() Returns true if this piston is extending, convenience for !isRetracting()
boolean	isIgnored()
boolean	isRetracting() Returns true if this piston is retracting
boolean	isSticky()

Methods inherited from class net.tridentsdk.event.block.BlockEvent

block

Methods inherited from class java.lang.Object

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

Constructor Detail

BlockPistonEvent

public BlockPistonEvent(Block block,
                        BlockDirection direction,
                        boolean retract,
                        Block influenced)

Method Detail

direction

public BlockDirection direction()

Returns the direction that the piston is facing, for example if the piston head face of a block is on the north end of a block, then the Direction that this event returns will be north, does not change depending on whether this piston is extending or retracting, so a block may actually be moving south if this is returns north

Returns:

Orientation

isRetracting

public boolean isRetracting()

Returns true if this piston is retracting

Returns:

Boolean

isExtending

public boolean isExtending()

Returns true if this piston is extending, convenience for !isRetracting()

Returns:

Boolean

influencedBlock

public Block influencedBlock()

Gets the block that is being moved by this piston, if any

If this is a piston extend event, this will return the first block in the series of blocks being pushed.

Returns:

the block being moved, may be null if air, or retracting from a block without this piston being sticky

isSticky

public boolean isSticky()

isIgnored

public boolean isIgnored()

Specified by:

isIgnored in interface Cancellable

Returns:

return true if event is set to cancelled

cancel

public void cancel(boolean cancelled)

Specified by:

cancel in interface Cancellable

Parameters:

cancelled - set the cancellation state of the event