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
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
ConstructorDescriptionStructureGrowEvent
(@NotNull Location location, @NotNull TreeType species, boolean bonemeal, @Nullable Player player, @NotNull List<BlockState> blocks) -
Method Summary
Modifier and TypeMethodDescriptionGets a list of all blocks associated with the structure.static @NotNull HandlerList
Gets the location of the structure.Gets the player that created the structure.Gets the species type (birch, normal, pine, red mushroom, brown mushroom)boolean
Gets the cancellation state of this event.boolean
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
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
StructureGrowEvent
-
-
Method Details
-
getLocation
Gets the location of the structure.- Returns:
- Location of the structure
-
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
Gets the player that created the structure.- Returns:
- Player that created the structure, null if was not created manually
-
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 interfaceCancellable
- 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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-