Package org.bukkit.event.world

Class StructureGrowEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.world.WorldEvent
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.

  • Constructor Details

    • StructureGrowEvent

      public StructureGrowEvent(@NotNull Location location, @NotNull TreeType species, boolean bonemeal, @Nullable Player player, @NotNull List<BlockState> blocks)

  • Method Details

    • getLocation

      @NotNull public Location getLocation()
      Gets the location of the structure.
      Returns:
      Location of the structure

    • getSpecies

      @NotNull 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

      @Nullable public Player getPlayer()
      Gets the player that created the structure.
      Returns:
      Player that created the structure, null if was not created manually

    • getBlocks

      @NotNull public List<BlockState> getBlocks()
      Gets a list of all blocks associated with the structure.
      Returns:
      list 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

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

    • getHandlerList

      @NotNull public static HandlerList getHandlerList()