ItemGroup - Prototype Docs

ItemGroup 'item-group' Example code

An item group. Item groups are the tabs shown above the list of craftable items in the player's inventory GUI. The built-in groups are "logistics", "production", "intermediate-products" and "combat" but mods can define their own.

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

Prototype limited to 255 total instances.

Inherits from Prototype « PrototypeBase

Properties

default

sorted

icons optional	:: array[IconData]	The icon that is shown to represent this item group. [...]
The icon that is shown to represent this item group. [...]
icon optional	:: FileName	Path to the icon that is shown to represent this item group. [...]
Path to the icon that is shown to represent this item group. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
order_in_recipe optional	:: Order	Item ingredients in recipes are ordered by item group. [...]
Item ingredients in recipes are ordered by item group. [...]

Inherited from Prototype

factoriopedia_alternative optional	:: string	The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]

Inherited from PrototypeBase

type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
factoriopedia_description optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroup optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.
hidden optional	:: boolean
hidden_in_factoriopedia optional	:: boolean
parameter optional	:: boolean	Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
factoriopedia_simulation optional	:: SimulationDefinition	The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.

icon optional	:: FileName	Path to the icon that is shown to represent this item group. [...]
Path to the icon that is shown to represent this item group. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
icons optional	:: array[IconData]	The icon that is shown to represent this item group. [...]
The icon that is shown to represent this item group. [...]
order_in_recipe optional	:: Order	Item ingredients in recipes are ordered by item group. [...]
Item ingredients in recipes are ordered by item group. [...]

Inherited from Prototype

factoriopedia_alternative optional	:: string	The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]

Inherited from PrototypeBase

name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
factoriopedia_description optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
factoriopedia_simulation optional	:: SimulationDefinition	The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.
hidden optional	:: boolean
hidden_in_factoriopedia optional	:: boolean
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
parameter optional	:: boolean	Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
subgroup optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.

Properties

icons :: array[IconData] optional

The icon that is shown to represent this item group. Can't be an empty array.

icon :: FileName optional

Path to the icon that is shown to represent this item group.

Mandatory if icons is not defined.

icon_size :: SpriteSizeType optional

Default: 64

The size of the square icon, in pixels. E.g. 32 for a 32px by 32px icon. Must be larger than 0.

The base game uses 128px icons for item groups.

Only loaded if icons is not defined.

order_in_recipe :: Order optional

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.

Example

{
  type = "item-group",
  name = "logistics",
  order = "a",
  icon = "__base__/graphics/item-group/logistics.png",
  icon_size = 128,
}

Prototypes - Types - Defines - Inheritance

Factorio Prototype DocsVersion 2.0.55

ItemGroup 'item-group' Example code

Properties

Properties

icons :: array[IconData] optional

icon :: FileName optional

icon_size :: SpriteSizeType optional

order_in_recipe :: Order optional

Example

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.0.55