Class InventoryUtil`Abstract`

Constructors

constructor

new InventoryUtil(): InventoryUtil
Returns InventoryUtil

Methods

`Static`getInventory

getInventory(entity: Entity): EntityInventoryComponent | undefined
Gets the inventory component from an entity if it exists.
Parameters
- entity: Entity
  The entity to query.
Returns EntityInventoryComponent | undefined
The entity's inventory component, or undefined if it doesn't have one.
Example
```
const inventory = InventoryUtil.getInventory(player);
if (inventory) console.log(inventory.container.size);
```
- Defined in src/utils/inventory_util.ts:32

`Static`getEquipment

getEquipment(entity: Entity): EntityEquippableComponent | undefined
Gets the equipment component from an entity if it exists.
Parameters
- entity: Entity
  The entity to query.
Returns EntityEquippableComponent | undefined
The entity's equippable component, or undefined.
Example
```
const equipment = InventoryUtil.getEquipment(player);
if (equipment) {
  const helmet = equipment.getEquipmentSlot(EquipmentSlot.Head).getItem();
}
```
- Defined in src/utils/inventory_util.ts:50

`Static`getContainer

getContainer(entity: Entity | Container): Container | undefined
Gets a container from an entity or container instance.
Parameters
- entity: Entity | Container
  An entity or a container reference.
Returns Container | undefined
The container instance, or undefined if none exists.
Example
```
const container = InventoryUtil.getContainer(player);
if (container) console.log(container.size);
```
- Defined in src/utils/inventory_util.ts:66

`Static`getSelectedSlot

getSelectedSlot(player: Player): ContainerSlot | undefined
Gets the currently selected hotbar slot of a player.
Parameters
- player: Player
  The player to query.
Returns ContainerSlot | undefined
The selected slot or undefined.
Example
```
const slot = InventoryUtil.getSelectedSlot(player);
console.log(slot?.getItem()?.typeId);
```
- Defined in src/utils/inventory_util.ts:82

`Static`getSelectedItem

getSelectedItem(player: Player): ItemStack | undefined
Gets the currently selected item in a player's hand.
Parameters
- player: Player
  The player to query.
Returns ItemStack | undefined
The selected ItemStack or undefined.
Example
```
const item = InventoryUtil.getSelectedItem(player);
if (item) console.log(`Player is holding ${item.typeId}`);
```
- Defined in src/utils/inventory_util.ts:98

`Static`setSelectedItem

setSelectedItem(player: Player, newItem?: ItemStack): void
Sets the currently selected item in a player's hand. Respects creative mode - does nothing in creative.
Parameters
- player: Player
  The player to modify.
- OptionalnewItem: ItemStack
  The new ItemStack to set (or undefined to clear).
Returns void
Example
```
InventoryUtil.setSelectedItem(player, new ItemStack("minecraft:diamond_sword"));
InventoryUtil.setSelectedItem(player, undefined); // Clear slot
```
- Defined in src/utils/inventory_util.ts:115

`Static`getMainhandSlot

getMainhandSlot(entity: Entity): ContainerSlot | undefined
Gets the mainhand equipment slot.
Parameters
- entity: Entity
  The entity to query.
Returns ContainerSlot | undefined
The mainhand ContainerSlot or undefined.
Example
```
const handSlot = InventoryUtil.getMainhandSlot(player);
if (handSlot) handSlot.setItem(newItem);
```
- Defined in src/utils/inventory_util.ts:136

`Static`getMainhandItem

getMainhandItem(entity: Entity): ItemStack | undefined
Gets the currently equipped mainhand item.
Parameters
- entity: Entity
  The entity to query.
Returns ItemStack | undefined
The mainhand ItemStack or undefined.
Example
```
const mainhand = InventoryUtil.getMainhandItem(player);
if (mainhand) console.log(mainhand.typeId);
```
- Defined in src/utils/inventory_util.ts:152

`Static`setMainhandItem

setMainhandItem(entity: Entity, item?: ItemStack): void
Sets the mainhand equipment item.
Parameters
- entity: Entity
  The entity to modify.
- Optionalitem: ItemStack
  The ItemStack to set (or undefined to clear).
