Package org.bukkit.event.block
Class BlockFadeEvent
- java.lang.Object
-
- org.bukkit.event.Event
-
- org.bukkit.event.block.BlockEvent
-
- org.bukkit.event.block.BlockFadeEvent
-
- All Implemented Interfaces:
Cancellable
public class BlockFadeEvent extends BlockEvent implements Cancellable
Called when a block fades, melts or disappears based on world conditionsExamples:
- Snow melting due to being near a light source.
- Ice melting due to being near a light source.
- Fire burning out after time, without destroying fuel block.
- Coral fading to dead coral due to lack of water
- Turtle Egg bursting when a turtle hatches
If a Block Fade event is cancelled, the block will not fade, melt or disappear.
-
-
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
Constructors Constructor Description BlockFadeEvent(Block block, BlockState newState)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HandlerList
getHandlerList()
HandlerList
getHandlers()
BlockState
getNewState()
Gets the state of the block that will be fading, melting or disappearing.boolean
isCancelled()
Gets the cancellation state of this event.void
setCancelled(boolean cancel)
Sets the cancellation state of this event.-
Methods inherited from class org.bukkit.event.block.BlockEvent
getBlock
-
Methods inherited from class org.bukkit.event.Event
getEventName, isAsynchronous
-
-
-
-
Constructor Detail
-
BlockFadeEvent
public BlockFadeEvent(@NotNull Block block, @NotNull BlockState newState)
-
-
Method Detail
-
getNewState
@NotNull public BlockState getNewState()
Gets the state of the block that will be fading, melting or disappearing.- Returns:
- The block state of the block that will be fading, melting or disappearing
-
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
@NotNull public HandlerList getHandlers()
- Specified by:
getHandlers
in classEvent
-
getHandlerList
@NotNull public static HandlerList getHandlerList()
-
-