MiningDrillPrototype

A mining drill for automatically extracting resources from resource entities. This prototype type is used by burner mining drill, electric mining drill and pumpjack in vanilla.

Parent

• EntityWithOwnerPrototype

Properties

vector_to_place_result

• Type: Vector
• Optional: false
• Override: false

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.

resource_searching_radius

• Type: double
• Optional: false
• Override: false

The distance from the center 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.

resource_searching_offset

• Type: Vector
• Optional: true
• Override: false

Offset of the resource_searching_radius from the entity center when the mining drill is facing north.

energy_usage

• Type: Energy
• Optional: false
• Override: false

The amount of energy used by the drill while mining. Can't be less than or equal to 0.

Examples

energy_usage = "150kW"

mining_speed

• Type: double
• Optional: false
• Override: false

The speed of this drill.

energy_source

• Type: EnergySource
• Optional: false
• Override: false

The energy source of this mining drill.

resource_categories

• Type: Array<ResourceCategoryID>
• Optional: false
• Override: false

The names of the ResourceCategory that can be mined by this drill. For a list of built-in categories, see here.

Note: Categories containing resources which produce items, fluids, or items+fluids may be combined on the same entity, but may not work as expected. 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.

output_fluid_box

• Type: FluidBox
• Optional: true
• Override: false

input_fluid_box

• Type: FluidBox
• Optional: true
• Override: false

graphics_set

• Type: MiningDrillGraphicsSet
• Optional: true
• Override: false

wet_mining_graphics_set

• Type: MiningDrillGraphicsSet
• Optional: true
• Override: false

perceived_performance

• Type: PerceivedPerformance
• Optional: true
• Override: false

Affects animation speed.

base_picture

• Type: Sprite4Way
• Optional: true
• Override: false

Used by the pumpjack to have a static 4 way sprite.

effect_receiver

• Type: EffectReceiver
• Optional: true
• Override: false

module_slots

• Type: ItemStackIndex
• Optional: true
• Override: false

The number of module slots in this machine.

quality_affects_module_slots

• Type: boolean
• Optional: true
• Override: false

If set, QualityPrototype::mining_drill_module_slots_bonus will be added to module slots count.

allowed_effects

• Type: EffectTypeLimitation
• Optional: true
• Override: false

Sets the modules and beacon effects that are allowed to be used on this mining drill.

allowed_module_categories

• Type: Array<ModuleCategoryID>
• Optional: true
• Override: false

Sets the module categories that are allowed to be inserted into this machine.

radius_visualisation_picture

• Type: Sprite
• Optional: true
• Override: false

The sprite used to show the range of the mining drill.

circuit_wire_max_distance

• Type: double
• Optional: true
• Override: false

The maximum circuit wire distance for this entity.

draw_copper_wires

• Type: boolean
• Optional: true
• Override: false

draw_circuit_wires

• Type: boolean
• Optional: true
• Override: false

base_render_layer

• Type: RenderLayer
• Optional: true
• Override: false

resource_drain_rate_percent

• Type: uint8
• Optional: true
• Override: false

May not be 0 or larger than 100.

shuffle_resources_to_mine

• Type: boolean
• Optional: true
• Override: false

drops_full_belt_stacks

• Type: boolean
• Optional: true
• Override: false

uses_force_mining_productivity_bonus

• Type: boolean
• Optional: true
• Override: false

quality_affects_mining_radius

• Type: boolean
• Optional: true
• Override: false

If set, QualityPrototype::mining_drill_mining_radius_bonus will be added to resource_searching_radius.

moving_sound

• Type: InterruptibleSound
• Optional: true
• Override: false

drilling_sound

• Type: InterruptibleSound
• Optional: true
• Override: false

drilling_sound_animation_start_frame

• Type: uint16
• Optional: true
• Override: false

drilling_sound_animation_end_frame

• Type: uint16
• Optional: true
• Override: false

monitor_visualization_tint

• Type: Color
• Optional: true
• Override: false

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_connector

• Type: Tuple<CircuitConnectorDefinition, CircuitConnectorDefinition, CircuitConnectorDefinition, CircuitConnectorDefinition>
• Optional: true
• Override: false

filter_count

• Type: uint8
• Optional: true
• Override: false

How many filters this mining drill has. Maximum count of filtered resources in a mining drill is 5.