
| clear() | Clear this inventory of all items so that it becomes empty. | |
Clear this inventory of all items so that it becomes empty. | ||
| can_insert(items) | → boolean | Can at least some items be inserted? |
Can at least some items be inserted? | ||
| insert(items) | → uint32 | Insert items into this inventory. |
Insert items into this inventory. | ||
| remove(items) | → uint32 | Remove items from this inventory. |
Remove items from this inventory. | ||
| get_item_count(item?) | → uint32 | Get the number of all or some items in this inventory. |
Get the number of all or some items in this inventory. | ||
| get_item_count_filtered(filter) | → uint32 | Get the number of items in this inventory that match provided filter. |
Get the number of items in this inventory that match provided filter. | ||
| get_item_quality_counts(item?) | → dictionary[string → uint32] | Get the number of all or some items in this inventory, aggregated by quality. |
Get the number of all or some items in this inventory, aggregated by quality. | ||
| is_empty() | → boolean | Does this inventory contain nothing? |
Does this inventory contain nothing? | ||
| is_full() | → boolean | Is every stack in this inventory full? [...] |
Is every stack in this inventory full? [...] | ||
| get_contents() | → ItemWithQualityCounts | Get counts of all items in this inventory. |
Get counts of all items in this inventory. | ||
| supports_bar() | → boolean | Does this inventory support a bar? [...] |
Does this inventory support a bar? [...] | ||
| get_bar() | → uint32 | Get the current bar. [...] |
Get the current bar. [...] | ||
| set_bar(bar?) | Set the current bar. [...] | |
Set the current bar. [...] | ||
| supports_filters() | → boolean | If this inventory supports filters. |
If this inventory supports filters. | ||
| is_filtered() | → boolean | If this inventory supports filters and has at least 1 filter set. |
If this inventory supports filters and has at least 1 filter set. | ||
| can_set_filter(index, filter) | → boolean | If the given inventory slot filter can be set to the given filter. |
If the given inventory slot filter can be set to the given filter. | ||
| get_filter(index) | → ItemFilter? | Gets the filter for the given item stack index. |
Gets the filter for the given item stack index. | ||
| set_filter(index, filter) | → boolean | Sets the filter for the given item stack index. [...] |
Sets the filter for the given item stack index. [...] | ||
| find_item_stack(item) | → LuaItemStack?, uint32? | Finds the first LuaItemStack in the inventory that matches the given item name. |
Finds the first LuaItemStack in the inventory that matches the given item name. | ||
| find_empty_stack(item?) | → LuaItemStack?, uint32? | Finds the first empty stack. [...] |
Finds the first empty stack. [...] | ||
| count_empty_stacks(include_filtered?, include_bar?) | → uint32 | Counts the number of empty stacks. |
Counts the number of empty stacks. | ||
| get_insertable_count(item) | → uint32 | Gets the number of the given item that can be inserted into this inventory. [...] |
Gets the number of the given item that can be inserted into this inventory. [...] | ||
| sort_and_merge() | Sorts and merges the items in this inventory. | |
Sorts and merges the items in this inventory. | ||
| resize(size) | Resizes the inventory. [...] | |
Resizes the inventory. [...] | ||
| destroy() | Destroys this inventory. [...] | |
Destroys this inventory. [...] | ||
| index | :: R defines.inventory? | The inventory index this inventory uses, if any. |
The inventory index this inventory uses, if any. | ||
| name | :: R string? | Name of this inventory, if any. [...] |
Name of this inventory, if any. [...] | ||
| entity_owner | :: R LuaEntity? | The entity that owns this inventory, if any. |
The entity that owns this inventory, if any. | ||
| player_owner | :: R LuaPlayer? | The player that owns this inventory, if any. |
The player that owns this inventory, if any. | ||
| equipment_owner | :: R LuaEquipment? | The equipment that owns this inventory, if any. |
The equipment that owns this inventory, if any. | ||
| mod_owner | :: R string? | The mod that owns this inventory, if any. |
The mod that owns this inventory, if any. | ||
| weight | :: R Weight | Gives a total weight of all items currently in this inventory. |
Gives a total weight of all items currently in this inventory. | ||
| max_weight | :: R Weight? | Gives a maximum weight of items that can be inserted into this inventory. |
Gives a maximum weight of items that can be inserted into this inventory. | ||
| valid | :: R boolean | Is this object valid? [...] |
Is this object valid? [...] | ||
| object_name | :: R string | The class name of this object. [...] |
The class name of this object. [...] | ||
| [] (index) | :: R LuaItemStack | The indexing operator. |
The indexing operator. | ||
| # (length) | :: R uint32 | Get the number of slots in this inventory. |
Get the number of slots in this inventory. | ||

| items | :: ItemStackIdentification | Items that would be inserted. |
Items that would be inserted. | ||
| → boolean |
|

| items | :: ItemStackIdentification | Items to insert. |
Items to insert. | ||
| → uint32 | Number of items actually inserted. |

| items | :: ItemStackIdentification | Items to remove. |
Items to remove. | ||
| → uint32 | Number of items actually removed. |

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







| bar | :: uint32? | The new limit. Omitting this parameter or passing |
The new limit. Omitting this parameter or passing | ||



| index | :: uint32 | The item stack index |
The item stack index | ||
| filter | :: ItemFilter | The item filter |
The item filter | ||

| index | :: uint32 | The item stack index |
The item stack index | ||
| → ItemFilter? | The current filter or |

| index | :: uint32 | The item stack index. |
The item stack index. | ||
| filter | :: ItemFilter or nil | The new filter. |
The new filter. | ||
| → boolean | If the filter was allowed to be set. |

| item | :: ItemWithQualityID | The item to find |
The item to find | ||
| → LuaItemStack? | The first matching stack, or |
| → uint32? | The stack index of the matching stack, if any is found. |

| item | :: ItemWithQualityID? | If given, empty stacks that are filtered for this item will be included. |
If given, empty stacks that are filtered for this item will be included. | ||
| → LuaItemStack? | The first empty stack, or |
| → uint32? | The stack index of the matching stack, if any is found. |

| include_filtered | :: boolean? | If true, filtered slots will be included. Defaults to false. |
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. |
If true, slots blocked by the current bar will be included. Defaults to true. | ||


| size | :: uint16 | New size of a inventory |
New size of a inventory | ||
| on_pre_script_inventory_resized instantly | |
| on_script_inventory_resized instantly |











-- Will get the first item in the player's inventory.
game.player.get_main_inventory()[1]