Prototype/ItemGroup: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
m (→‎order: fixed type)
m (words)
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Basics ==
{{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", "intermediates" and "combat" but mods can define their own. See also [[Prototype/Item#group]].
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.


== Properties ==
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 ===
'''Type''': [[Types/string]]


Must be "item-group".
{{Prototype TOC|item-group}}


=== name ===
== Mandatory properties ==
'''Type''': [[Types/string]]
Inherits all properties from [[PrototypeBase]].


The unique name of this item group.
{{Prototype property|icons, icon, icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]}}
The icon that is shown to represent this item group.


=== icon ===
== Optional properties ==
'''Type''': [[Types/FileName]]
{{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.
The 64x64-pixel icon that is shown to represent this item group.
 
=== order ===
'''Type''': [[Types/Order]]
 
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".

Latest revision as of 17:18, 7 April 2022

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.