Prototype/ItemWithInventory - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:54Z

Removed old prototype docs

← Older revision		Revision as of 14:32, 25 October 2024
Line 2:		Line 2:

	</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>		</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>



	~~{{Prototype parent\|Prototype/ItemWithLabel}}~~
	~~The inventory allows setting player defined filters similar to cargo wagon inventories.~~

	~~{{Prototype TOC\|item-with-inventory}}~~

	~~== 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.~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:11Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:43, 21 September 2023
Line 1:		Line 1:
	'''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]		<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]

	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><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>

BilkaBot: Protected "Prototype/ItemWithInventory": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:41Z

Protected "Prototype/ItemWithInventory": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:52, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:52:41Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:52, 16 August 2023
Line 1:		Line 1:
			'''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]

			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].



	{{Prototype parent\|Prototype/ItemWithLabel}}		{{Prototype parent\|Prototype/ItemWithLabel}}
	The inventory allows setting player defined filters similar to cargo wagon inventories.		The inventory allows setting player defined filters similar to cargo wagon inventories.

Bilka: fix incorrect insertion priority mode option

2023-05-22T16:10:28Z

fix incorrect insertion priority mode option

← Older revision		Revision as of 16:10, 22 May 2023
Line 52:		Line 52:
	\| always \|\| All items first try to be inserted into this item-with-inventory		\| 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		\| 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 ==		== Mandatory values ==
	Item with inventory must have a stack size of 1.		Item with inventory must have a stack size of 1.

Bilka: there is no more quickbar

2023-05-22T15:58:58Z

there is no more quickbar

← Older revision		Revision as of 15:58, 22 May 2023
Line 1:		Line 1:
	{{Prototype parent\|Prototype/ItemWithLabel}}		{{Prototype parent\|Prototype/ItemWithLabel}}
	The inventory allows setting player defined filters similar to ~~the quickbar and~~ cargo wagon inventories.		The inventory allows setting player defined filters similar to cargo wagon inventories.

	{{Prototype TOC\|item-with-inventory}}		{{Prototype TOC\|item-with-inventory}}

Bilka: 1.1.78: inventory_size dynamic, only for bp books (previously undocumented)

2023-03-29T12:38:16Z

1.1.78: inventory_size dynamic, only for bp books (previously undocumented)

← Older revision		Revision as of 12:38, 29 March 2023
Line 10:		Line 10:
	This prototype inherits all the properties from [[Prototype/ItemWithLabel]].		This prototype inherits all the properties from [[Prototype/ItemWithLabel]].

	{{Prototype property\|inventory_size\|[[Types/ItemStackIndex\|ItemStackIndex]]}}		{{Prototype property\|inventory_size\|[[Types/ItemStackIndex\|ItemStackIndex]] or [[Types/string\|string]]}}
	The inventory size of the item.		The inventory size of the item or "dynamic" for a dynamic inventory size. "dynamic" can only be used for [[Prototype/BlueprintBook]].

	== Optional properties ==		== Optional properties ==

Bilka: words

2022-11-03T14:18:56Z

words

← Older revision		Revision as of 14:18, 3 November 2022
Line 55:		Line 55:
	\|}		\|}

	== ~~Differing defaults~~ ==		== Mandatory values ==
	~~=== stack_size ===~~		Item with inventory must have a stack size of 1.
	~~Must be~~ 1.

Bilka: /* Differing defaults */ 0.18.10

2020-03-03T17:18:00Z

Differing defaults: 0.18.10

← Older revision		Revision as of 17:18, 3 March 2020
Line 56:		Line 56:

	== Differing defaults ==		== Differing defaults ==
	~~=== stackable ===~~
	~~Defaults to <code>false</code>, can't be changed.~~

	=== stack_size ===		=== stack_size ===
	Must be 1.		Must be 1.

Bilka: Converted to SMW format

2019-07-26T15:12:02Z

Converted to SMW format

