Prototype/ItemWithInventory: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(1.1.78: inventory_size dynamic, only for bp books (previously undocumented))
(Removed old prototype docs)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Prototype parent|Prototype/ItemWithLabel}}
<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/ItemWithInventoryPrototype.html https://lua-api.factorio.com/latest/prototypes/ItemWithInventoryPrototype.html]
The inventory allows setting player defined filters similar to the quickbar and cargo wagon inventories.


{{Prototype TOC|item-with-inventory}}
</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 
== Extensions ==
* [[Prototype/BlueprintBook]] '''blueprint-book'''
 
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/ItemWithLabel]].
 
{{Prototype property|inventory_size|[[Types/ItemStackIndex|ItemStackIndex]] or [[Types/string|string]]}}
The inventory size of the item or "dynamic" for a dynamic inventory size. "dynamic" can only be used for [[Prototype/BlueprintBook]].
 
== Optional properties ==
 
{{Prototype property|item_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
A list of explicit item names to be used as filters.
  item_filters = {"iron-ore", "copper-ore", "coal", "stone"}
 
{{Prototype property|item_group_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
A list of explicit item group names to be used as filters.
  item_group_filters = {"storage", "belt"}
 
{{Prototype property|item_subgroup_filters|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
A list of explicit item subgroup names to be used as filters.
  item_subgroup_filters = {"capsule", "tool"}
 
{{Prototype property|filter_mode|[[Types/string|string]]|"whitelist"|optional=true}}
This determines how filters are applied. If no filters are defined this is automatically set to "none".
  filter_mode = "blacklist" -- or "whitelist" if you want whitelisting
 
{{Prototype property|filter_message_key |[[Types/string|string]]|"item-limitation.item-not-allowed-in-this-container-item"|optional=true}}
The locale key used when the player attempts to put an item that doesn't match the filter rules into the item-with-inventory.
 
{{Prototype property|extends_inventory_by_default|[[Types/bool|bool]]|false|optional=true}}
When true, this item-with-inventory will extend the inventory it sits in by default. This is a runtime property on the result item that can be changed through the Lua interface and only determines the initial value.
 
{{Prototype property|insertion_priority_mode|[[Types/string|string]]|"default"|optional=true}}
The insertion priority mode for this item. This determines if items are first attempted to be put into this items inventory if the item extends the inventory it sits in when items are put into the parent inventory.
  insertion_priority_mode = "never"
 
Possible values are:
{| class="wikitable"
|-
! Flag !! meaning
|-
| default  || Items are inserted into this item-with-inventory only if they match the whitelist defined in the prototype for the item and whitelist is used.
|-
| never || Items are never inserted into this item-with-inventory except explicitly by the player or script
|-
| always || All items first try to be inserted into this item-with-inventory
|-
| when_manually_filtered || When the inventory contains filters that match the item-to-be-inserted then try to put it into this item before the inventory this item resides in
|}
 
== Mandatory values ==
Item with inventory must have a stack size of 1.

Latest revision as of 14:32, 25 October 2024

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/ItemWithInventoryPrototype.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/ItemWithInventory&oldid=202925"