org.bukkit.event.block
Class BlockIgniteEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.block.BlockEvent
          extended by org.bukkit.event.block.BlockIgniteEvent
All Implemented Interfaces:
Cancellable

public class BlockIgniteEvent
extends BlockEvent
implements Cancellable

Called when a block is ignited. If you want to catch when a Player places fire, you need to use BlockPlaceEvent.

If a Block Ignite event is cancelled, the block will not be ignited.


Nested Class Summary
static class BlockIgniteEvent.IgniteCause
          An enum to specify the cause of the ignite
 
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
BlockIgniteEvent(Block theBlock, BlockIgniteEvent.IgniteCause cause, Block ignitingBlock)
           
BlockIgniteEvent(Block theBlock, BlockIgniteEvent.IgniteCause cause, Entity ignitingEntity)
           
BlockIgniteEvent(Block theBlock, BlockIgniteEvent.IgniteCause cause, Entity ignitingEntity, Block ignitingBlock)
           
BlockIgniteEvent(Block theBlock, BlockIgniteEvent.IgniteCause cause, Player thePlayer)
          Deprecated. 
 
Method Summary
 BlockIgniteEvent.IgniteCause getCause()
          Gets the cause of block ignite.
static HandlerList getHandlerList()
           
 HandlerList getHandlers()
           
 Block getIgnitingBlock()
          Gets the block who ignited this block
 Entity getIgnitingEntity()
          Gets the entity who ignited this block
 Player getPlayer()
          Gets the player who ignited this block
 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 Detail

BlockIgniteEvent

@Deprecated
public BlockIgniteEvent(Block theBlock,
                                   BlockIgniteEvent.IgniteCause cause,
                                   Player thePlayer)
Deprecated. 

Deprecated. Use BlockIgniteEvent(Block, IgniteCause, Entity) instead.


BlockIgniteEvent

public BlockIgniteEvent(Block theBlock,
                        BlockIgniteEvent.IgniteCause cause,
                        Entity ignitingEntity)

BlockIgniteEvent

public BlockIgniteEvent(Block theBlock,
                        BlockIgniteEvent.IgniteCause cause,
                        Block ignitingBlock)

BlockIgniteEvent

public BlockIgniteEvent(Block theBlock,
                        BlockIgniteEvent.IgniteCause cause,
                        Entity ignitingEntity,
                        Block ignitingBlock)
Method Detail

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

getCause

public BlockIgniteEvent.IgniteCause getCause()
Gets the cause of block ignite.

Returns:
An IgniteCause value detailing the cause of block ignition

getPlayer

public Player getPlayer()
Gets the player who ignited this block

Returns:
The Player that placed/ignited the fire block, or null if not ignited by a Player.

getIgnitingEntity

public Entity getIgnitingEntity()
Gets the entity who ignited this block

Returns:
The Entity that placed/ignited the fire block, or null if not ignited by a Entity.

getIgnitingBlock

public Block getIgnitingBlock()
Gets the block who ignited this block

Returns:
The Block that placed/ignited the fire block, or null if not ignited by a Block.

getHandlers

public HandlerList getHandlers()
Specified by:
getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()


Copyright © 2013. All Rights Reserved.