← Older revision		Revision as of 15:12, 26 July 2019
Line 1:		Line 1:
	{{Prototype parent\|Prototype/ItemWithLabel}}		{{Prototype parent\|Prototype/ItemWithLabel}}
			The inventory allows setting player defined filters similar to the quickbar and cargo wagon inventories.

	~~== Basics ==~~		{{Prototype TOC\|item-with-inventory}}
	Prototype ~~type: '''~~item-with-inventory~~'''~~

	~~The inventory allows setting player defined filters similar to the quickbar and cargo wagon inventories. Extends [[Prototype/ItemWithLabel]].~~

	== Extensions ==		== Extensions ==
Line 12:		Line 10:
	This prototype inherits all the properties from [[Prototype/ItemWithLabel]].		This prototype inherits all the properties from [[Prototype/ItemWithLabel]].

	~~===~~ inventory_size ~~===~~		{{Prototype property\|inventory_size\|[[Types/ItemStackIndex\|ItemStackIndex]]}}
	~~'''Type''':~~ [[Types/ItemStackIndex]]

	The inventory size of the item.		The inventory size of the item.

	== Optional properties ==		== Optional properties ==

	~~===~~ item_filters ~~===~~		{{Prototype property\|item_filters\|[[Types/table\|table]] of [[Types/string\|string]]\|optional=true}}
	~~'''Type''':~~ [[Types/table]] of [[Types/string]]

	A list of explicit item names to be used as filters.		A list of explicit item names to be used as filters.
	item_filters = {"iron-ore", "copper-ore", "coal", "stone"}		item_filters = {"iron-ore", "copper-ore", "coal", "stone"}

	~~===~~ item_group_filters ~~===~~		{{Prototype property\|item_group_filters\|[[Types/table\|table]] of [[Types/string\|string]]\|optional=true}}
	~~'''Type''':~~ [[Types/table]] of [[Types/string]]

	A list of explicit item group names to be used as filters.		A list of explicit item group names to be used as filters.
	item_group_filters = {"storage", "belt"}		item_group_filters = {"storage", "belt"}

	~~===~~ item_subgroup_filters ~~===~~		{{Prototype property\|item_subgroup_filters\|[[Types/table\|table]] of [[Types/string\|string]]\|optional=true}}
	~~'''Type''':~~ [[Types/table]] of [[Types/string]]

	A list of explicit item subgroup names to be used as filters.		A list of explicit item subgroup names to be used as filters.
	item_subgroup_filters = {"capsule", "tool"}		item_subgroup_filters = {"capsule", "tool"}

	~~===~~ filter_mode ~~===~~		{{Prototype property\|filter_mode\|[[Types/string\|string]]\|"whitelist"\|optional=true}}
	~~'''Type''':~~ [[Types/string]]

	~~'''Default''':~~ "whitelist"

	This determines how filters are applied. If no filters are defined this is automatically set to "none".		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		filter_mode = "blacklist" -- or "whitelist" if you want whitelisting

	~~===~~ filter_message_key ~~===~~		{{Prototype property\|filter_message_key \|[[Types/string\|string]]\|"item-limitation.item-not-allowed-in-this-container-item"\|optional=true}}
	~~'''Type''':~~ [[Types/string]]

	~~'''Default''':~~ "item-limitation.item-not-allowed-in-this-container-item"

	The locale key used when the player attempts to put an item that doesn't match the filter rules into the item-with-inventory.		The locale key used when the player attempts to put an item that doesn't match the filter rules into the item-with-inventory.

	~~===~~ extends_inventory_by_default ~~===~~		{{Prototype property\|extends_inventory_by_default\|[[Types/bool\|bool]]\|false\|optional=true}}
	~~'''Type''':~~ [[Types/bool]]

	~~'''Default''':~~ false

	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.		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.

	~~===~~ insertion_priority_mode ~~===~~		{{Prototype property\|insertion_priority_mode\|[[Types/string\|string]]\|"default"\|optional=true}}
	~~'''Type''':~~ [[Types/string]]

	~~'''Default''':~~ "default"

	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.		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"		insertion_priority_mode = "never"