LuaInventory

A storage of item stacks.

Attributes

index

• Read: defines.inventory
• Write: unknown
• Optional: true

The inventory index this inventory uses, if any.

name

• Read: string
• Write: unknown
• Optional: true

Name of this inventory, if any. Names match keys of defines.inventory.

entity_owner

• Read: LuaEntity
• Write: unknown
• Optional: true

The entity that owns this inventory, if any.

player_owner

• Read: LuaPlayer
• Write: unknown
• Optional: true

The player that owns this inventory, if any.

equipment_owner

• Read: LuaEquipment
• Write: unknown
• Optional: true

The equipment that owns this inventory, if any.

mod_owner

• Read: string
• Write: unknown
• Optional: true

The mod that owns this inventory, if any.

weight

• Read: Weight
• Write: unknown
• Optional: false

Gives a total weight of all items currently in this inventory.

max_weight

• Read: Weight
• Write: unknown
• Optional: true

Gives a maximum weight of items that can be inserted into this inventory.

valid

• Read: boolean
• Write: unknown
• Optional: false

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

object_name

• Read: string
• Write: unknown
• Optional: false

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Methods

clear

LuaInventory.clear()

Call As

inventory.clear()

Call Convention

• takes_table: false
• table_optional: false

Clear this inventory of all items so that it becomes empty.

can_insert

LuaInventory.can_insert(items: ItemStackIdentification) -> boolean

Call As

inventory.can_insert(items)

Call Convention

• takes_table: false
• table_optional: false

Can at least some items be inserted?

Parameters

• items: ItemStackIdentification — Items that would be inserted.

Returns

• boolean — true if at least a part of the given items could be inserted into this inventory.

insert

LuaInventory.insert(items: ItemStackIdentification) -> uint32

Call As

inventory.insert(items)

Call Convention

• takes_table: false
• table_optional: false

Insert items into this inventory.

Parameters

• items: ItemStackIdentification — Items to insert.

Returns

• uint32 — Number of items actually inserted.

remove

LuaInventory.remove(items: ItemStackIdentification) -> uint32

Call As

inventory.remove(items)

Call Convention

• takes_table: false
• table_optional: false

Remove items from this inventory.

Parameters

• items: ItemStackIdentification — Items to remove.

Returns

• uint32 — Number of items actually removed.

get_item_count

LuaInventory.get_item_count(item?: ItemWithQualityID) -> uint32

Call As

inventory.get_item_count()

Call Convention

• takes_table: false
• table_optional: false

Get the number of all or some items in this inventory.

Parameters

• item?: ItemWithQualityID — The item to count. If not specified, count all items.

Returns

• uint32

get_item_count_filtered

LuaInventory.get_item_count_filtered(filter: ItemFilter) -> uint32

Call As

inventory.get_item_count_filtered(filter)

Call Convention

• takes_table: false
• table_optional: false

Get the number of items in this inventory that match provided filter.

Parameters

• filter: ItemFilter

Returns

• uint32

get_item_quality_counts

LuaInventory.get_item_quality_counts(item?: ItemID) -> Dict<string, uint32>

Call As

inventory.get_item_quality_counts()

Call Convention

• takes_table: false
• table_optional: false

Get the number of all or some items in this inventory, aggregated by quality.

Parameters

• item?: ItemID

Returns

• Dict<string, uint32>

is_empty

LuaInventory.is_empty() -> boolean

Call As

inventory.is_empty()

Call Convention

• takes_table: false
• table_optional: false

Does this inventory contain nothing?

Returns

• boolean

is_full

LuaInventory.is_full() -> boolean

Call As

inventory.is_full()

Call Convention

• takes_table: false
• table_optional: false

Is every stack in this inventory full? Ignores stacks blocked by the current bar.

For the input slots of crafting machines that allow counts larger than the item stack size, this may return true even when more items can still be inserted.

Returns

• boolean

get_contents

LuaInventory.get_contents() -> ItemWithQualityCounts

Call As

inventory.get_contents()

Call Convention

• takes_table: false
• table_optional: false

Get counts of all items in this inventory.

Returns

• ItemWithQualityCounts — List of all items in the inventory.

supports_bar

LuaInventory.supports_bar() -> boolean

Call As

inventory.supports_bar()

Call Convention

• takes_table: false
• table_optional: false

Does this inventory support a bar? Bar is the draggable red thing, found for example on chests, that limits the portion of the inventory that may be manipulated by machines.

"Supporting a bar" doesn't mean that the bar is set to some nontrivial value. Supporting a bar means the inventory supports having this limit at all. The character's inventory is an example of an inventory without a bar; the wooden chest's inventory is an example of one with a bar.

Returns

• boolean

get_bar

LuaInventory.get_bar() -> uint32

Call As

inventory.get_bar()

Call Convention

• takes_table: false
• table_optional: false

Get the current bar. This is the index at which the red area starts.

