Package org.bukkit.event.block

Class SpongeAbsorbEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.block.BlockEvent
org.bukkit.event.block.SpongeAbsorbEvent
All Implemented Interfaces:
Cancellable
public class SpongeAbsorbEvent extends BlockEvent implements Cancellable
Called when a sponge absorbs water from the world.
The world will be in its previous state, and getBlocks() will represent the changes to be made to the world, if the event is not cancelled.
As this is a physics based event it may be called multiple times for "the same" changes.

  • Constructor Details

    • SpongeAbsorbEvent

      public SpongeAbsorbEvent(@NotNull Block block, @NotNull List<BlockState> waterblocks)

  • Method Details

    • getBlocks

      @NotNull public List<BlockState> getBlocks()
      Get a list of all blocks to be removed by the sponge.
      This list is mutable and contains the blocks in their removed state, i.e. having a type of Material.AIR.
      Returns:
      list of the to be removed blocks.

    • 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()