ToolPrototype - Prototype Docs

Home / Prototypes / ToolPrototype><

ToolPrototype - 'tool'

Items with a "durability". Used for science packs.

Inherits from ItemPrototype « PrototypeBase

Children

ArmorPrototype - 'armor'
MiningToolPrototype - 'mining-tool'
RepairToolPrototype - 'repair-tool'

Properties

default

sorted

durability optional	:: double	The durability of this tool. [...]
The durability of this tool. [...]
durability_description_key optional	:: string	May not be longer than 200 characters.
May not be longer than 200 characters.
durability_description_value optional	:: string	May not be longer than 200 characters. [...]
May not be longer than 200 characters. [...]
infinite optional	:: bool	Whether this tool has infinite durability. [...]
Whether this tool has infinite durability. [...]

Inherited from ItemPrototype

stack_size	:: ItemCountType	Count of items of the same name that can be stored in one inventory slot. [...]
Count of items of the same name that can be stored in one inventory slot. [...]
icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
icon optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
icon_mipmaps optional	:: IconMipMapType	Icons of reduced size will be used at decreased scale. [...]
Icons of reduced size will be used at decreased scale. [...]
dark_background_icons optional	:: array[IconData]	Inside IconData, the property for the file path is `dark_background_icon` instead of `icon`. [...]
Inside IconData, the property for the file path is `dark_background_icon` instead of `icon`. [...]
dark_background_icon optional	:: FileName	If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
place_result optional	:: EntityID	Name of the EntityPrototype that can be built using this item. [...]
Name of the EntityPrototype that can be built using this item. [...]
placed_as_equipment_result optional	:: EquipmentID
subgroup optional	:: ItemSubGroupID	The name of the subgroup this item should be sorted into in item selection GUIs like logistic requests. [...]
The name of the subgroup this item should be sorted into in item selection GUIs like logistic requests. [...]
fuel_category optional	:: FuelCategoryID	Must exist when a nonzero fuel_value is defined.
Must exist when a nonzero fuel_value is defined.
burnt_result optional	:: ItemID	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.
place_as_tile optional	:: PlaceAsTile
pictures optional	:: SpriteVariations	Used to give the item multiple different icons so that they look less uniform on belts. [...]
Used to give the item multiple different icons so that they look less uniform on belts. [...]
flags optional	:: ItemPrototypeFlags	Specifies some properties of the item.
Specifies some properties of the item.
default_request_amount optional	:: ItemCountType
wire_count optional	:: ItemCountType	The number of items needed to connect 2 entities with this as wire. [...]
The number of items needed to connect 2 entities with this as wire. [...]
fuel_value optional	:: Energy	Amount of energy the item gives when used as fuel. [...]
Amount of energy the item gives when used as fuel. [...]
fuel_acceleration_multiplier optional	:: double
fuel_top_speed_multiplier optional	:: double
fuel_emissions_multiplier optional	:: double
fuel_glow_color optional	:: Color	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. [...]
open_sound optional	:: Sound
close_sound optional	:: Sound
rocket_launch_products optional	:: array[ItemProductPrototype]
rocket_launch_product optional	:: ItemProductPrototype	Only loaded if `rocket_launch_products` is not defined.
Only loaded if `rocket_launch_products` is not defined.

Inherited from PrototypeBase

type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]

durability optional	:: double	The durability of this tool. [...]
The durability of this tool. [...]
durability_description_key optional	:: string	May not be longer than 200 characters.
May not be longer than 200 characters.
durability_description_value optional	:: string	May not be longer than 200 characters. [...]
May not be longer than 200 characters. [...]
infinite optional	:: bool	Whether this tool has infinite durability. [...]
Whether this tool has infinite durability. [...]

Inherited from ItemPrototype

stack_size	:: ItemCountType	Count of items of the same name that can be stored in one inventory slot. [...]
Count of items of the same name that can be stored in one inventory slot. [...]
burnt_result optional	:: ItemID	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.
close_sound optional	:: Sound
dark_background_icon optional	:: FileName	If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
If this is set, it is used to show items in alt-mode instead of the normal item icon. [...]
dark_background_icons optional	:: array[IconData]	Inside IconData, the property for the file path is `dark_background_icon` instead of `icon`. [...]
Inside IconData, the property for the file path is `dark_background_icon` instead of `icon`. [...]
default_request_amount optional	:: ItemCountType
flags optional	:: ItemPrototypeFlags	Specifies some properties of the item.
Specifies some properties of the item.
fuel_acceleration_multiplier optional	:: double
fuel_category optional	:: FuelCategoryID	Must exist when a nonzero fuel_value is defined.
Must exist when a nonzero fuel_value is defined.
fuel_emissions_multiplier optional	:: double
fuel_glow_color optional	:: Color	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. [...]
fuel_top_speed_multiplier optional	:: double
fuel_value optional	:: Energy	Amount of energy the item gives when used as fuel. [...]
Amount of energy the item gives when used as fuel. [...]
icon optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_mipmaps optional	:: IconMipMapType	Icons of reduced size will be used at decreased scale. [...]
Icons of reduced size will be used at decreased scale. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
open_sound optional	:: Sound
pictures optional	:: SpriteVariations	Used to give the item multiple different icons so that they look less uniform on belts. [...]
Used to give the item multiple different icons so that they look less uniform on belts. [...]
place_as_tile optional	:: PlaceAsTile
place_result optional	:: EntityID	Name of the EntityPrototype that can be built using this item. [...]
Name of the EntityPrototype that can be built using this item. [...]
placed_as_equipment_result optional	:: EquipmentID
rocket_launch_product optional	:: ItemProductPrototype	Only loaded if `rocket_launch_products` is not defined.
Only loaded if `rocket_launch_products` is not defined.
rocket_launch_products optional	:: array[ItemProductPrototype]
subgroup optional	:: ItemSubGroupID	The name of the subgroup this item should be sorted into in item selection GUIs like logistic requests. [...]
The name of the subgroup this item should be sorted into in item selection GUIs like logistic requests. [...]
wire_count optional	:: ItemCountType	The number of items needed to connect 2 entities with this as wire. [...]
The number of items needed to connect 2 entities with this as wire. [...]

Inherited from PrototypeBase

name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]

Properties

durability :: double optional

The durability of this tool. Must be positive. Mandatory if infinite is false. Ignored if infinite is true.

durability_description_key :: string optional

May not be longer than 200 characters.

durability_description_value :: string optional

May not be longer than 200 characters.

In-game, the game provides the locale with three parameters:

__1__: remaining durability

__2__: total durability

__3__: durability as a percentage

So when a locale key that has the following translation

Remaining durability is __1__ out of __2__ which is __3__ %

is applied to a tool with 2 remaining durability out of 8 it will be displayed as

Remaining durability is 2 out of 8 which is 25 %

infinite :: bool optional

Default: false

Whether this tool has infinite durability. If this is false, durability must be specified.

Factorio Prototype Docs Version 1.1.107

ToolPrototype - 'tool'

Properties

Properties

durability :: double optional

durability_description_key :: string optional

durability_description_value :: string optional

infinite :: bool optional

Prototypes

Types

Factorio Prototype DocsVersion 1.1.107

ToolPrototype - 'tool'

Properties

Properties

durability :: double optional

durability_description_key :: string optional

durability_description_value :: string optional

infinite :: bool optional

Prototypes

Types

Factorio Prototype Docs Version 1.1.107