inventory

Methods for interacting with inventories.

Changes

• New in version 1.94.0

size()Source

Get the size of this inventory.

Returns

1. number The number of slots in this inventory.

list()Source

List all items in this inventory. This returns a table, with an entry for each slot.

Each item in the inventory is represented by a table containing some basic information, much like turtle.getItemDetail includes. More information can be fetched with getItemDetail. The table contains the item name, the count and an a (potentially nil) hash of the item's nbt. This NBT data doesn't contain anything useful, but allows you to distinguish identical items.

The returned table is sparse, and so empty slots will be nil - it is recommended to loop over using pairs rather than ipairs.

Returns

1. { table | nil... } Basic information about all items in this inventory.

Usage

• Find an adjacent chest and print all items in it.

  Run ᐅ

  local chest = peripheral.find("minecraft:chest")
  for slot, item in pairs(chest.list()) do
    print(("%d x %s in slot %d"):format(item.count, item.name, slot))
  end

getItemDetail(slot)Source

Get detailed information about an item.

The returned information contains the same information as each item in list, as well as additional details like the display name (displayName), and item and item durability (damage, maxDamage, durability).

Some items include more information (such as enchantments) - it is recommended to print it out using textutils.serialize or in the Lua REPL, to explore what is available.

🛈 Deprecated fields

Older versions of CC: Tweaked exposed an itemGroups field, listing the creative tabs an item was available under. This information is no longer available on more recent versions of the game, and so this field will always be empty. Do not use this field in new code!

Parameters

1. slot number The slot to get information about.

Returns

1. table | nil Information about the item in this slot, or nil if it is empty.

Throws

• If the slot is out of range.

Usage

• Print some information about the first in a chest.

  Run ᐅ

  local chest = peripheral.find("minecraft:chest")
  local item = chest.getItemDetail(1)
  if not item then print("No item") return end
  
  print(("%s (%s)"):format(item.displayName, item.name))
  print(("Count: %d/%d"):format(item.count, item.maxCount))
  
  if item.damage then
    print(("Damage: %d/%d"):format(item.damage, item.maxDamage))
  end

getItemLimit(slot)Source

Get the maximum number of items which can be stored in this slot.

Typically this will be limited to 64 items. However, some inventories (such as barrels or caches) can store hundreds or thousands of items in one slot.

Parameters

1. slot number The slot

Returns

1. number The maximum number of items in this slot.

Throws

• If the slot is out of range.

Usage

• Count the maximum number of items an adjacent chest can hold.

  Run ᐅ

  local chest = peripheral.find("minecraft:chest")
  local total = 0
  for i = 1, chest.size() do
    total = total + chest.getItemLimit(i)
  end
  print(total)

Changes

• New in version 1.96.0

pushItems(toName, fromSlot [, limit [, toSlot]])Source

Push items from one inventory to another connected one.

This allows you to push an item in an inventory to another inventory on the same wired network. Both inventories must attached to wired modems which are connected via a cable.

Parameters

1. toName string The name of the peripheral/inventory to push to. This is the string given to peripheral.wrap, and displayed by the wired modem.
2. fromSlot number The slot in the current inventory to move items to.
3. limit? number The maximum number of items to move. Defaults to the current stack limit.
4. toSlot? number The slot in the target inventory to move to. If not given, the item will be inserted into any slot.

Returns

1. number The number of transferred items.

Throws

• If the peripheral to transfer to doesn't exist or isn't an inventory.

• If either source or destination slot is out of range.

Usage

• Wrap two chests, and push an item from one to another.

  Run ᐅ

  local chest_a = peripheral.wrap("minecraft:chest_0")
  local chest_b = peripheral.wrap("minecraft:chest_1")
  
  chest_a.pushItems(peripheral.getName(chest_b), 1)

See also

• peripheral.getName Allows you to get the name of a wrapped peripheral.

pullItems(fromName, fromSlot [, limit [, toSlot]])Source

Pull items from a connected inventory into this one.

This allows you to transfer items between inventories on the same wired network. Both this and the source inventory must attached to wired modems which are connected via a cable.

Parameters

1. fromName string The name of the peripheral/inventory to pull from. This is the string given to peripheral.wrap, and displayed by the wired modem.
2. fromSlot number The slot in the source inventory to move items from.
3. limit? number The maximum number of items to move. Defaults to the current stack limit.
4. toSlot? number The slot in current inventory to move to. If not given, the item will be inserted into any slot.

Returns

1. number The number of transferred items.

Throws

• If the peripheral to transfer to doesn't exist or isn't an inventory.

• If either source or destination slot is out of range.

Usage

• Wrap two chests, and push an item from one to another.

  Run ᐅ

  local chest_a = peripheral.wrap("minecraft:chest_0")
  local chest_b = peripheral.wrap("minecraft:chest_1")
  
  chest_a.pullItems(peripheral.getName(chest_b), 1)

See also

• peripheral.getName Allows you to get the name of a wrapped peripheral.