InventoryFunctions

src/inventoryFunctions.ts

Inventory and equipment helpers for Mineflayer bots. The class wraps item lookup, hand access, and a couple of equip flows that try to keep the bot from getting stuck.

State

Property	Type	Purpose
`usingMainHand`	`boolean`	Tracks whether the main hand is being used.
`usingOffHand`	`boolean`	Tracks whether the off hand is being used.
`equippingMainHand`	`boolean`	Internal flag for main-hand equip flow.
`equippingOffHand`	`boolean`	Internal flag for off-hand equip flow.
`equippingOtherSlot`	`boolean`	Internal flag for non-hand equip flow.

Getters

Getter	Returns	Description
`equipmentSlots`	`EquipmentDestination[]`	Returns the list of supported equipment destinations for the current bot version.

Methods

Method	Returns	Description
`getAllItems()`	`Item[]`	Returns inventory items plus equipped items.
`getAllItemsExceptCurrent(current)`	`Item[]`	Returns inventory and equipment items except the specified slot.
`getHandWithItem(offhand?)`	`Item \| null`	Returns the item currently in the requested hand.
`getHand(offhand = false)`	`"hand" \| "off-hand"`	Returns the correct equipment destination for a hand flag.
`findItemByID(itemId, metadata?)`	`Item \| null`	Finds the first matching item by numeric ID and optional metadata.
`findItem(name, metadata?)`	`Item \| null`	Finds the first matching item by name and optional metadata.
`has(name, metadata?)`	`boolean`	Alias for a boolean item existence check.
`equipItemRaw(item, dest)`	`Promise<boolean>`	Equips an item unless it is already in the destination slot.
`customEquip(item, destination, retries = 1)`	`Promise<boolean>`	Retries equip and attempts to clear the cursor if the equip flow gets stuck.

Notes

findItemByID and findItem only check metadata when the metadata argument is truthy.
equipmentSlots omits off-hand on versions that do not support it.