org.bukkit.event.block.BlockSpreadEvent Class Reference

Called when a block spreads based on world conditions. More...

Inheritance diagram for org.bukkit.event.block.BlockSpreadEvent:

Collaboration diagram for org.bukkit.event.block.BlockSpreadEvent:

Public Member Functions
	BlockSpreadEvent (final Block block, final Block source, final BlockState newState)
Block	getSource ()
	Gets the source block involved in this event.
HandlerList	getHandlers ()
Public Member Functions inherited from org.bukkit.event.block.BlockFormEvent
	BlockFormEvent (final Block block, final BlockState newState)
Public Member Functions inherited from org.bukkit.event.block.BlockGrowEvent
	BlockGrowEvent (final Block block, final BlockState newState)
BlockState	getNewState ()
	Gets the state of the block where it will form or spread to.
boolean	isCancelled ()
void	setCancelled (boolean cancel)
Public Member Functions inherited from org.bukkit.event.block.BlockEvent
	BlockEvent (final Block theBlock)
final Block	getBlock ()
	Gets the block involved in this event.
Public Member Functions inherited from org.bukkit.event.Event
	Event ()
	The default constructor is defined for cleaner code.
	Event (boolean isAsync)
	This constructor is used to explicitly declare an event as synchronous or asynchronous.
String	getEventName ()
final boolean	isAsynchronous ()
	Any custom event that should not by synchronized with other events must use the specific constructor.
Public Member Functions inherited from org.bukkit.event.Cancellable
boolean	isCancelled ()
	Gets the cancellation state of this event.
void	setCancelled (boolean cancel)
	Sets the cancellation state of this event.

Static Public Member Functions
static HandlerList	getHandlerList ()
Static Public Member Functions inherited from org.bukkit.event.block.BlockFormEvent
static HandlerList	getHandlerList ()
Static Public Member Functions inherited from org.bukkit.event.block.BlockGrowEvent
static HandlerList	getHandlerList ()

Additional Inherited Members
Protected Attributes inherited from org.bukkit.event.block.BlockEvent
Block	block

Detailed Description

Called when a block spreads based on world conditions.

Use BlockFormEvent to catch blocks that "randomly" form instead of actually spread.

Examples:

• Mushrooms spreading.
• Fire spreading.

If a Block Spread event is cancelled, the block will not spread.

See Also

BlockFormEvent

Definition at line 21 of file BlockSpreadEvent.java.

Constructor & Destructor Documentation

org.bukkit.event.block.BlockSpreadEvent.BlockSpreadEvent	(	final Block	block,
		final Block	source,
		final BlockState	newState
	)

Definition at line 25 of file BlockSpreadEvent.java.

Member Function Documentation

static HandlerList org.bukkit.event.block.BlockSpreadEvent.getHandlerList ( )

static

Definition at line 44 of file BlockSpreadEvent.java.

HandlerList org.bukkit.event.block.BlockSpreadEvent.getHandlers ( )

virtual

Reimplemented from org.bukkit.event.block.BlockFormEvent.

Definition at line 40 of file BlockSpreadEvent.java.

Block org.bukkit.event.block.BlockSpreadEvent.getSource

(

)

Gets the source block involved in this event.

Returns

the Block for the source block involved in this event.

Definition at line 35 of file BlockSpreadEvent.java.

---

The documentation for this class was generated from the following file:

• org/bukkit/event/block/BlockSpreadEvent.java