Package net.neoforged.neoforge.event

Class ItemStackedOnOtherEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.ItemStackedOnOtherEvent

All Implemented Interfaces:

net.neoforged.bus.api.ICancellableEvent

public class ItemStackedOnOtherEvent
extends net.neoforged.bus.api.Event
implements net.neoforged.bus.api.ICancellableEvent

This event provides the functionality of the pair of functions used for the Bundle, in one event:

• Item.overrideOtherStackedOnMe(ItemStack, ItemStack, Slot, ClickAction, Player, SlotAccess)
• Item.overrideStackedOnOther(ItemStack, Slot, ClickAction, Player)

This event is fired before either of the above are called, when a carried item is clicked on top of another in a GUI slot. This event (and items stacking on others in general) is fired on both sides, but only on the client in the creative menu. Practically, that means that listeners of this event should require the player to be in survival mode if using capabilities that are not synced.

This event is cancellable, and does not

invalid reference

have a result

. If the event is cancelled, the container's logic halts, the carried item and the slot will not be swapped, and handling is assumed to have been done by the mod. This also means that the two vanilla checks described above will not be called.

Field Summary

Fields

Modifier and Type	Field	Description
private final ClickAction	action
private final ItemStack	carriedItem
private final SlotAccess	carriedSlotAccess
private final Player	player
private final Slot	slot
private final ItemStack	stackedOnItem

Constructor Summary

Constructors

Constructor	Description
ItemStackedOnOtherEvent(ItemStack carriedItem, ItemStack stackedOnItem, Slot slot, ClickAction action, Player player, SlotAccess carriedSlotAccess)

Method Summary

Modifier and Type	Method	Description
ItemStack	getCarriedItem()	Returns the stack being carried by the mouse.
SlotAccess	getCarriedSlotAccess()	Returns a fake slot allowing the listener to see and change what item is being carried.
ClickAction	getClickAction()	Returns the click action being used.
Player	getPlayer()	Returns the player doing the item swap attempt.
Slot	getSlot()	Returns the slot being clicked on.
ItemStack	getStackedOnItem()	Returns the stack currently in the slot being clicked on.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

isCanceled, setCanceled

Field Details

carriedItem

private final ItemStack carriedItem

stackedOnItem

private final ItemStack stackedOnItem

slot

private final Slot slot

action

private final ClickAction action

player

private final Player player

carriedSlotAccess

private final SlotAccess carriedSlotAccess

Constructor Details

ItemStackedOnOtherEvent

@Internal
public ItemStackedOnOtherEvent(ItemStack carriedItem,
 ItemStack stackedOnItem,
 Slot slot,
 ClickAction action,
 Player player,
 SlotAccess carriedSlotAccess)

Method Details

getCarriedItem

public ItemStack getCarriedItem()

Returns the stack being carried by the mouse. This may be empty!

Returns:

the stack being carried by the mouse

getStackedOnItem

public ItemStack getStackedOnItem()

Returns the stack currently in the slot being clicked on. This may be empty!

Returns:

the stack currently in the slot being clicked on

getSlot

public Slot getSlot()

Returns the slot being clicked on.

Returns:

the slot being clicked on

getClickAction

public ClickAction getClickAction()

Returns the click action being used. By default ClickAction.PRIMARY corresponds to left-click, and ClickAction.SECONDARY is right-click.

Returns:

the click action being used

getPlayer

public Player getPlayer()

Returns the player doing the item swap attempt.

Returns:

the player doing the item swap attempt

getCarriedSlotAccess

public SlotAccess getCarriedSlotAccess()

Returns a fake slot allowing the listener to see and change what item is being carried.

Returns:

a fake slot allowing the listener to see and change what item is being carried