Prototype/Tool: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(0.17)
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Basics ==
{{Prototype parent|Prototype/Item}}
Prototype type: '''tool'''
Items with a "durability". Used for [[science pack]]s.


Items with a "durability". Used for [[science pack]]s. Extends [[Prototype/Item]].
{{Prototype TOC|tool}}


== Extensions ==
== Extensions ==
Line 12: Line 12:
This prototype inherits all the properties from [[Prototype/Item]].
This prototype inherits all the properties from [[Prototype/Item]].


=== durability ===
{{Prototype_property|durability|[[Types/double|double]]|optional=true}}
'''Type''': [[Types/double]]
The durability of this tool. Must be positive. Mandatory if <code>infinite</code> is false.


Must be positive. Mandatory if <code>infinite</code> is false.
{{Prototype_property|durability_description_key|[[Types/string|string]]|"description.durability-key"|optional=true}}
May not be longer than 200 characters.


=== durability_description_key ===
{{Prototype_property|durability_description_value|[[Types/string|string]]|"description.durability-value"|optional=true}}
'''Type''': [[Types/string]]
May not be longer than 200 characters.


'''Default''': "description.durability-key"
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


=== durability_description_value ===
So when a locale key that has the following translation
'''Type''': [[Types/string]]
  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 %


'''Default''': "description.durability-value"
{{Prototype_property|infinite|[[Types/bool|bool]]|true|optional=true}}
 
Whether this tool has infinite durability.
=== infinite ===
'''Type''': [[Types/bool]]
 
'''Default''': true

Revision as of 09:42, 24 June 2021

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

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.

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: true
Whether this tool has infinite durability.