Prototype/Item: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Migrated prototype doc to separate website)
(Removed old prototype docs)
 
(2 intermediate revisions by the same user not shown)
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/ItemPrototype.html https://lua-api.factorio.com/latest/prototypes/ItemPrototype.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/ItemPrototype.html https://lua-api.factorio.com/latest/prototypes/ItemPrototype.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>
 
 
 
{{Prototype parent|PrototypeBase}}
Possible configuration for all items.
 
{{Prototype TOC|item}}
 
== Extensions ==
* [[Prototype/AmmoItem]] '''ammo'''
* [[Prototype/Capsule]] '''capsule'''
* [[Prototype/Gun]] '''gun'''
* [[Prototype/ItemWithEntityData]] '''item-with-entity-data'''
* [[Prototype/ItemWithLabel]] '''item-with-label'''
** [[Prototype/ItemWithInventory]] '''item-with-inventory'''
*** [[Prototype/BlueprintBook]] '''blueprint-book'''
** [[Prototype/ItemWithTags]] '''item-with-tags'''
** [[Prototype/SelectionTool]] '''selection-tool'''
*** [[Prototype/BlueprintItem]] '''blueprint'''
*** [[Prototype/CopyPasteTool]] '''copy-paste-tool'''
*** [[Prototype/DeconstructionItem]] '''deconstruction-item'''
*** [[Prototype/UpgradeItem]] '''upgrade-item'''
* [[Prototype/Module]] '''module'''
* [[Prototype/RailPlanner]] '''rail-planner'''
* [[Prototype/SpidertronRemote]] '''spidertron-remote'''
* [[Prototype/Tool]] '''tool'''
** [[Prototype/Armor]] '''armor'''
** [[Prototype/MiningTool]] '''mining-tool''' (for migration, cannot be used)
** [[Prototype/RepairTool]] '''repair-tool'''
 
== Mandatory properties ==
Inherits all properties from [[PrototypeBase]].
 
{{Prototype property|icons, icon,  icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]}}
 
{{Prototype property|stack_size|[[Types/ItemCountType|ItemCountType]]}}
Count of items of the same name that can be stored in one inventory slot. Must be 1 when the <code>"not-stackable"</code> flag is set.
  stack_size = 64
 
== Optional properties ==
 
{{Prototype property|place_result|[[Types/string|string]]|""|optional=true}}
Name of [[prototype/Entity]] 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 [[Types/ItemPrototypeFlags#"primary-place-result"|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 <code>localised_name</code> on this item, it will be used instead.
  place_result = "wooden-chest"
 
{{Prototype property|placed_as_equipment_result|[[Types/string|string]]|""|optional=true}}
 
{{Prototype property|subgroup|[[Types/string|string]]|"other"|optional=true}}
Name of a [[Prototype/ItemSubGroup]].
 
Empty text of subgroup is not allowed. (You can ommit the definition to get the default "other").
 
{{Prototype property|fuel_category|[[Types/string|string]]|""|optional=true}}
Must exist when a fuel_value is defined. Name of one of the [[Prototype/FuelCategory|fuel categories]].
 
{{Prototype property|burnt_result|[[Types/string|string]]|""|optional=true}}
The item that is the result when this item gets burned as fuel.
 
{{Prototype property|place_as_tile|[[Types/PlaceAsTile|PlaceAsTile]]|optional=true}}
 
{{Prototype property|pictures|[[Types/SpriteVariations|SpriteVariations]]|optional=true}}
Used to give the item multiple different icons so that they look less uniform on belts etc. For inventory icons and similar, <code>icon/icons</code> will be used. Maximum number of variations is 16.
 
{{Prototype property|flags|[[Types/ItemPrototypeFlags|ItemPrototypeFlags]]|optional=true}}
Specifies some properties of the item.
  flags = { "hidden" }
 
{{Prototype property|default_request_amount|[[Types/ItemCountType|ItemCountType]]|The stack size of this item.|optional=true}}
 
{{Prototype property|wire_count|[[Types/ItemCountType|ItemCountType]]|0|optional=true}}
The number of items needed to connect 2 entities with this as wire. In the base game, [[green wire]], [[red wire]] and [[copper cable]] have this set to 1.
 
{{Prototype property|fuel_value|[[Types/Energy|Energy]]|"0J"|optional=true}}
Mandatory when fuel_acceleration_multiplier, fuel_top_speed_multiplier, fuel_emissions_multiplier, or fuel_glow_color are used. Amount of energy it gives when used as fuel.
 
{{Prototype property|fuel_acceleration_multiplier|[[Types/double|double]]|1.0|optional=true}}
 
{{Prototype property|fuel_top_speed_multiplier|[[Types/double|double]]|1.0|optional=true}}
 
{{Prototype property|fuel_emissions_multiplier|[[Types/double|double]]|1.0|optional=true}}
 
{{Prototype property|fuel_glow_color|[[Types/Color|Color]]|<nowiki>{r=0, g=0, b=0, a=1}</nowiki>|optional=true}}
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 [[Prototype/Reactor#use_fuel_glow_color]].
 
{{Prototype property|open_sound|[[Types/Sound|Sound]]|optional=true}}
 
{{Prototype property|close_sound|[[Types/Sound|Sound]]|optional=true}}
 
{{Prototype property|dark_background_icons, dark_background_icon,  icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]|optional=true}}
A dark background sprite. Uses <code>dark_background_icons</code> instead of <code>icons</code> and <code>dark_background_icon</code> instead of <code>icon</code>. Inside <code>dark_background_icons</code>, the property for the file path is <code>dark_background_icon</code> instead of <code>icon</code>.
 
{{Prototype property|rocket_launch_products|[[Types/table|table]] (array) of [[Types/ItemProductPrototype|ItemProductPrototype]]|optional=true}}
 
{{Prototype property|rocket_launch_product|[[Types/ItemProductPrototype|ItemProductPrototype]]|optional=true}}

Latest revision as of 14:32, 25 October 2024

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

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/Item&oldid=202919"