Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.event.block.BlockIgniteEvent Class Reference
Inheritance diagram for org.bukkit.event.block.BlockIgniteEvent:
org.bukkit.event.block.BlockEvent org.bukkit.event.Cancellable org.bukkit.event.Event

Classes

enum  IgniteCause
 

Public Member Functions

 BlockIgniteEvent (final Block theBlock, final IgniteCause cause, final Player thePlayer)
 
 BlockIgniteEvent (final Block theBlock, final IgniteCause cause, final Entity ignitingEntity)
 
 BlockIgniteEvent (final Block theBlock, final IgniteCause cause, final Block ignitingBlock)
 
 BlockIgniteEvent (final Block theBlock, final IgniteCause cause, final Entity ignitingEntity, final Block ignitingBlock)
 
boolean isCancelled ()
 
void setCancelled (boolean cancel)
 
IgniteCause getCause ()
 
Player getPlayer ()
 
Entity getIgnitingEntity ()
 
Block getIgnitingBlock ()
 
HandlerList getHandlers ()
 
- Public Member Functions inherited from org.bukkit.event.block.BlockEvent
 BlockEvent (final Block theBlock)
 
final Block getBlock ()
 
- Public Member Functions inherited from org.bukkit.event.Event
 Event ()
 
 Event (boolean isAsync)
 
String getEventName ()
 
abstract HandlerList getHandlers ()
 
final boolean isAsynchronous ()
 

Static Public Member Functions

static HandlerList getHandlerList ()
 

Additional Inherited Members

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

Detailed Description

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.

Definition at line 15 of file BlockIgniteEvent.java.

Constructor & Destructor Documentation

org.bukkit.event.block.BlockIgniteEvent.BlockIgniteEvent ( final Block  theBlock,
final IgniteCause  cause,
final Player  thePlayer 
)
Deprecated:
use IgniteCause, Entity) instead.

Definition at line 27 of file BlockIgniteEvent.java.

27  {
28  this(theBlock, cause, (Entity) thePlayer);
29  }

Member Function Documentation

IgniteCause org.bukkit.event.block.BlockIgniteEvent.getCause ( )

Gets the cause of block ignite.

Returns
An IgniteCause value detailing the cause of block ignition

Definition at line 60 of file BlockIgniteEvent.java.

60  {
61  return cause;
62  }
Block org.bukkit.event.block.BlockIgniteEvent.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.

Definition at line 91 of file BlockIgniteEvent.java.

91  {
92  return ignitingBlock;
93  }
Entity org.bukkit.event.block.BlockIgniteEvent.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.

Definition at line 82 of file BlockIgniteEvent.java.

82  {
83  return ignitingEntity;
84  }
Player org.bukkit.event.block.BlockIgniteEvent.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.

Definition at line 69 of file BlockIgniteEvent.java.

69  {
70  if (ignitingEntity instanceof Player) {
71  return (Player) ignitingEntity;
72  }
73 
74  return null;
75  }
boolean org.bukkit.event.block.BlockIgniteEvent.isCancelled ( )

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Returns
true if this event is cancelled

Implements org.bukkit.event.Cancellable.

Definition at line 47 of file BlockIgniteEvent.java.

47  {
48  return cancel;
49  }
void org.bukkit.event.block.BlockIgniteEvent.setCancelled ( boolean  cancel)

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Parameters
canceltrue if you wish to cancel this event

Implements org.bukkit.event.Cancellable.

Definition at line 51 of file BlockIgniteEvent.java.

51  {
52  this.cancel = cancel;
53  }

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