Prototype/Item: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Set prototype parent)
(Converted to SMW format)
Line 1: Line 1:
{{Prototype parent|PrototypeBase}}
{{Prototype parent|PrototypeBase}}
Possible configuration for all items.


==Basics==
{{Prototype TOC|item}}
Prototype type: '''item'''


Possible configuration for all items
== Extensions ==
== Extensions ==
* [[Prototype/AmmoItem]] '''ammo'''
* [[Prototype/AmmoItem]] '''ammo'''
Line 29: Line 28:
Inherits all properties from [[PrototypeBase]].
Inherits all properties from [[PrototypeBase]].


=== icons, icon,  icon_size (IconSpecification) ===
{{Prototype property|icons, icon,  icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]}}
'''Type''': [[Types/IconSpecification]]
 
=== stack_size ===
'''Type''': [[Types/ItemCountType]]


{{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 <code>stackable</code> is false.
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
   stack_size = 64


=== flags ===
{{Prototype property|flags|[[Types/ItemPrototypeFlags|ItemPrototypeFlags]]}}
'''Type''': [[Types/ItemPrototypeFlags]]
 
Specifies some properties of the item.
Specifies some properties of the item.
   flags = { "hidden" }
   flags = { "hidden" }


== Optional properties ==
== Optional properties ==
=== place_result ===
'''Type''': [[Types/string]]
'''Default''': ""


{{Prototype property|place_result|[[Types/string|string]]|""|optional=true}}
Name of [[prototype/Entity]] that can be built using this item
Name of [[prototype/Entity]] that can be built using this item
   place_result = "wooden-chest"
   place_result = "wooden-chest"


=== placed_as_equipment_result ===
{{Prototype property|placed_as_equipment_result|[[Types/string|string]]|""|optional=true}}
'''Type''': [[Types/string]]
 
'''Default''': ""
 
=== subgroup ===
'''Type''': [[Types/string]]
 
'''Default''': "other"


{{Prototype property|subgroup|[[Types/string|string]]|"other"|optional=true}}
Empty text of subgroup is not allowed. (You can ommit the definition to get the default "other").
Empty text of subgroup is not allowed. (You can ommit the definition to get the default "other").


=== place_as_tile ===
{{Prototype property|place_as_tile|[[Types/PlaceAsTile|PlaceAsTile]]|optional=true}}
'''Type''': [[Types/PlaceAsTile]]


=== stackable ===
{{Prototype property|stackable|[[Types/bool|bool]]|true|optional=true}}
'''Type''': [[Types/bool]]


'''Default''': true
{{Prototype property|primary_place_result_item|[[Types/bool|bool]]|false|optional=true}}
 
=== primary_place_result_item ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== can_be_mod_opened ===
'''Type''': [[Types/bool]]
 
'''Default''': false


{{Prototype property|can_be_mod_opened|[[Types/bool|bool]]|false|optional=true}}
Only works for [[Prototype/SelectionTool]] and derived classes.
Only works for [[Prototype/SelectionTool]] and derived classes.


=== default_request_amount ===
{{Prototype property|default_request_amount|[[Types/ItemCountType|ItemCountType]]|The stack size of this item.|optional=true}}
'''Type''': [[Types/ItemCountType]]
 
'''Default''': The stack size of this item.


=== wire_count ===
{{Prototype property|wire_count|[[Types/ItemCountType|ItemCountType]]|0|optional=true}}
'''Type''': [[Types/ItemCountType]]
 
'''Default''': 0
 
=== fuel_value ===
'''Type''': [[Types/Energy]]
 
'''Default''': "0J"


{{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.
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_category ===
{{Prototype property|fuel_category|[[Types/string|string]]|""|optional=true}}
'''Type''': [[Types/string]]
 
'''Default''': ""
 
Must exist when a fuel_value is defined. Name of one of the [[Prototype/FuelCategory|fuel categories]].
Must exist when a fuel_value is defined. Name of one of the [[Prototype/FuelCategory|fuel categories]].


=== burnt_result ===
{{Prototype property|burnt_result|[[Types/string|string]]|""|optional=true}}
'''Type''': [[Types/string]]
 
'''Default''': ""
 
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.


=== fuel_acceleration_multiplier ===
{{Prototype property|fuel_acceleration_multiplier|[[Types/double|double]]|1.0|optional=true}}
'''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 ===
{{Prototype property|fuel_top_speed_multiplier|[[Types/double|double]]|1.0|optional=true}}
'''Type''': [[Types/Color]]


'''Default''': {r=0, g=0, b=0, a=1}
{{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.
Colors the glow of the burner energy source when this fuel is burned.


=== pictures ===
{{Prototype property|pictures|[[Types/SpriteVariations|SpriteVariations]]|optional=true}}
'''Type''': [[Types/SpriteVariations]]
 
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.
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.


=== dark_background_icons, dark_background_icon,  icon_size (IconSpecification) ===
{{Prototype property|dark_background_icons, dark_background_icon,  icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]|optional=true}}
'''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>.
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 ===
{{Prototype property|rocket_launch_products|[[Types/table]] (array) of [[Types/ItemProductPrototype|table]] (array) of [[Types/ItemProductPrototype]]|optional=true}}
'''Type''': [[Types/table]] (array) of [[Types/ItemProductPrototype]]


=== rocket_launch_product ===
{{Prototype property|rocket_launch_product|[[Types/ItemProductPrototype|ItemProductPrototype]]|optional=true}}
'''Type''': [[Types/ItemProductPrototype]]

Revision as of 15:06, 26 July 2019

Prototype definitions » PrototypeBase » Prototype/Item


Possible configuration for all items.


Prototype/Item — item
icons, icon, icon_size (IconSpecification)::IconSpecification
stack_size::ItemCountType
burnt_result::string (optional)
close_sound::Sound (optional)
dark_background_icons, dark_background_icon, icon_size (IconSpecification)::IconSpecification (optional)
default_request_amount::ItemCountType (optional)
flags::ItemPrototypeFlags (optional)
fuel_acceleration_multiplier::double (optional)
fuel_category::string (optional)
fuel_emissions_multiplier::double (optional)
fuel_glow_color::Color (optional)
fuel_top_speed_multiplier::double (optional)
fuel_value::Energy (optional)
open_sound::Sound (optional)
pictures::SpriteVariations (optional)
place_as_tile::PlaceAsTile (optional)
place_result::string (optional)
placed_as_equipment_result::string (optional)
rocket_launch_product::ItemProductPrototype (optional)
rocket_launch_products::table (array) of ItemProductPrototype (optional)
subgroup::string (optional)
wire_count::ItemCountType (optional)
Inherited from PrototypeBase
name::string
type::string
localised_description::LocalisedString (optional)
localised_name::LocalisedString (optional)
order::Order (optional)

Extensions

Mandatory properties

Inherits all properties from PrototypeBase.

icons, icon, icon_size (IconSpecification)

Type: IconSpecification

stack_size

Type: ItemCountType
Count of items of the same name that can be stored in one inventory slot. Must be 1 when stackable is false. 

 stack_size = 64

flags

Type: ItemPrototypeFlags
Specifies some properties of the item. 

 flags = { "hidden" }

Optional properties

place_result

Type: string
Default: ""
Name of prototype/Entity that can be built using this item 

 place_result = "wooden-chest"

placed_as_equipment_result

Type: string
Default: ""

subgroup

Type: string
Default: "other"
Empty text of subgroup is not allowed. (You can ommit the definition to get the default "other").

place_as_tile

Type: PlaceAsTile

stackable

Type: bool
Default: true

primary_place_result_item

Type: bool
Default: false

can_be_mod_opened

Type: bool
Default: false
Only works for Prototype/SelectionTool and derived classes.

default_request_amount

Type: ItemCountType
Default: The stack size of this item.

wire_count

Type: ItemCountType
Default: 0

fuel_value

Type: 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_category

Type: string
Default: ""
Must exist when a fuel_value is defined. Name of one of the fuel categories.

burnt_result

Type: string
Default: ""
The item that is the result when this item gets burned as fuel.

fuel_acceleration_multiplier

Type: double
Default: 1.0

fuel_top_speed_multiplier

Type: double
Default: 1.0

fuel_emissions_multiplier

Type: double
Default: 1.0

fuel_glow_color

Type: Color
Default: {r=0, g=0, b=0, a=1}
Colors the glow of the burner energy source when this fuel is burned.

pictures

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

dark_background_icons, dark_background_icon, icon_size (IconSpecification)

Type: IconSpecification
A dark background sprite. Uses dark_background_icons instead of icons and dark_background_icon instead of icon. Inside dark_background_icons, the property for the file path is dark_background_icons instead of icons.

rocket_launch_products

Type: Types/table (array) of table (array) of Types/ItemProductPrototype

rocket_launch_product

Type: ItemProductPrototype

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