Prototype/Item: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(1.1: added open_sound, close_sound)
m (Refer to primary-place-result on place_result)
Line 38: Line 38:


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



Revision as of 20:03, 21 April 2021

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

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

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.

open_sound

Type: Sound

close_sound

Type: Sound

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_icon instead of icon.

rocket_launch_products

Type: table (array) of ItemProductPrototype

rocket_launch_product

Type: ItemProductPrototype