Returns void
Example
```
InventoryUtil.setMainhandItem(player, new ItemStack("minecraft:diamond_sword"));
InventoryUtil.setMainhandItem(player, undefined); // Clear mainhand
```
- Defined in src/utils/inventory_util.ts:168

`Static`getOffhandItem

getOffhandItem(entity: Entity): ItemStack | undefined
Gets the currently equipped offhand item.
Parameters
- entity: Entity
Returns ItemStack | undefined
The offhand ItemStack or undefined.
Example
```
const offhand = InventoryUtil.getOffhandItem(player);
if (offhand) console.log(offhand.typeId);
```
- Defined in src/utils/inventory_util.ts:203

`Static`getContainerItems

getContainerItems(entity: Entity | Container): ItemStack[]
Gets all items from a container or entity's inventory.
Parameters
- entity: Entity | Container
  Entity or container to check.
Returns ItemStack[]
An array of ItemStacks or undefined for empty slots.
Example
```
const items = InventoryUtil.getContainerItems(player);
console.log(items.length);
```
- Defined in src/utils/inventory_util.ts:222
getContainerItems(entity: Entity | Container, ordered: false): ItemStack[]
Gets all items from a container or entity's inventory.
Parameters
- entity: Entity | Container
  Entity or container to check.
- ordered: false
  If true, includes empty slots as undefined to preserve order.
Returns ItemStack[]
An array of ItemStacks or undefined for empty slots.
Example
```
const items = InventoryUtil.getContainerItems(player);
console.log(items.length);
```
- Defined in src/utils/inventory_util.ts:223
getContainerItems(
entity: Entity | Container,
ordered: true,
): (ItemStack | undefined)[]
Gets all items from a container or entity's inventory.
Parameters
- entity: Entity | Container
  Entity or container to check.
- ordered: true
  If true, includes empty slots as undefined to preserve order.
Returns (ItemStack | undefined)[]
An array of ItemStacks or undefined for empty slots.
Example
```
const items = InventoryUtil.getContainerItems(player);
console.log(items.length);
```
- Defined in src/utils/inventory_util.ts:224

`Static`getItemTotal

getItemTotal(entity: Entity | Container, typeId: string): number
Counts the total number of a specific item in a container or entity's inventory.
Parameters
- entity: Entity | Container
  Entity or container to check.
- typeId: string
  Item typeId (e.g. minecraft:apple).
Returns number
Total item count.
Example
```
const apples = InventoryUtil.getItemTotal(player, "minecraft:apple");
console.log(`Player has ${apples} apples`);
```
- Defined in src/utils/inventory_util.ts:254

`Static`consumeSelectedItem

consumeSelectedItem(
    player: Player,
    returnItem?: ItemStack,
    amount?: number,
): void
Consumes (removes one) of the player's selected item. Optionally spawns a return item at their location.
Parameters
- player: Player
  The player.
- OptionalreturnItem: ItemStack
  Optional item to drop as replacement.
- Optionalamount: number
  the amount to consume from their selected item, defaults to 1
Returns void
Example
```
InventoryUtil.consumeSelectedItem(player, new ItemStack("minecraft:bucket"));
```
- Defined in src/utils/inventory_util.ts:284

`Static`reduceItemStack

reduceItemStack(item: ItemStack, amount?: number): ItemStack | undefined
Reduces an ItemStack's amount by a given amount.
Parameters
- item: ItemStack
  The ItemStack to reduce.
- amount: number = 1
  Amount to reduce by (default 1).
Returns ItemStack | undefined
The updated stack, or undefined if amount drops to 0.
Example
```
const newStack = InventoryUtil.reduceItemStack(item, 2);
```
- Defined in src/utils/inventory_util.ts:306

`Static`removeSingleItem

removeSingleItem(entity: Entity | Container, itemId: string): boolean
Removes a single item by ID from a container or entity's inventory.
Parameters
- entity: Entity | Container
  Entity or container.
- itemId: string
  Item typeId.
Returns boolean
True if an item was removed.
Example
```
const removed = InventoryUtil.removeSingleItem(player, "minecraft:arrow");
```
- Defined in src/utils/inventory_util.ts:325

