Prototype/Item: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Added prototype type to page)
(Removed old prototype docs)
 
(24 intermediate revisions by 5 users not shown)
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/ItemPrototype.html https://lua-api.factorio.com/latest/prototypes/ItemPrototype.html]
Prototype type: '''item'''


Possible configuration for all items
</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>
== Extensions ==
* [[Prototype/AmmoItem]] '''ammo'''
* [[Prototype/Capsule]] '''capsule''' (Capsule such as the combat capsules, but also grenades (and the raw fish).)
* [[Prototype/Gun]] '''gun''' (Ammunition for guns.)
* [[Prototype/ItemWithEntityData]] '''item-with-entity-data''' (Can be used to store arbitrary data using script.)
* [[Prototype/ItemWithLabel]] '''item-with-label''' (Similar to a standard item but with the ability to be labeled.)
** [[Prototype/ItemWithInventory]] '''item-with-inventory''' (An item type that itself has an inventory of other items.)
*** [[Prototype/BlueprintBook]] '''blueprint-book'''
** [[Prototype/ItemWithTags]] '''item-with-tags'''
** [[Prototype/SelectionTool]] '''selection-tool''' (An item type used for selecting entities in the world.)
*** [[Prototype/BlueprintItem]] '''blueprint'''
*** [[Prototype/DeconstructionItem]] '''deconstruction-item'''
* [[Prototype/Module]] '''module'''
* [[Prototype/RailPlanner]] '''rail-planner'''
* [[Prototype/Tool]] '''tool''' (Items with a "durability".)
** [[Prototype/Armor]] '''armor''' (Used as player protection.)
** [[Prototype/MiningTool]] '''mining-tool''' (Used for mining resources and/or as a melee weapon.)
** [[Prototype/RepairTool]] '''repair-tool'''
 
== Mandatory properties ==
Inherits all properties from [[Prototype]].
 
=== icons, icon,  icon_size (IconSpecification) ===
'''Type''': [[Types/IconSpecification]]
 
=== stack_size ===
'''Type''': [[Types/ItemCountType]]
 
Count of items of the same name that can be stored in one inventory slot. Must be 1 when <code>stackable</code> is false.
  stack_size = 64
 
=== flags ===
'''Type''': [[Types/ItemPrototypeFlags]]
 
Specifies some properties of the item.
  flags = { "goes-to-quickbar" }
Possible values are:
{| class="wikitable"
|-
! Item !! meaning
|-
| goes-to-quickbar  || Item is moved to quick bar by default
|-
| goes-to-main-inventory || Item is moved to main inventory by default
|-
| hidden || Item will not appear in lists of all items such as those for logistics requests, filters, etc.
|}
 
== Optional properties ==
=== place_result ===
'''Type''': [[Types/string]]
 
'''Default''': ""
 
Name of [[prototype/Entity]] that can be built using this item
  place_result = "wooden-chest"
 
=== placed_as_equipment_result ===
'''Type''': [[Types/string]]
 
'''Default''': ""
 
=== subgroup ===
'''Type''': [[Types/string]]
 
'''Default''': "other"
 
Empty text of subgroup is not allowed. (You can ommit the definition to get the default "other").
 
=== place_as_tile ===
'''Type''': [[Types/PlaceAsTile]]
 
=== stackable ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== primary_place_result_item ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== can_be_mod_opened ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== default_request_amount ===
'''Type''': [[Types/ItemCountType]]
 
'''Default''': The stack size of this item.
 
=== fuel_category ===
'''Type''': [[Types/string]]
 
'''Default''': ""
 
Must exist when a fuel_value is defined. Name of one of the [[Prototype/FuelCategory|fuel categories]].
 
=== burnt_result ===
'''Type''': [[Types/string]]
 
'''Default''': ""
 
The item that is the result when this item gets burned as fuel.
 
=== fuel_value ===
'''Type''': [[Types/Energy]]
 
'''Default''': "0J"
 
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.
 
=== fuel_acceleration_multiplier ===
'''Type''': [[Types/double]]
 
'''Default''': 1.0
 
=== fuel_top_speed_multiplier ===
'''Type''': [[Types/double]]
 
'''Default''': 1.0
 
=== fuel_emissions_multiplier ===
'''Type''': [[Types/double]]
 
'''Default''': 1.0
 
=== fuel_glow_color ===
'''Type''': [[Types/Color]]
 
'''Default''': {r=0, g=0, b=0, a=1}
 
Colors the glow of the burner energy source when this fuel is burned.
 
=== dark_background_icons, dark_background_icon,  icon_size (IconSpecification) ===
'''Type''': [[Types/IconSpecification]]
 
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_icons</code> instead of <code>icons</code>.
 
=== rocket_launch_products ===
 
=== rocket_launch_product ===

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"