Prototype/MiningDrill: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Removed old prototype docs)
 
(21 intermediate revisions by 8 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/MiningDrillPrototype.html https://lua-api.factorio.com/latest/prototypes/MiningDrillPrototype.html]
Prototype type: '''mining-drill'''


A mining drill. Based on [[Prototype/EntityWithHealth]].
</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 the properties of [[Prototype/EntityWithHealth]].
 
=== vector_to_place_result ===
'''Type''': [[Types/vector]]
 
The position where the (mine) result is placed, when the mining drill is facing south (?).
 
=== resource_searching_radius ===
'''Type''': [[Types/double]]
 
The distance from the centre of the mining drill to search for resources in.
 
This is 2.49 for electric mining drills (a 5x5 area) and 0.99 for burner mining drills (a 2x2 area). The drill searches resource outside its natural boundary box, which is 0.01 (the middle of the entity); making it 2.5 and 1.0 gives it another block radius.
 
=== energy_usage ===
'''Type''': [[Types/Energy]]
 
The amount of energy used by the drill while mining. Can't be less than or equal to 0
 
=== mining_speed ===
'''Type''': [[Types/double]]
 
The speed of this drill.
 
=== energy_source ===
'''Type''': [[Types/EnergySource]]
 
The energy source of this mining drill.
 
=== resource_categories ===
'''Type''': [[Types/string]]
 
The names of the [[Prototype/ResourceCategory]] that can be mined by this drill. For a list on built-in categories, see [[Data.raw#resource-category]].
 
=== animations ===
'''Type''': [[Types/Animation4Way]]
 
The animations to use.
 
== Optional properties ==
 
=== output_fluid_box ===
'''Type''': [[Types/FluidBox]]
 
=== input_fluid_box ===
'''Type''': [[Types/FluidBox]]
 
=== base_picture ===
'''Type''': [[Types/Sprite4Way]]
 
=== shadow_animations ===
'''Type''': [[Types/Animation4Way]]
 
=== allowed_effects ===
'''Type''': [[Types/EffectTypeLimitation]]
 
'''Default''': All effects are allowed
 
=== radius_visualization_picture ===
'''Type''': [[Types/Sprite]]
 
The sprite used to show the range of the mining drill.
 
=== storage_slots ===
'''Type''': [[Types/ItemStackIndex]]
 
'''Default''': 1
 
The output slot(s).
 
=== circuit_wire_max_distance ===
'''Type''': [[Types/double]]
 
'''Default''': 0
 
The maximum circuit wire distance for this entity.
 
=== draw_copper_wires ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== draw_circuit_wires ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
=== base_render_layer ===
'''Type''': [[Types/RenderLayer]]
 
'''Default''': "lower-object"
 
=== monitor_visualization_tint ===
'''Type''': [[Types/Color]]
 
When this mining drill is connected to the circuit network, the resource that it is reading (either the entire resource patch, or the resource in the mining area of the drill, depending on circuit network setting), is tinted in this color when mousing over the mining drill.
 
=== circuit_wire_connection_points ===
'''Type''': [[Types/table]] of [[Types/WireConnectionPoint]]
 
Mandatory if circuit_wire_max_distance  > 0.
 
=== circuit_connector_sprites ===
'''Type''': [[Types/table]] of [[Types/CircuitConnectorSprites]]
 
Mandatory if circuit_wire_max_distance  > 0.
 
=== module_specification ===
'''Type''': [[Types/ModuleSpecification]]
 
=== input_fluid_patch_sprites ===
'''Type''': [[Types/Sprite4Way]]
 
Only read if <code>input_fluid_box</code> exists. Even then it's optional.
 
=== input_fluid_patch_shadow_sprites ===
'''Type''': [[Types/Sprite4Way]]
 
Only read if <code>input_fluid_box</code> exists. Even then it's optional.
 
=== input_fluid_patch_window_sprites ===
'''Type''': [[Types/Sprite4Way]]
 
Only read if <code>input_fluid_box</code> exists. Even then it's optional.
 
=== input_fluid_patch_shadow_animations ===
'''Type''': [[Types/Sprite4Way]]
 
Only read if <code>input_fluid_box</code> exists. Even then it's optional.
 
=== input_fluid_patch_window_base_sprites ===
'''Type''': [[Types/table]] of [[Types/Sprite4Way]]
 
Only read if <code>input_fluid_box</code> exists. Even then it's optional.
 
=== input_fluid_patch_window_flow_sprites ===
'''Type''': [[Types/table]] of [[Types/Sprite4Way]]
 
Mandatory if <code>input_fluid_patch_window_base_sprites</code> exists.
 
input_fluid_patch_window_base_sprites count has to match input_fluid_patch_window_flow_sprites count.

Latest revision as of 14:32, 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/MiningDrillPrototype.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/MiningDrill&oldid=202943"