EffectiveInventoryUtils

Inventory helpers. Item matching uses EffectiveItem.equalByNamespacedKeyIfExistElseByMaterial, so custom items match by their key and vanilla items by material.

Types

Outcome of giveItem: fully added, or overflow dropped on the ground.

Outcome of removeItems: all removed, or not enough were present (nothing removed).

fun getHandThatHoldItem(player: Player, item: ItemStack): EquipmentSlot?

Which hand holds item (EquipmentSlot.HAND/EquipmentSlot.OFF_HAND), or null if neither.

fun getItemFromAnotherHandByItemInHand(player: Player, item: ItemStack): ItemStack?

Given that one hand holds item, returns the item in the other hand, or null if neither matches.

fun getItemFromEquipmentSlot(player: Player, slot: EquipmentSlot): ItemStack?

The item in player's given equipment slot (hands or armor), or null for unsupported slots.

fun getUsedItemFromHands(player: Player): ItemStack

The main-hand item if not empty, otherwise the off-hand item.

Gives item to player, dropping any overflow at their feet. Reports whether anything dropped.

fun hasItems(inventory: Inventory, item: ItemStack, count: Int): Boolean

Whether inventory holds at least count of item (summed across matching stacks).

fun isFullInventory(inventory: Inventory): Boolean

Whether the inventory's storage slots are all occupied (ignores armor/offhand for player inventories).

fun removeItems(inventory: Inventory, item: ItemStack, count: Int): EffectiveInventoryUtils.RemoveResult

Removes count of item from inventory; if fewer are present, removes nothing and returns RemoveResult.NOT_ENOUGH.

fun tryGiveItem(item: ItemStack, player: Player): HashMap<Int, ItemStack>

Adds item to player's inventory; returns the leftover that did not fit (empty if all fit).