Prototype/MiningDrill: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(clarify base_productivity behavior)
(Removed old prototype docs)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Prototype parent|Prototype/EntityWithOwner}}
<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]
A mining drill for automatically extracting resources from [[Prototype/ResourceEntity|resource entities]]. This prototype type is used by [[burner mining drill]], [[electric mining drill]] and [[pumpjack]] in vanilla.


{{Prototype TOC|mining-drill}}
</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/EntityWithOwner]].
 
{{Prototype property|vector_to_place_result|[[Types/vector|vector]]}}
The position where any item results are placed, when the mining drill is facing north (default direction). If the drill does not produce any solid items but uses a fluidbox output instead (e.g. pumpjacks), a vector of {0,0} disables the yellow arrow alt-mode indicator for the placed item location.
 
{{Prototype property|resource_searching_radius|[[Types/double|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.
 
{{Prototype property|energy_usage|[[Types/Energy|Energy]]}}
The amount of energy used by the drill while mining. Can't be less than or equal to 0.
 
{{Prototype property|mining_speed|[[Types/double|double]]}}
The speed of this drill.
 
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
The energy source of this mining drill.
 
{{Prototype property|resource_categories|[[Types/table|array]] of [[Types/string|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]].</br>
Note: Categories containing resources which produce items, fluids, or items+fluids may be combined on the same entity, but may not work as expected.</br>
Examples: Miner does not rotate fluid-resulting resources until depletion. Fluid isn't output (fluid resource change and fluidbox matches previous fluid). Miner with no vector_to_place_result can't output an item result and halts.
 
== Optional properties ==
 
{{Prototype property|output_fluid_box|[[Types/FluidBox|FluidBox]]|optional=true}}
 
{{Prototype property|input_fluid_box|[[Types/FluidBox|FluidBox]]|optional=true}}
 
{{Prototype property|animations|[[Types/Animation4Way|Animation4Way]]|optional=true}}
Loaded only if <code>graphics_set</code> does not exist.
 
{{Prototype property|graphics_set|[[Types/MiningDrillGraphicsSet|MiningDrillGraphicsSet]]|optional=true}}
 
{{Prototype property|wet_mining_graphics_set|[[Types/MiningDrillGraphicsSet|MiningDrillGraphicsSet]]|optional=true}}
 
{{Prototype property|base_picture|[[Types/Sprite4Way|Sprite4Way]]|optional=true}}
Used by the [[pumpjack]] to have a static 4 way sprite.
 
{{Prototype property|allowed_effects|[[Types/EffectTypeLimitation|EffectTypeLimitation]]|All effects are allowed|optional=true}}
 
{{Prototype property|radius_visualisation_picture|[[Types/Sprite|Sprite]]|optional=true}}
The sprite used to show the range of the mining drill.
 
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}}
The maximum circuit wire distance for this entity.
 
{{Prototype property|draw_copper_wires|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|draw_circuit_wires|[[Types/bool|bool]]|true|optional=true}}
 
{{Prototype property|base_render_layer|[[Types/RenderLayer|RenderLayer]]|"lower-object"|optional=true}}
 
{{Prototype property|base_productivity|[[Types/float|float]]|0|optional=true}}
Productivity bonus that this machine always has. Any values below 0 will be changed to 0.
 
{{Prototype property|monitor_visualization_tint|[[Types/Color|Color]]|optional=true}}
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.
 
{{Prototype property|circuit_wire_connection_points|[[Types/table|table]] of [[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
Mandatory if circuit_wire_max_distance  > 0.
 
{{Prototype property|circuit_connector_sprites|[[Types/table|table]] of [[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
Mandatory if circuit_wire_max_distance  > 0.
 
{{Prototype property|module_specification|[[Types/ModuleSpecification|ModuleSpecification]]|optional=true}}

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"