Prototype/Tool
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.
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