org.bukkit.event.world
Class StructureGrowEvent

java.lang.Object
  extended by org.bukkit.event.Event
      extended by org.bukkit.event.world.WorldEvent
          extended by org.bukkit.event.world.StructureGrowEvent
All Implemented Interfaces:
Cancellable

public class StructureGrowEvent
extends WorldEvent
implements Cancellable

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


Nested Class Summary
 
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
 
Constructor Summary
StructureGrowEvent(Location location, TreeType species, boolean bonemeal, Player player, List<BlockState> blocks)
           
 
Method Summary
 List<BlockState> getBlocks()
          Gets an ArrayList of all blocks associated with the structure.
static HandlerList getHandlerList()
           
 HandlerList getHandlers()
           
 Location getLocation()
          Gets the location of the structure.
 Player getPlayer()
          Gets the player that created the structure.
 TreeType getSpecies()
          Gets the species type (birch, normal, pine, red mushroom, brown mushroom)
 boolean isCancelled()
          Gets the cancellation state of this event.
 boolean isFromBonemeal()
          Checks if structure was grown using bonemeal.
 void setCancelled(boolean cancel)
          Sets the cancellation state of this event.
 
Methods inherited from class org.bukkit.event.world.WorldEvent
getWorld
 
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

StructureGrowEvent

public StructureGrowEvent(Location location,
                          TreeType species,
                          boolean bonemeal,
                          Player player,
                          List<BlockState> blocks)
Method Detail

getLocation

public Location getLocation()
Gets the location of the structure.

Returns:
Location of the structure

getSpecies

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

Returns:
Structure species

isFromBonemeal

public boolean isFromBonemeal()
Checks if structure was grown using bonemeal.

Returns:
True if the structure was grown using bonemeal.

getPlayer

public Player getPlayer()
Gets the player that created the structure.

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

getBlocks

public List<BlockState> getBlocks()
Gets an ArrayList of all blocks associated with the structure.

Returns:
ArrayList of all blocks associated with the structure.

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

getHandlers

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

getHandlerList

public static HandlerList getHandlerList()


Copyright © 2013. All Rights Reserved.