Class ItemTransportingEntitySortEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

io.papermc.paper.event.entity.ItemTransportingEntitySortEvent

@NullMarked
public class ItemTransportingEntitySortEvent
extends EntityEvent

Called when an item-transporting entity (ex a CopperGolem) is inspecting a destination Container to decide if the item it is holding belongs in said container.
This gives plugin developers an opportunity to override the CopperGolem's sorting behavior.
Note: This event can be called twice during a single "interaction", once before the container is opened, and again before items are added and the container is closed.

Nested Class Summary

Nested classes/interfaces inherited from class Event

Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
protected static final HandlerList	HANDLER_LIST

Fields inherited from class EntityEvent

entity

Constructor Summary

Constructors

Constructor	Description
ItemTransportingEntitySortEvent(Entity entity, ItemStack itemStack, Inventory containerInventory)

Method Summary

Modifier and Type	Method	Description
Inventory	getContainerInventory()	Gets the inventory of the container the entity is comparing against the held item.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
ItemStack	getItemStack()	Clone of the ItemStack held by the entity that is being compared against the container.
Event.Result	getResult()	Gets the current sorting decision.
void	setResult(Event.Result result)	Sets the sorting decision for the held item and the inspected container.

Methods inherited from class EntityEvent

getEntity, getEntityType

Methods inherited from class Event

callEvent, getEventName, isAsynchronous

Methods inherited from class Object

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

Field Details

HANDLER_LIST

protected static final HandlerList HANDLER_LIST

Constructor Details

ItemTransportingEntitySortEvent

@Internal
public ItemTransportingEntitySortEvent(Entity entity,
 ItemStack itemStack,
 Inventory containerInventory)

Method Details

setResult

public void setResult(Event.Result result)

Sets the sorting decision for the held item and the inspected container.

• Event.Result.ALLOW: the item belongs in the container.
• Event.Result.DENY: the item does not belong in the container.
• Event.Result.DEFAULT: use the vanilla sorting logic.

Parameters:

result - the sorting decision

See Also:

• Event.Result

getResult

public Event.Result getResult()

Gets the current sorting decision. Starts as Event.Result.DEFAULT and may have been modified by other plugins.

Returns:

the current sorting decision

See Also:

• setResult(Result)

getContainerInventory

public Inventory getContainerInventory()

Gets the inventory of the container the entity is comparing against the held item.

Returns:

the inventory of the potential destination container

getItemStack

public ItemStack getItemStack()

Clone of the ItemStack held by the entity that is being compared against the container.

Returns:

The held ItemStack

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()