Prototype/Item: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
m (word)
(0.18.10: stackable, primary_place_result_item, can_be_mod_opened converted to flags)
Line 44: Line 44:
{{Prototype property|subgroup|[[Types/string|string]]|"other"|optional=true}}
{{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").
{{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|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}}
{{Prototype property|flags|[[Types/ItemPrototypeFlags|ItemPrototypeFlags]]|optional=true}}
Specifies some properties of the item.
Specifies some properties of the item.
   flags = { "hidden" }
   flags = { "hidden" }
{{Prototype property|stackable|[[Types/bool|bool]]|true|optional=true}}
{{Prototype property|primary_place_result_item|[[Types/bool|bool]]|false|optional=true}}
{{Prototype property|can_be_mod_opened|[[Types/bool|bool]]|false|optional=true}}
Only works for [[Prototype/SelectionTool]] and derived classes.<br />
This property corresponds to the following event in the lua api: [https://lua-api.factorio.com/latest/events.html#on_mod_item_opened defines.events.on_mod_item_opened]


{{Prototype property|default_request_amount|[[Types/ItemCountType|ItemCountType]]|The stack size of this item.|optional=true}}
{{Prototype property|default_request_amount|[[Types/ItemCountType|ItemCountType]]|The stack size of this item.|optional=true}}
Line 65: Line 66:
{{Prototype property|fuel_value|[[Types/Energy|Energy]]|"0J"|optional=true}}
{{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.
{{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|fuel_acceleration_multiplier|[[Types/double|double]]|1.0|optional=true}}
{{Prototype property|fuel_acceleration_multiplier|[[Types/double|double]]|1.0|optional=true}}
Line 80: Line 75:
{{Prototype property|fuel_glow_color|[[Types/Color|Color]]|<nowiki>{r=0, g=0, b=0, a=1}</nowiki>|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.
{{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|dark_background_icons, dark_background_icon,  icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]|optional=true}}
{{Prototype property|dark_background_icons, dark_background_icon,  icon_size (IconSpecification)|[[Types/IconSpecification|IconSpecification]]|optional=true}}

Revision as of 17:54, 3 March 2020

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

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").

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.

place_as_tile

Type: PlaceAsTile

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.

flags

Type: ItemPrototypeFlags
Specifies some properties of the item.

 flags = { "hidden" }

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

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: table (array) of ItemProductPrototype

rocket_launch_product

Type: ItemProductPrototype