`Static`removeItem

removeItem(
    entity: Entity | Container,
    itemId: string,
    itemAmount: number,
    requireAll?: boolean,
): boolean
Removes an amount of an item by ID from a container or entity's inventory. It can fail if you require there to exist that amount of the item.
Parameters
- entity: Entity | Container
  Entity or Container.
- itemId: string
  Item typeId.
- itemAmount: number
- requireAll: boolean = false
  If we need there to be at least the total amount of the item.
Returns boolean
True if all items were removed.
- Defined in src/utils/inventory_util.ts:352

`Static`removeItems

removeItems(
    entity: Entity | Container,
    items: { itemId: string; amount: number }[],
    requireAll?: boolean,
): boolean
Removes an array of item types from a container or entity's inventory. It can fail if there is not enough of the item in the inventory
Parameters
- entity: Entity | Container
  Entity or Container.
- items: { itemId: string; amount: number }[]
  An array of item types and amounts to remove from the player
- requireAll: boolean = false
  The container must contain all of the items to remove them. Fails if any item amount is not enough
Returns boolean
True if all items were removed.
- Defined in src/utils/inventory_util.ts:385

`Static`clearContainer

clearContainer(container: Container): void
Clears all items from a container.
Parameters
- container: Container
  Container to clear.
Returns void
Example
```
InventoryUtil.clearContainer(chestContainer);
```
- Defined in src/utils/inventory_util.ts:428

`Static`giveItemStackToEntity

giveItemStackToEntity(
    entity: Entity,
    itemStack: ItemStack,
    lockMode?: ItemLockMode,
    keepOnDeath?: boolean,
): void
Gives an ItemStack to an entity's inventory, dropping any leftovers.
Parameters
- entity: Entity
  Target entity.
- itemStack: ItemStack
  ItemStack to give.
- lockMode: ItemLockMode = ItemLockMode.none
  Optional lock mode.
- keepOnDeath: boolean = false
  Should item persist on death.
Returns void
Example
```
InventoryUtil.giveItemStackToEntity(player, new ItemStack("minecraft:diamond", 5));
```
- Defined in src/utils/inventory_util.ts:450

`Static`giveItemStackToContainer

giveItemStackToContainer(
    container: Container,
    itemStack: ItemStack,
    lockMode?: ItemLockMode,
    keepOnDeath?: boolean,
): ItemStack | undefined
Gives an ItemStack to a container.
Parameters
- container: Container
  Target container.
- itemStack: ItemStack
  ItemStack to give.
- lockMode: ItemLockMode = ItemLockMode.none
  Optional lock mode.
- keepOnDeath: boolean = false
  Should item persist on death.
Returns ItemStack | undefined
Any leftover ItemStack that couldn't fit.
- Defined in src/utils/inventory_util.ts:472

`Static`giveItemToEntity

giveItemToEntity(
    entity: Entity,
    item: string,
    amount?: number,
    lockMode?: ItemLockMode,
    keepOnDeath?: boolean,
): void
Creates a new ItemStack and gives it to an entity.
Parameters
- entity: Entity
  Target entity.
- item: string
  Item typeId.
- amount: number = 1
  Amount to give (default 1).
- lockMode: ItemLockMode = ItemLockMode.none
  Optional lock mode.
- keepOnDeath: boolean = false
  Should item persist on death.
Returns void
- Defined in src/utils/inventory_util.ts:492

`Static`hasItem

hasItem(entity: Entity, predicate: (item: ItemStack) => boolean): boolean
Checks if an entity has an item matching the predicate.
Parameters
- entity: Entity
  Entity to check.
- predicate: (item: ItemStack) => boolean
  Predicate function to match items.
Returns boolean
True if an item matches.
Example
```
const hasBow = InventoryUtil.hasItem(player, item => item.typeId === "minecraft:bow");
```
- Defined in src/utils/inventory_util.ts:524

`Static`findItem

findItem(
entity: Entity,
predicate: (item: ItemStack) => boolean,
): ItemStack | undefined
Finds the first item in equipment or inventory that matches a predicate.
Parameters
- entity: Entity
  Entity to check.
