Bukkit  1.4.7-R1.0
 All Classes Namespaces Files Functions Variables Enumerator Pages
org.bukkit.event.block.BlockFormEvent Class Reference

Called when a block is formed or spreads based on world conditions. More...

+ Inheritance diagram for org.bukkit.event.block.BlockFormEvent:
+ Collaboration diagram for org.bukkit.event.block.BlockFormEvent:

Public Member Functions

 BlockFormEvent (final Block block, final BlockState newState)
 
HandlerList getHandlers ()
 
- 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)
 
HandlerList getHandlers ()
 
- 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.BlockGrowEvent
static HandlerList getHandlerList ()
 

Additional Inherited Members

- Protected Attributes inherited from org.bukkit.event.block.BlockEvent
Block block
 

Detailed Description

Called when a block is formed or spreads based on world conditions.

Use BlockSpreadEvent to catch blocks that actually spread and don't just "randomly" form.

Examples:

  • Snow forming due to a snow storm.
  • Ice forming in a snowy Biome like Taiga or Tundra.

If a Block Form event is cancelled, the block will not be formed.

See Also
BlockSpreadEvent

Definition at line 22 of file BlockFormEvent.java.

Constructor & Destructor Documentation

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

Definition at line 25 of file BlockFormEvent.java.

Member Function Documentation

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

Definition at line 34 of file BlockFormEvent.java.

HandlerList org.bukkit.event.block.BlockFormEvent.getHandlers ( )
virtual

Implements org.bukkit.event.Event.

Reimplemented in org.bukkit.event.block.BlockSpreadEvent.

Definition at line 30 of file BlockFormEvent.java.


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