Bukkit-API  1.7.9-R0.2
The inofficial Bukkit-API
org.bukkit.event.world.StructureGrowEvent Class Reference
Inheritance diagram for org.bukkit.event.world.StructureGrowEvent:
org.bukkit.event.world.WorldEvent org.bukkit.event.Cancellable org.bukkit.event.Event

Public Member Functions

 StructureGrowEvent (final Location location, final TreeType species, final boolean bonemeal, final Player player, final List< BlockState > blocks)
 
Location getLocation ()
 
TreeType getSpecies ()
 
boolean isFromBonemeal ()
 
Player getPlayer ()
 
List< BlockStategetBlocks ()
 
boolean isCancelled ()
 
void setCancelled (boolean cancel)
 
HandlerList getHandlers ()
 
- Public Member Functions inherited from org.bukkit.event.world.WorldEvent
 WorldEvent (final World world)
 
World getWorld ()
 
- 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 ()
 

Detailed Description

Event that is called when an organic structure attempts to grow (Sapling -> Tree), (Mushroom -> Huge Mushroom), naturally or using bonemeal.

Definition at line 15 of file StructureGrowEvent.java.

Member Function Documentation

List<BlockState> org.bukkit.event.world.StructureGrowEvent.getBlocks ( )

Gets an ArrayList of all blocks associated with the structure.

Returns
ArrayList of all blocks associated with the structure.

Definition at line 76 of file StructureGrowEvent.java.

76  {
77  return blocks;
78  }
Location org.bukkit.event.world.StructureGrowEvent.getLocation ( )

Gets the location of the structure.

Returns
Location of the structure

Definition at line 38 of file StructureGrowEvent.java.

38  {
39  return location;
40  }
Player org.bukkit.event.world.StructureGrowEvent.getPlayer ( )

Gets the player that created the structure.

Returns
Player that created the structure, null if was not created manually

Definition at line 67 of file StructureGrowEvent.java.

67  {
68  return player;
69  }
TreeType org.bukkit.event.world.StructureGrowEvent.getSpecies ( )

Gets the species type (birch, normal, pine, red mushroom, brown mushroom)

Returns
Structure species

Definition at line 48 of file StructureGrowEvent.java.

48  {
49  return species;
50  }
boolean org.bukkit.event.world.StructureGrowEvent.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 80 of file StructureGrowEvent.java.

80  {
81  return cancelled;
82  }
boolean org.bukkit.event.world.StructureGrowEvent.isFromBonemeal ( )

Checks if structure was grown using bonemeal.

Returns
True if the structure was grown using bonemeal.

Definition at line 57 of file StructureGrowEvent.java.

57  {
58  return bonemeal;
59  }
void org.bukkit.event.world.StructureGrowEvent.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 84 of file StructureGrowEvent.java.

84  {
85  cancelled = cancel;
86  }

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