Prototype/Item: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Added prototype type to page)
(0.17)
Line 5: Line 5:
== Extensions ==
== Extensions ==
* [[Prototype/AmmoItem]] '''ammo'''
* [[Prototype/AmmoItem]] '''ammo'''
* [[Prototype/Capsule]] '''capsule''' (Capsule such as the combat capsules, but also grenades (and the raw fish).)
* [[Prototype/Capsule]] '''capsule'''
* [[Prototype/Gun]] '''gun''' (Ammunition for guns.)
* [[Prototype/Gun]] '''gun'''
* [[Prototype/ItemWithEntityData]] '''item-with-entity-data''' (Can be used to store arbitrary data using script.)
* [[Prototype/ItemWithEntityData]] '''item-with-entity-data'''
* [[Prototype/ItemWithLabel]] '''item-with-label''' (Similar to a standard item but with the ability to be labeled.)
* [[Prototype/ItemWithLabel]] '''item-with-label'''
** [[Prototype/ItemWithInventory]] '''item-with-inventory''' (An item type that itself has an inventory of other items.)
** [[Prototype/ItemWithInventory]] '''item-with-inventory'''
*** [[Prototype/BlueprintBook]] '''blueprint-book'''
*** [[Prototype/BlueprintBook]] '''blueprint-book'''
** [[Prototype/ItemWithTags]] '''item-with-tags'''
** [[Prototype/ItemWithTags]] '''item-with-tags'''
** [[Prototype/SelectionTool]] '''selection-tool''' (An item type used for selecting entities in the world.)
** [[Prototype/SelectionTool]] '''selection-tool'''
*** [[Prototype/BlueprintItem]] '''blueprint'''
*** [[Prototype/BlueprintItem]] '''blueprint'''
*** [[Prototype/CopyPasteTool]] '''copy-paste-tool'''
*** [[Prototype/DeconstructionItem]] '''deconstruction-item'''
*** [[Prototype/DeconstructionItem]] '''deconstruction-item'''
*** [[Prototype/UpgradeItem]] '''upgrade-item'''
* [[Prototype/Module]] '''module'''
* [[Prototype/Module]] '''module'''
* [[Prototype/RailPlanner]] '''rail-planner'''
* [[Prototype/RailPlanner]] '''rail-planner'''
* [[Prototype/Tool]] '''tool''' (Items with a "durability".)
* [[Prototype/Tool]] '''tool'''
** [[Prototype/Armor]] '''armor''' (Used as player protection.)
** [[Prototype/Armor]] '''armor'''
** [[Prototype/MiningTool]] '''mining-tool''' (Used for mining resources and/or as a melee weapon.)
** [[Prototype/MiningTool]] '''mining-tool''' (for migration, cannot be used)
** [[Prototype/RepairTool]] '''repair-tool'''
** [[Prototype/RepairTool]] '''repair-tool'''


Line 38: Line 40:


Specifies some properties of the item.
Specifies some properties of the item.
   flags = { "goes-to-quickbar" }
   flags = { "hidden" }
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 ==
== Optional properties ==
Line 94: Line 85:


'''Default''': The stack size of this item.
'''Default''': The stack size of this item.
=== wire_count ===
'''Type''': [[Types/ItemCountType]]
'''Default''': 0
=== 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_category ===
=== fuel_category ===
Line 108: Line 111:


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_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 ===
=== fuel_acceleration_multiplier ===
Line 144: Line 140:


=== rocket_launch_products ===
=== rocket_launch_products ===
'''Type''': [[Types/table]] (array) of [[Types/ItemProductPrototype]]


=== rocket_launch_product ===
=== rocket_launch_product ===
'''Type''': [[Types/ItemProductPrototype]]

Revision as of 14:43, 11 March 2019

Basics

Prototype type: item

Possible configuration for all items

Extensions

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 stackable is false.

 stack_size = 64

flags

Type: Types/ItemPrototypeFlags

Specifies some properties of the item.

 flags = { "hidden" }

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.

wire_count

Type: Types/ItemCountType

Default: 0

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_category

Type: Types/string

Default: ""

Must exist when a fuel_value is defined. Name of one of the fuel categories.

burnt_result

Type: Types/string

Default: ""

The item that is the result when this item gets burned 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 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 Types/ItemProductPrototype

rocket_launch_product

Type: Types/ItemProductPrototype