Package org.bukkit.event.block
Class BlockIgniteEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.block.BlockEvent
org.bukkit.event.block.BlockIgniteEvent
- All Implemented Interfaces:
Cancellable
Called when a block is ignited. If you want to catch when a Player places
fire, you need to use
BlockPlaceEvent
.
If a Block Ignite event is cancelled, the block will not be ignited.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
An enum to specify the cause of the igniteNested 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
ConstructorDescriptionBlockIgniteEvent
(@NotNull Block theBlock, @NotNull BlockIgniteEvent.IgniteCause cause, @NotNull Block ignitingBlock) BlockIgniteEvent
(@NotNull Block theBlock, @NotNull BlockIgniteEvent.IgniteCause cause, @Nullable Entity ignitingEntity) BlockIgniteEvent
(@NotNull Block theBlock, @NotNull BlockIgniteEvent.IgniteCause cause, @Nullable Entity ignitingEntity, @Nullable Block ignitingBlock) -
Method Summary
Modifier and TypeMethodDescriptiongetCause()
Gets the cause of block ignite.static @NotNull HandlerList
Gets the block which ignited this blockGets the entity who ignited this blockGets the player who ignited this blockboolean
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
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
BlockIgniteEvent
-
BlockIgniteEvent
-
BlockIgniteEvent
-
-
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
-
getCause
Gets the cause of block ignite.- Returns:
- An IgniteCause value detailing the cause of block ignition
-
getPlayer
Gets the player who ignited this block- Returns:
- The Player that placed/ignited the fire block, or null if not ignited by a Player.
-
getIgnitingEntity
Gets the entity who ignited this block- Returns:
- The Entity that placed/ignited the fire block, or null if not ignited by a Entity.
-
getIgnitingBlock
Gets the block which ignited this block- Returns:
- The Block that placed/ignited the fire block, or null if not ignited by a Block.
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-