Prototype/MiningTool: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Added prototype type to page)
(Updated styling of prototype doc migration note)
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==basics==
<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/MiningToolPrototype.html https://lua-api.factorio.com/latest/prototypes/MiningToolPrototype.html]
Prototype type: '''mining-tool'''


A tool to mine ore out of the ground, break rocks, and damage enemies.Extends [[Prototype/Tool]].
</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>


== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/Tool]].


=== speed ===
'''Type''': [[Types/float]]


Mining speed.
{{Prototype parent|Prototype/Tool}}
Exists only for migration, cannot be used by mods.


== Optional properties ==
{{Prototype TOC|mining-tool|no-properties=true}}
 
=== action ===
'''Type''': [[Types/Trigger]]
 
Tells the mining tool what to do when the player uses it.
 
=== action_range ===
'''Type''': [[Types/float]]
 
'''Default''': 1.5
 
=== build_distance_bonus ===
'''Type''': [[Types/double]]
 
'''Default''': 0.0
 
Must be positive.
 
=== item_drop_distance_bonus ===
'''Type''': [[Types/double]]
 
'''Default''': 0.0
 
Must be positive.
 
=== reach_distance_bonus ===
'''Type''': [[Types/double]]
 
'''Default''': 0.0
 
Must be positive.
 
=== item_pickup_distance_bonus ===
'''Type''': [[Types/double]]
 
'''Default''': 0.0
 
Must be positive.
 
=== loot_pickup_distance_bonus ===
'''Type''': [[Types/double]]
 
'''Default''': 0.0
 
Must be positive.
 
=== resource_reach_distance_bonus ===
'''Type''': [[Types/double]]
 
'''Default''': 0.0
 
Must be positive.

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/MiningToolPrototype.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 » Prototype/MiningTool


Exists only for migration, cannot be used by mods.


Prototype/MiningTool — mining-tool
No new properties
Inherited from Prototype/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)