Prototype/ItemGroup: Difference between revisions

Latest revision as of 10:43, 21 September 2023

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

Prototype definitions » PrototypeBase » Prototype/ItemGroup

An item group. Item groups are shown above the list of craftable items in the player's inventory. The built-in groups are "logistics", "production", "intermediate-products" and "combat" but mods can define their own. Only 255 instances of this prototype may be defined.

Items are sorted into item groups by sorting them into a subgroup which then belongs to a item group.

Prototype/ItemGroup — `item-group`
icons, icon, icon_size (IconSpecification)	::	IconSpecification
order_in_recipe	::	Order (optional)
Inherited from PrototypeBase
name	::	string
type	::	string
localised_description	::	LocalisedString (optional)
localised_name	::	LocalisedString (optional)
order	::	Order (optional)

Mandatory properties

Inherits all properties from PrototypeBase.

icons, icon, icon_size (IconSpecification)

Type: IconSpecification
The icon that is shown to represent this item group.

Optional properties

order_in_recipe

Type: Order
Default: The order of this item group.
Item ingredients in recipes are ordered by item group. The order_in_recipe property can be used to specify the ordering in recipes without affecting the inventory order.

@@ Line 1: / Line 1: @@
-== Basics ==
+<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/ItemGroup.html https://lua-api.factorio.com/latest/prototypes/ItemGroup.html]
-An item group. Item groups are shown above the list of craftable items in the player's inventory. The built-in groups are "logistics", "production", "energy" and "combat" but mods can define their own. See also [[Prototype/Item#group]].
-== Properties ==
+</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>
-=== type ===
-'''Type''': [[Types/string]]
-Must be "item-group".
-=== name ===
-'''Type''': [[Types/string]]
-The unique name of this item group.
+{{Prototype parent|PrototypeBase}}
+An item group. Item groups are shown above the list of craftable items in the player's inventory. The built-in groups are "logistics", "production", "intermediate-products" and "combat" but mods can define their own. Only 255 instances of this prototype may be defined.
-=== icon ===
+Items are sorted into item groups by sorting them into a [[Prototype/Item#subgroup|subgroup]] which then belongs to a [[Prototype/ItemSubGroup#group|item group]].
-'''Type''': [[Types/FileName]]
-The 64x64-pixel icon that is shown to represent this item group.
+{{Prototype TOC|item-group}}
-=== order ===
+== Mandatory properties ==
-'''Type''': [[Types/string]]
+Inherits all properties from [[PrototypeBase]].
-Item groups are sorted according to this field. An item group with order="a" will always be displayed before an item group with order="b".
+{{Prototype property|icons, icon, icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]}}
+The icon that is shown to represent this item group.
+== Optional properties ==
+{{Prototype property|order_in_recipe|[[Types/Order|Order]]|The <code>order</code> of this item group.|optional=true}}
+Item ingredients in recipes are ordered by item group. The <code>order_in_recipe</code> property can be used to specify the ordering in recipes without affecting the inventory order.