Package io.papermc.paper.event.entity

Class EntityCompostItemEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.block.BlockEvent

io.papermc.paper.event.block.CompostItemEvent

io.papermc.paper.event.entity.EntityCompostItemEvent

All Implemented Interfaces:

Cancellable

public class EntityCompostItemEvent
extends CompostItemEvent
implements Cancellable

Called when an item is about to be composted by an entity.

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
EntityCompostItemEvent(@NotNull Entity entity, @NotNull Block composter, @NotNull ItemStack item, boolean willRaiseLevel)

Method Summary

Modifier and Type	Method	Description
@NotNull Entity	getEntity()	Gets the entity that interacted with the composter.
boolean	isCancelled()	Gets the cancellation state of this event.
void	setCancelled(boolean cancel)	Sets the cancellation state of this event.

Methods inherited from class io.papermc.paper.event.block.CompostItemEvent

getHandlerList, getHandlers, getItem, setWillRaiseLevel, willRaiseLevel

Methods inherited from class org.bukkit.event.block.BlockEvent

getBlock

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

EntityCompostItemEvent

@Internal
public EntityCompostItemEvent(@NotNull
 @NotNull Entity entity,
 @NotNull
 @NotNull Block composter,
 @NotNull
 @NotNull ItemStack item,
 boolean willRaiseLevel)

Method Details

getEntity

@NotNull
public @NotNull Entity getEntity()

Gets the entity that interacted with the composter.

Returns:

the entity that composted an item.

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