ItemPrototype - Prototype Docs

Home / Prototypes / ItemPrototype><

ItemPrototype 'item'

Possible configuration for all items.

Inherits from Prototype « PrototypeBase

Children

AmmoItemPrototype - 'ammo'
CapsulePrototype - 'capsule'
GunPrototype - 'gun'
ItemWithEntityDataPrototype - 'item-with-entity-data'
ItemWithLabelPrototype - 'item-with-label'
- ItemWithInventoryPrototype - 'item-with-inventory'
  - BlueprintBookPrototype - 'blueprint-book'
- ItemWithTagsPrototype - 'item-with-tags'
- SelectionToolPrototype - 'selection-tool'
  - BlueprintItemPrototype - 'blueprint'
  - CopyPasteToolPrototype - 'copy-paste-tool'
  - DeconstructionItemPrototype - 'deconstruction-item'
  - SpidertronRemotePrototype - 'spidertron-remote'
  - UpgradeItemPrototype - 'upgrade-item'
ModulePrototype - 'module'
RailPlannerPrototype - 'rail-planner'
SpacePlatformStarterPackPrototype - 'space-platform-starter-pack'
ToolPrototype - 'tool'
- ArmorPrototype - 'armor'
- RepairToolPrototype - 'repair-tool'

Properties

default

sorted

stack_size	:: ItemCountType	Count of items of the same name that can be stored in one inventory slot. [...]
Count of items of the same name that can be stored in one inventory slot. [...]
icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
icon optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
dark_background_icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
dark_background_icon optional	:: FileName	If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
dark_background_icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
place_result optional	:: EntityID	Name of the EntityPrototype that can be built using this item. [...]
Name of the EntityPrototype that can be built using this item. [...]
place_as_equipment_result optional	:: EquipmentID
fuel_category optional	:: FuelCategoryID	Must exist when a nonzero fuel_value is defined.
Must exist when a nonzero fuel_value is defined.
burnt_result optional	:: ItemID	The item that is the result when this item gets burned as fuel.
The item that is the result when this item gets burned as fuel.
spoil_result optional	:: ItemID
plant_result optional	:: EntityID
place_as_tile optional	:: PlaceAsTile
pictures optional	:: SpriteVariations	Used to give the item multiple different icons so that they look less uniform on belts. [...]
Used to give the item multiple different icons so that they look less uniform on belts. [...]
flags optional	:: ItemPrototypeFlags	Specifies some properties of the item.
Specifies some properties of the item.
spoil_ticks optional	:: uint32
fuel_value optional	:: Energy	Amount of energy the item gives when used as fuel. [...]
Amount of energy the item gives when used as fuel. [...]
fuel_acceleration_multiplier optional	:: double	Must be 0 or positive.
Must be 0 or positive.
fuel_top_speed_multiplier optional	:: double	Must be 0 or positive.
Must be 0 or positive.
fuel_emissions_multiplier optional	:: double
fuel_acceleration_multiplier_quality_bonus optional	:: double	Additional fuel acceleration multiplier per quality level. [...]
Additional fuel acceleration multiplier per quality level. [...]
fuel_top_speed_multiplier_quality_bonus optional	:: double	Additional fuel top speed multiplier per quality level. [...]
Additional fuel top speed multiplier per quality level. [...]
weight optional	:: Weight	The default weight is calculated automatically from recipes and falls back to UtilityConstants::default_item_weight. [...]
The default weight is calculated automatically from recipes and falls back to UtilityConstants::default_item_weight. [...]
ingredient_to_weight_coefficient optional	:: double
fuel_glow_color optional	:: Color	Colors the glow of the burner energy source when this fuel is burned. [...]
Colors the glow of the burner energy source when this fuel is burned. [...]
open_sound optional	:: Sound
close_sound optional	:: Sound
pick_sound optional	:: Sound
drop_sound optional	:: Sound
inventory_move_sound optional	:: Sound
default_import_location optional	:: SpaceLocationID
color_hint optional	:: ColorHintSpecification	Only used by hidden setting, support may be limited.
Only used by hidden setting, support may be limited.
has_random_tint optional	:: boolean
spoil_to_trigger_result optional	:: SpoilToTriggerResult
destroyed_by_dropping_trigger optional	:: Trigger	The effect/trigger that happens when an item is destroyed by being dropped on a TilePrototype marked as destroying dropped items. [...]
The effect/trigger that happens when an item is destroyed by being dropped on a TilePrototype marked as destroying dropped items. [...]
rocket_launch_products optional	:: array[ItemProductPrototype]
send_to_orbit_mode optional	:: SendToOrbitMode	The way this item works when we try to send it to the orbit on its own. [...]
The way this item works when we try to send it to the orbit on its own. [...]
moved_to_hub_when_building optional	:: boolean	Whether this item should be moved to the hub when space platform performs building, upgrade or deconstruction and is left with this item. [...]
Whether this item should be moved to the hub when space platform performs building, upgrade or deconstruction and is left with this item. [...]
random_tint_color optional	:: Color	Randomly tints item instances on belts and in the world. [...]
Randomly tints item instances on belts and in the world. [...]
spoil_level optional	:: uint8	Used by Inserters with spoil priority. [...]
Used by Inserters with spoil priority. [...]
auto_recycle optional	:: boolean	Whether the item should be included in the self-recycling recipes automatically generated by the quality mod. [...]
Whether the item should be included in the self-recycling recipes automatically generated by the quality mod. [...]

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.

