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

Public Member Functions

 FurnaceBurnEvent (final Block furnace, final ItemStack fuel, final int burnTime)
 
Block getFurnace ()
 
ItemStack getFuel ()
 
int getBurnTime ()
 
void setBurnTime (int burnTime)
 
boolean isBurning ()
 
void setBurning (boolean burning)
 
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 ()
 
- 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 an ItemStack is successfully burned as fuel in a furnace.

Definition at line 12 of file FurnaceBurnEvent.java.

Member Function Documentation

int org.bukkit.event.inventory.FurnaceBurnEvent.getBurnTime ( )

Gets the burn time for this fuel

Returns
the burn time for this fuel

Definition at line 52 of file FurnaceBurnEvent.java.

52  {
53  return burnTime;
54  }
ItemStack org.bukkit.event.inventory.FurnaceBurnEvent.getFuel ( )

Gets the fuel ItemStack for this event

Returns
the fuel ItemStack

Definition at line 43 of file FurnaceBurnEvent.java.

43  {
44  return fuel;
45  }
Block org.bukkit.event.inventory.FurnaceBurnEvent.getFurnace ( )

Gets the block for the furnace involved in this event

Returns
the block of the furnace
Deprecated:
In favour of getBlock().

Definition at line 34 of file FurnaceBurnEvent.java.

References org.bukkit.event.block.BlockEvent.getBlock().

34  {
35  return getBlock();
36  }
boolean org.bukkit.event.inventory.FurnaceBurnEvent.isBurning ( )

Gets whether the furnace's fuel is burning or not.

Returns
whether the furnace's fuel is burning or not.

Definition at line 70 of file FurnaceBurnEvent.java.

70  {
71  return this.burning;
72  }
boolean org.bukkit.event.inventory.FurnaceBurnEvent.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 83 of file FurnaceBurnEvent.java.

83  {
84  return cancelled;
85  }
void org.bukkit.event.inventory.FurnaceBurnEvent.setBurning ( boolean  burning)

Sets whether the furnace's fuel is burning or not.

Parameters
burningtrue if the furnace's fuel is burning

Definition at line 79 of file FurnaceBurnEvent.java.

79  {
80  this.burning = burning;
81  }
void org.bukkit.event.inventory.FurnaceBurnEvent.setBurnTime ( int  burnTime)

Sets the burn time for this fuel

Parameters
burnTimethe burn time for this fuel

Definition at line 61 of file FurnaceBurnEvent.java.

61  {
62  this.burnTime = burnTime;
63  }
void org.bukkit.event.inventory.FurnaceBurnEvent.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 87 of file FurnaceBurnEvent.java.

87  {
88  this.cancelled = cancel;
89  }

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