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
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.
The event isn't called if the GameRule.MOB_GRIEFING
is disabled as no block interaction will occur.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.block.BlockEvent
block
-
Constructor Summary
ConstructorDescriptionBlockExplodeEvent
(@NotNull Block what, @NotNull BlockState blockState, @NotNull List<Block> blocks, float yield, @NotNull ExplosionResult result) -
Method Summary
Modifier and TypeMethodDescriptionReturns the list of blocks that would have been removed or were removed from the explosion event.Returns the captured BlockState of the block that exploded.Returns the result of the explosion if it is not cancelled.static @NotNull HandlerList
float
getYield()
Returns the percentage of blocks to drop from this explosionboolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setYield
(float yield) Sets the percentage of blocks to drop from this explosionMethods inherited from class org.bukkit.event.block.BlockEvent
getBlock
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
BlockExplodeEvent
-
-
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 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
-
getExplosionResult
Returns the result of the explosion if it is not cancelled.- Returns:
- the result of the explosion
-
getExplodedBlockState
Returns the captured BlockState of the block that exploded.- Returns:
- the block state
-
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
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-