stack_size	:: ItemCountType	Count of items of the same name that can be stored in one inventory slot. [...]
Count of items of the same name that can be stored in one inventory slot. [...]
auto_recycle optional	:: boolean	Whether the item should be included in the self-recycling recipes automatically generated by the quality mod. [...]
Whether the item should be included in the self-recycling recipes automatically generated by the quality mod. [...]
burnt_result optional	:: ItemID	The item that is the result when this item gets burned as fuel.
The item that is the result when this item gets burned as fuel.
close_sound optional	:: Sound
color_hint optional	:: ColorHintSpecification	Only used by hidden setting, support may be limited.
Only used by hidden setting, support may be limited.
dark_background_icon optional	:: FileName	If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
dark_background_icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
dark_background_icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
default_import_location optional	:: SpaceLocationID
destroyed_by_dropping_trigger optional	:: Trigger	The effect/trigger that happens when an item is destroyed by being dropped on a TilePrototype marked as destroying dropped items. [...]
The effect/trigger that happens when an item is destroyed by being dropped on a TilePrototype marked as destroying dropped items. [...]
drop_sound optional	:: Sound
flags optional	:: ItemPrototypeFlags	Specifies some properties of the item.
Specifies some properties of the item.
fuel_acceleration_multiplier optional	:: double	Must be 0 or positive.
Must be 0 or positive.
fuel_acceleration_multiplier_quality_bonus optional	:: double	Additional fuel acceleration multiplier per quality level. [...]
Additional fuel acceleration multiplier per quality level. [...]
fuel_category optional	:: FuelCategoryID	Must exist when a nonzero fuel_value is defined.
Must exist when a nonzero fuel_value is defined.
fuel_emissions_multiplier optional	:: double
fuel_glow_color optional	:: Color	Colors the glow of the burner energy source when this fuel is burned. [...]
Colors the glow of the burner energy source when this fuel is burned. [...]
fuel_top_speed_multiplier optional	:: double	Must be 0 or positive.
Must be 0 or positive.
fuel_top_speed_multiplier_quality_bonus optional	:: double	Additional fuel top speed multiplier per quality level. [...]
Additional fuel top speed multiplier per quality level. [...]
fuel_value optional	:: Energy	Amount of energy the item gives when used as fuel. [...]
Amount of energy the item gives when used as fuel. [...]
has_random_tint optional	:: boolean
icon optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
ingredient_to_weight_coefficient optional	:: double
inventory_move_sound optional	:: Sound
moved_to_hub_when_building optional	:: boolean	Whether this item should be moved to the hub when space platform performs building, upgrade or deconstruction and is left with this item. [...]
Whether this item should be moved to the hub when space platform performs building, upgrade or deconstruction and is left with this item. [...]
open_sound optional	:: Sound
pick_sound optional	:: Sound
pictures optional	:: SpriteVariations	Used to give the item multiple different icons so that they look less uniform on belts. [...]
Used to give the item multiple different icons so that they look less uniform on belts. [...]
place_as_equipment_result optional	:: EquipmentID
place_as_tile optional	:: PlaceAsTile
place_result optional	:: EntityID	Name of the EntityPrototype that can be built using this item. [...]
Name of the EntityPrototype that can be built using this item. [...]
plant_result optional	:: EntityID
random_tint_color optional	:: Color	Randomly tints item instances on belts and in the world. [...]
Randomly tints item instances on belts and in the world. [...]
rocket_launch_products optional	:: array[ItemProductPrototype]
send_to_orbit_mode optional	:: SendToOrbitMode	The way this item works when we try to send it to the orbit on its own. [...]
The way this item works when we try to send it to the orbit on its own. [...]
spoil_level optional	:: uint8	Used by Inserters with spoil priority. [...]
Used by Inserters with spoil priority. [...]
spoil_result optional	:: ItemID
spoil_ticks optional	:: uint32
spoil_to_trigger_result optional	:: SpoilToTriggerResult
weight optional	:: Weight	The default weight is calculated automatically from recipes and falls back to UtilityConstants::default_item_weight. [...]
The default weight is calculated automatically from recipes and falls back to UtilityConstants::default_item_weight. [...]

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