Only useable if this inventory supports having a bar.

Returns

• uint32

set_bar

LuaInventory.set_bar(bar?: uint32)

Call As

inventory.set_bar()

Call Convention

• takes_table: false
• table_optional: false

Set the current bar.

Only useable if this inventory supports having a bar.

Parameters

• bar?: uint32 — The new limit. Omitting this parameter or passing nil will clear the limit.

supports_filters

LuaInventory.supports_filters() -> boolean

Call As

inventory.supports_filters()

Call Convention

• takes_table: false
• table_optional: false

If this inventory supports filters.

Returns

• boolean

is_filtered

LuaInventory.is_filtered() -> boolean

Call As

inventory.is_filtered()

Call Convention

• takes_table: false
• table_optional: false

If this inventory supports filters and has at least 1 filter set.

Returns

• boolean

can_set_filter

LuaInventory.can_set_filter(index: uint32, filter: ItemFilter) -> boolean

Call As

inventory.can_set_filter(index, filter)

Call Convention

• takes_table: false
• table_optional: false

If the given inventory slot filter can be set to the given filter.

Parameters

• index: uint32 — The item stack index
• filter: ItemFilter — The item filter

Returns

• boolean

get_filter

LuaInventory.get_filter(index: uint32) -> ItemFilter?

Call As

inventory.get_filter(index)

Call Convention

• takes_table: false
• table_optional: false

Gets the filter for the given item stack index.

Parameters

• index: uint32 — The item stack index

Returns

• ItemFilter? — The current filter or nil if none.

set_filter

LuaInventory.set_filter(index: uint32, filter: ItemFilter | nil) -> boolean

Call As

inventory.set_filter(index, filter)

Call Convention

• takes_table: false
• table_optional: false

Sets the filter for the given item stack index.

Some inventory slots don't allow some filters (gun ammo can't be filtered for non-ammo).

Parameters

• index: uint32 — The item stack index.
• filter: ItemFilter | nil — The new filter. nil erases any existing filter.

Returns

• boolean — If the filter was allowed to be set.

find_item_stack

LuaInventory.find_item_stack(item: ItemWithQualityID) -> LuaItemStack?, uint32?

Call As

inventory.find_item_stack(item)

Call Convention

• takes_table: false
• table_optional: false

Finds the first LuaItemStack in the inventory that matches the given item name.

Parameters

• item: ItemWithQualityID — The item to find

Returns

• LuaItemStack? — The first matching stack, or nil if none match.
• uint32? — The stack index of the matching stack, if any is found.

find_empty_stack

LuaInventory.find_empty_stack(item?: ItemWithQualityID) -> LuaItemStack?, uint32?

Call As

inventory.find_empty_stack()

Call Convention

• takes_table: false
• table_optional: false

Finds the first empty stack. Filtered slots are excluded unless a filter item is given.

Parameters

• item?: ItemWithQualityID — If given, empty stacks that are filtered for this item will be included.

Returns

• LuaItemStack? — The first empty stack, or nil if there aren't any empty stacks.
• uint32? — The stack index of the matching stack, if any is found.

count_empty_stacks

LuaInventory.count_empty_stacks(include_filtered?: boolean, include_bar?: boolean) -> uint32

Call As

inventory.count_empty_stacks()

Call Convention

• takes_table: false
• table_optional: false

Counts the number of empty stacks.

Parameters

• include_filtered?: boolean — If true, filtered slots will be included. Defaults to false.
• include_bar?: boolean — If true, slots blocked by the current bar will be included. Defaults to true.

Returns

• uint32

get_insertable_count

LuaInventory.get_insertable_count(item: ItemWithQualityID) -> uint32

Call As

inventory.get_insertable_count(item)

Call Convention

• takes_table: false
• table_optional: false

Gets the number of the given item that can be inserted into this inventory.

This is a "best guess" number; things like assembling machine filtered slots, module slots, items with durability, and items with mixed health will cause the result to be inaccurate. The main use for this is in checking how many of a basic item can fit into a basic inventory.

This accounts for the 'bar' on the inventory.

Parameters

• item: ItemWithQualityID — The item to check.

Returns

• uint32

sort_and_merge

LuaInventory.sort_and_merge()

Call As

inventory.sort_and_merge()

Call Convention

• takes_table: false
• table_optional: false

Sorts and merges the items in this inventory.

resize

LuaInventory.resize(size: uint16)

Call As

inventory.resize(size)

Call Convention

• takes_table: false
• table_optional: false

Resizes the inventory.

Items in slots beyond the new capacity are deleted.

Only inventories created by LuaGameScript::create_inventory can be resized.

Parameters

• size: uint16 — New size of a inventory

destroy

LuaInventory.destroy()

Call As

inventory.destroy()

Call Convention

• takes_table: false
• table_optional: false

Destroys this inventory.

Only inventories created by LuaGameScript::create_inventory can be destroyed this way.