Package org.bukkit.event.block

Class BlockExplodeEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.block.BlockEvent
org.bukkit.event.block.BlockExplodeEvent
All Implemented Interfaces:
Cancellable
public class BlockExplodeEvent extends BlockEvent implements Cancellable
Called when a block explodes.

Note that due to the nature of explosions, BlockEvent.getBlock() will always be an air block. getExplodedBlockState() should be used to get information about the block state that exploded.

  • Constructor Details

    • BlockExplodeEvent

      public BlockExplodeEvent(@NotNull Block what, @NotNull BlockState blockState, @NotNull List<Block> blocks, float yield)

    • BlockExplodeEvent

      @Deprecated(forRemoval=true) public BlockExplodeEvent(@NotNull Block what, @NotNull List<Block> blocks, float yield)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • 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

    • getExplodedBlockState

      @NotNull public BlockState getExplodedBlockState()
      Returns the captured BlockState of the block that exploded.
      Returns:
      the block state

    • blockList

      @NotNull public List<Block> blockList()
      Returns the list of blocks that would have been removed or were removed from the explosion event.
      Returns:
      All blown-up blocks

    • getYield

      public float getYield()
      Returns the percentage of blocks to drop from this explosion
      Returns:
      The yield.

    • setYield

      public void setYield(float yield)
      Sets the percentage of blocks to drop from this explosion
      Parameters:
      yield - The new yield percentage

    • getHandlers

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

    • getHandlerList

      @NotNull public static HandlerList getHandlerList()