stack_size :: ItemCountType

Count of items of the same name that can be stored in one inventory slot. Must be 1 when the "not-stackable" flag is set.

Example

stack_size = 64

icons :: array[IconData] optional

Can't be an empty array.

icon :: FileName optional

Path to the icon file.

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.

Only loaded if icons is not defined.

dark_background_icons :: array[IconData] optional

Can't be an empty array.

dark_background_icon :: FileName optional

If this is set, it is used to show items in alt-mode instead of the normal item icon. This can be useful to increase the contrast of the icon with the dark alt-mode icon outline.

Path to the icon file.

Only loaded if dark_background_icons is not defined.

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

Only loaded if dark_background_icons is not defined.

place_result :: EntityID optional

Default: ""

Name of the EntityPrototype that can be built using this item. If this item should be the one that construction bots use to build the specified place_result, set the "primary-place-result" item flag.

The localised name of the entity will be used as the in-game item name. This behavior can be overwritten by specifying localised_name on this item, it will be used instead.

Example

place_result = "wooden-chest"

place_as_equipment_result :: EquipmentID optional

Default: ""

fuel_category :: FuelCategoryID optional

Default: ""

Must exist when a nonzero fuel_value is defined.

burnt_result :: ItemID optional

Default: ""

The item that is the result when this item gets burned as fuel.

spoil_result :: ItemID optional

plant_result :: EntityID optional

place_as_tile :: PlaceAsTile optional

PlaceAsTile :: struct

Properties

result :: TileID

condition :: CollisionMaskConnector

invert :: boolean optional

Default: false

condition_size :: uint32

tile_condition :: array[TileID] optional

pictures :: SpriteVariations optional

Used to give the item multiple different icons so that they look less uniform on belts. For inventory icons and similar, icon/icons will be used. Maximum number of variations is 16.

When using sprites of size 64 (same as base game icons), the scale should be set to 0.5.

flags :: ItemPrototypeFlags optional

Specifies some properties of the item.

Example

flags = { "hide-from-bonus-gui" }

spoil_ticks :: uint32 optional

Default: 0

fuel_value :: Energy optional

Default: "0J"

Amount of energy the item gives when used as fuel.

Mandatory if fuel_acceleration_multiplier, fuel_top_speed_multiplier or fuel_emissions_multiplier or fuel_glow_color are used.

Example

fuel_value = "12MJ"

fuel_acceleration_multiplier :: double optional

Default: 1.0

Must be 0 or positive.

fuel_top_speed_multiplier :: double optional

Default: 1.0

Must be 0 or positive.

fuel_emissions_multiplier :: double optional

Default: 1.0

fuel_acceleration_multiplier_quality_bonus :: double optional

Additional fuel acceleration multiplier per quality level. Defaults to 30% of fuel_acceleration_multiplier - 1 if fuel_acceleration_multiplier is larger than 1. Otherwise defaults to 0.

Must be 0 or positive.

fuel_top_speed_multiplier_quality_bonus :: double optional

Additional fuel top speed multiplier per quality level. Defaults to 30% of fuel_top_speed_multiplier - 1 if fuel_top_speed_multiplier is larger than 1. Otherwise defaults to 0.

Must be 0 or positive.

weight :: Weight optional

The default weight is calculated automatically from recipes and falls back to UtilityConstants::default_item_weight.

More information on how item weight is determined can be found on its auxiliary page.

ingredient_to_weight_coefficient :: double optional

Default: 0.5

