Prototype/Tool: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Migrated prototype doc to separate website)
(Removed old prototype docs)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''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]
<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]


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><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.
 
{{Prototype TOC|tool}}
 
== 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]].
 
{{Prototype_property|durability|[[Types/double|double]]|optional=true}}
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}}
May not be longer than 200 characters.
 
{{Prototype_property|durability_description_value|[[Types/string|string]]|"description.durability-value"|optional=true}}
May not be longer than 200 characters.
 
In-game, the game provides the locale with three [[Tutorial:Localisation#Localising_with_parameters|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 %
 
{{Prototype_property|infinite|[[Types/bool|bool]]|false|optional=true}}
Whether this tool has infinite durability. If this is false, <code>durability</code> must be specified

Latest revision as of 14:33, 25 October 2024

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.

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/Tool&oldid=203013"