Prototype/Tool: Difference between revisions

Latest revision as of 10:43, 21 September 2023

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/prototypes/ToolPrototype.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.

Prototype definitions » PrototypeBase » Prototype/Item » Prototype/Tool

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

Prototype/Tool — `tool`
durability	::	double (optional)
durability_description_key	::	string (optional)
durability_description_value	::	string (optional)
infinite	::	bool (optional)
Inherited from Prototype/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

Prototype/Armor armor
Prototype/MiningTool mining-tool (for migration, cannot be used)
Prototype/RepairTool repair-tool

Optional properties

This prototype inherits all the properties from Prototype/Item.

durability

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

durability_description_key

Type: string
Default: "description.durability-key"
May not be longer than 200 characters.

durability_description_value

Type: string
Default: "description.durability-value"
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

Type: bool
Default: false
Whether this tool has infinite durability. If this is false, durability must be specified

@@ Line 1: / Line 1: @@
+<div class="stub"><p>'''The prototype docs have moved to a new website with an improved format.''' This documentation page can now be found here: [https://lua-api.factorio.com/latest/prototypes/ToolPrototype.html https://lua-api.factorio.com/latest/prototypes/ToolPrototype.html]
+</p><p>This wiki page is no longer updated and '''will be removed at some point in the future''', so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback [https://forums.factorio.com/viewforum.php?f=233 on the forums].</p></div>
 {{Prototype parent|Prototype/Item}}
 Items with a "durability". Used for [[science pack]]s.
@@ Line 13: / Line 19: @@
 {{Prototype_property|durability|[[Types/double|double]]|optional=true}}
-The durability of this tool. Must be positive. Mandatory if <code>infinite</code> is false.
+The durability of this tool. Must be positive. Mandatory if <code>infinite</code> is false. Ignored if <code>infinite</code> is true.
 {{Prototype_property|durability_description_key|[[Types/string|string]]|"description.durability-key"|optional=true}}
@@ Line 28: / Line 34: @@
 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 would mean it is displayed as
+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 %
-{{Prototype_property|infinite|[[Types/bool|bool]]|true|optional=true}}
+{{Prototype_property|infinite|[[Types/bool|bool]]|false|optional=true}}
-Whether this tool has infinite durability.
+Whether this tool has infinite durability. If this is false, <code>durability</code> must be specified