fuel_glow_color :: Color optional

Colors the glow of the burner energy source when this fuel is burned. Can also be used to color the glow of reactors burning the fuel, see ReactorPrototype::use_fuel_glow_color.

open_sound :: Sound optional

close_sound :: Sound optional

pick_sound :: Sound optional

drop_sound :: Sound optional

inventory_move_sound :: Sound optional

default_import_location :: SpaceLocationID optional

Default: "nauvis"

color_hint :: ColorHintSpecification optional

Only used by hidden setting, support may be limited.

has_random_tint :: boolean optional

Default: true

spoil_to_trigger_result :: SpoilToTriggerResult optional

destroyed_by_dropping_trigger :: Trigger optional

The effect/trigger that happens when an item is destroyed by being dropped on a TilePrototype marked as destroying dropped items.

This overrides the TilePrototype::default_destroyed_dropped_item_trigger from the tile.

rocket_launch_products :: array[ItemProductPrototype] optional

send_to_orbit_mode :: SendToOrbitMode optional

Default: "not-sendable"

The way this item works when we try to send it to the orbit on its own.

When "manual" is set, it can only be launched by pressing the launch button in the rocket silo.

When "automated" is set, it will force the existence of "launch to orbit automatically" checkbox in the rocket silo which will then force the silo to automatically send the item to orbit when present.

moved_to_hub_when_building :: boolean optional

Whether this item should be moved to the hub when space platform performs building, upgrade or deconstruction and is left with this item. The following items are considered valuable and moved to hub by default: Modules, items that build entities, items that build tiles and items not obtainable from asteroid chunks that have subgroup from a group other than "intermediate-products".

random_tint_color :: Color optional

Default: Value of UtilityConstants::item_default_random_tint_strength

Randomly tints item instances on belts and in the world. 0 no tinting. 1 full tint.

spoil_level :: uint8 optional

Default: 0

Used by Inserters with spoil priority. Item with higher spoil level is considered more spoiled than item with lower spoil level regardless of progress of spoiling.

auto_recycle :: boolean optional

Default: true

Whether the item should be included in the self-recycling recipes automatically generated by the quality mod.

This property is not read by the game engine itself, but the quality mod's data-updates.lua file. This means it is discarded by the game engine after loading finishes.

Factorio Prototype DocsVersion 2.0.55

ItemPrototype 'item'

Properties

Properties

stack_size :: ItemCountType

Example

icons :: array[IconData] optional

icon :: FileName optional

icon_size :: SpriteSizeType optional

dark_background_icons :: array[IconData] optional

dark_background_icon :: FileName optional

dark_background_icon_size :: SpriteSizeType optional

place_result :: EntityID optional

Example

place_as_equipment_result :: EquipmentID optional

fuel_category :: FuelCategoryID optional

burnt_result :: ItemID optional

spoil_result :: ItemID optional

plant_result :: EntityID optional

place_as_tile :: PlaceAsTile optional

PlaceAsTile :: struct

Properties

result :: TileID

condition :: CollisionMaskConnector

invert :: boolean optional

condition_size :: uint32

tile_condition :: array[TileID] optional

pictures :: SpriteVariations optional

flags :: ItemPrototypeFlags optional

Example

spoil_ticks :: uint32 optional

fuel_value :: Energy optional

Example

fuel_acceleration_multiplier :: double optional

fuel_top_speed_multiplier :: double optional

fuel_emissions_multiplier :: double optional

fuel_acceleration_multiplier_quality_bonus :: double optional

fuel_top_speed_multiplier_quality_bonus :: double optional

weight :: Weight optional

ingredient_to_weight_coefficient :: double optional

fuel_glow_color :: Color optional

open_sound :: Sound optional

close_sound :: Sound optional

pick_sound :: Sound optional

drop_sound :: Sound optional

inventory_move_sound :: Sound optional

default_import_location :: SpaceLocationID optional

color_hint :: ColorHintSpecification optional

has_random_tint :: boolean optional

spoil_to_trigger_result :: SpoilToTriggerResult optional

destroyed_by_dropping_trigger :: Trigger optional

rocket_launch_products :: array[ItemProductPrototype] optional

send_to_orbit_mode :: SendToOrbitMode optional

moved_to_hub_when_building :: boolean optional

random_tint_color :: Color optional

spoil_level :: uint8 optional

auto_recycle :: boolean optional

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.0.55