- predicate: (item: ItemStack) => boolean
  Predicate function.
Returns ItemStack | undefined
The matching ItemStack or undefined.
- Defined in src/utils/inventory_util.ts:535

`Static`consumeItem

consumeItem(entity: Entity, predicate: (item: ItemStack) => boolean): boolean
Consumes (removes one) of the first matching item in equipment or inventory.
Parameters
- entity: Entity
  Entity to modify.
- predicate: (item: ItemStack) => boolean
  Predicate to match items.
Returns boolean
True if an item was consumed.
Example
```
const consumed = InventoryUtil.consumeItem(player, item => item.typeId === "minecraft:apple");
if (consumed) console.log("A single apple was consumed from inventory or equipment");
```
- Defined in src/utils/inventory_util.ts:564

`Static`getSlots

getSlots(
    entity: Entity | Container,
    itemId: string,
    itemAmount: number,
    requireAll?: boolean,
): ContainerSlot[]
Returns the slots that contains the item up to the amount specified. This can overshoot the amount of items.
Parameters
- entity: Entity | Container
  Entity or Container.
- itemId: string
  Item typeId.
- itemAmount: number
- requireAll: boolean = false
  Only returns an array if they are enough items. Defaults to false
Returns ContainerSlot[]
True if all items were removed.
- Defined in src/utils/inventory_util.ts:587

`Static`isInventoryEmpty

isInventoryEmpty(entity: Entity | Container): boolean
Checks if an entity or container has a completely empty inventory.
Parameters
- entity: Entity | Container
  The entity or container to check.
Returns boolean
True if all inventory slots are empty.
Example
```
const isEmpty = InventoryUtil.isInventoryEmpty(player);
if (isEmpty) console.log("No items in inventory");
```
- Defined in src/utils/inventory_util.ts:687

Class InventoryUtilAbstract

Index

Constructors

Methods

Constructors

constructor

Returns InventoryUtil

Methods

StaticgetInventory

Parameters

Returns EntityInventoryComponent | undefined

Example

StaticgetEquipment

Parameters

Returns EntityEquippableComponent | undefined

Example

StaticgetContainer

Parameters

Returns Container | undefined

Example

StaticgetSelectedSlot

Parameters

Returns ContainerSlot | undefined

Example

StaticgetSelectedItem

Parameters

Returns ItemStack | undefined

Example

StaticsetSelectedItem

Parameters

Returns void

Example

StaticgetMainhandSlot

Parameters

Returns ContainerSlot | undefined

Example

StaticgetMainhandItem

Parameters

Returns ItemStack | undefined

Example

StaticsetMainhandItem

Parameters

Returns void

Example

StaticgetOffhandItem

Parameters

Returns ItemStack | undefined

Example

StaticgetContainerItems

Parameters

Returns ItemStack[]

Example

Parameters

Returns ItemStack[]

Example

Parameters

Returns (ItemStack | undefined)[]

Example

StaticgetItemTotal

Parameters

Returns number

Example

StaticconsumeSelectedItem

Parameters

Returns void

Example

StaticreduceItemStack

Parameters

Returns ItemStack | undefined

Example

StaticremoveSingleItem

Parameters

Returns boolean

Example

StaticremoveItem

Parameters

Returns boolean

StaticremoveItems

Parameters

Returns boolean

Class InventoryUtil`Abstract`

`Static`getInventory

`Static`getEquipment

`Static`getContainer

`Static`getSelectedSlot

`Static`getSelectedItem

`Static`setSelectedItem

`Static`getMainhandSlot

`Static`getMainhandItem

`Static`setMainhandItem

`Static`getOffhandItem

`Static`getContainerItems

`Static`getItemTotal

`Static`consumeSelectedItem

`Static`reduceItemStack

`Static`removeSingleItem

`Static`removeItem

`Static`removeItems

`Static`clearContainer

`Static`giveItemStackToEntity

`Static`giveItemStackToContainer

`Static`giveItemToEntity

`Static`hasItem

`Static`findItem

`Static`consumeItem

`Static`getSlots

`Static`isInventoryEmpty