Package io.papermc.paper.event.entity

Class EntityInsideBlockEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

io.papermc.paper.event.entity.EntityInsideBlockEvent

All Implemented Interfaces:

Cancellable

public class EntityInsideBlockEvent
extends EntityEvent
implements Cancellable

Called when an entity enters the hitbox of a block. Only called for blocks that react when an entity is inside. If cancelled, any action that would have resulted from that entity being in the block will not happen (such as extinguishing an entity in a cauldron).

Blocks this is currently called for:

• Big dripleaf
• Bubble column
• Buttons
• Cactus
• Campfire
• Cauldron
• Crops
• Ender Portal
• Fires
• Frogspawn
• Honey
• Hopper
• Detector rails
• Nether portals
• Pitcher crop
• Powdered snow
• Pressure plates
• Sweet berry bush
• Tripwire
• Waterlily
• Web
• Wither rose

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.entity.EntityEvent

entity

Constructor Summary

Constructors

Constructor	Description
EntityInsideBlockEvent(@NotNull Entity entity, @NotNull Block block)

Method Summary

Modifier and Type	Method	Description
@NotNull Block	getBlock()	Gets the block.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
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.entity.EntityEvent

getEntity, getEntityType

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EntityInsideBlockEvent

@Internal
public EntityInsideBlockEvent(@NotNull
 @NotNull Entity entity,
 @NotNull
 @NotNull Block block)

Method Details

getBlock

@NotNull
public @NotNull Block getBlock()

Gets the block.

Returns:

the block

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 @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()