api/org.kryptonmc.api.inventory/Inventory

Inventory

interface Inventory : Iterable<ItemStack>

An inventory that contains items.

The absence of a value in an inventory will always be represented by ItemStack.empty, not null. This includes the default values in lists of items, such as items.

Inheritors

PlayerInventory

Functions

addItem

abstract fun addItem(item: ItemStack)

Puts the specified item in the first available empty slot in this inventory, or does nothing if the inventory is full.

clear

abstract fun clear()

Clears this inventory.

forEach

open fun forEach(p0: Consumer<in ItemStack>)

getItem

abstract fun getItem(index: Int): ItemStack

Retrieve an item from this inventory at the specified index.

hasItem

abstract fun hasItem(item: ItemStack): Boolean

If this inventory contains the specified item.

iterator

abstract operator fun iterator(): Iterator<ItemStack>

removeItem

abstract fun removeItem(item: ItemStack)

Removes the specified item from the array, or does nothing if there isn't an element that matches this item.

setItem

abstract fun setItem(index: Int, item: ItemStack)

Sets the item at the given index to the given item.

spliterator

open fun spliterator(): Spliterator<ItemStack>

Properties

items

abstract val items: List<ItemStack>

The items in this inventory.

size

abstract val size: Int

The size of this inventory.

type

abstract val type: InventoryType

The type of this inventory.