Prototype/MiningDrill: Difference between revisions
Deadlock989 (talk | contribs) |
(Converted to SMW format) |
||
| Line 1: | Line 1: | ||
{{Prototype parent|Prototype/EntityWithHealth}} | {{Prototype parent|Prototype/EntityWithHealth}} | ||
A mining drill. | |||
{{Prototype TOC|mining-drill}} | |||
Prototype | |||
== Mandatory properties == | == Mandatory properties == | ||
| Line 10: | Line 8: | ||
This prototype inherits the properties of [[Prototype/EntityWithHealth]]. | This prototype inherits the properties of [[Prototype/EntityWithHealth]]. | ||
{{Prototype property|vector_to_place_result|[[Types/vector|vector]]}} | |||
The position where the (mine) result is placed, when the mining drill is facing south (?). | The position where the (mine) result is placed, when the mining drill is facing south (?). | ||
{{Prototype property|resource_searching_radius|[[Types/double|double]]}} | |||
The distance from the centre of the mining drill to search for resources in. | 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. | 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 | 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. | The speed of this drill. | ||
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}} | |||
The energy source of this mining drill. | The energy source of this mining drill. | ||
{{Prototype property|resource_categories|[[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]]. | 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]]. | ||
{{Prototype property|animations|[[Types/Animation4Way|Animation4Way]]}} | |||
The animations to use. | The animations to use. | ||
== Optional properties == | == Optional properties == | ||
{{Prototype property|output_fluid_box|[[Types/FluidBox|FluidBox]]|optional=true}} | |||
{{Prototype property|input_fluid_box|[[Types/FluidBox|FluidBox]]|optional=true}} | |||
{{Prototype property|base_picture|[[Types/Sprite4Way|Sprite4Way]]|optional=true}} | |||
{{Prototype property|shadow_animations|[[Types/Animation4Way|Animation4Way]]|optional=true}} | |||
{{Prototype property|allowed_effects|[[Types/EffectTypeLimitation|EffectTypeLimitation]]|All effects are allowed|optional=true}} | |||
{{Prototype property|radius_visualization_picture|[[Types/Sprite|Sprite]]|optional=true}} | |||
The sprite used to show the range of the mining drill. | The sprite used to show the range of the mining drill. | ||
{{Prototype property|storage_slots|[[Types/ItemStackIndex|ItemStackIndex]]|1|optional=true}} | |||
The output slot(s). | The output slot(s). | ||
{{Prototype property|circuit_wire_max_distance|[[Types/double|double]]|0|optional=true}} | |||
The maximum circuit wire distance for this entity. | 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. | Productivity bonus that this machine always has. | ||
{{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. | 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. | 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. | Mandatory if circuit_wire_max_distance > 0. | ||
{{Prototype property|module_specification|[[Types/ModuleSpecification|ModuleSpecification]]|optional=true}} | |||
{{Prototype property|input_fluid_patch_sprites|[[Types/Sprite4Way|Sprite4Way]]|optional=true}} | |||
Only read if <code>input_fluid_box</code> exists. Even then it's optional. | Only read if <code>input_fluid_box</code> exists. Even then it's optional. | ||
{{Prototype property|input_fluid_patch_shadow_sprites|[[Types/Sprite4Way|Sprite4Way]]|optional=true}} | |||
Only read if <code>input_fluid_box</code> exists. Even then it's optional. | Only read if <code>input_fluid_box</code> exists. Even then it's optional. | ||
{{Prototype property|input_fluid_patch_window_sprites|[[Types/Sprite4Way|Sprite4Way]]|optional=true}} | |||
Only read if <code>input_fluid_box</code> exists. Even then it's optional. | Only read if <code>input_fluid_box</code> exists. Even then it's optional. | ||
{{Prototype property|input_fluid_patch_shadow_animations|[[Types/Animation4Way|Animation4Way]]|optional=true}} | |||
Only read if <code>input_fluid_box</code> exists. Even then it's optional. | Only read if <code>input_fluid_box</code> exists. Even then it's optional. | ||
{{Prototype property|input_fluid_patch_window_base_sprites|[[Types/table|table]] of [[Types/Sprite4Way|Sprite4Way]]|optional=true}} | |||
Only read if <code>input_fluid_box</code> exists. Even then it's optional. | Only read if <code>input_fluid_box</code> exists. Even then it's optional. | ||
{{Prototype property|input_fluid_patch_window_flow_sprites|[[Types/table|table]] of [[Types/Sprite4Way|Sprite4Way]]|optional=true}} | |||
Mandatory if <code>input_fluid_patch_window_base_sprites</code> exists. | 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. | input_fluid_patch_window_base_sprites count has to match input_fluid_patch_window_flow_sprites count. | ||
Revision as of 16:43, 5 August 2019
Template:Prototype parent A mining drill.
Mandatory properties
This prototype inherits the properties of Prototype/EntityWithHealth.
Template:Prototype property The position where the (mine) result is placed, when the mining drill is facing south (?).
Template:Prototype property 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.
Template:Prototype property The amount of energy used by the drill while mining. Can't be less than or equal to 0
Template:Prototype property The speed of this drill.
Template:Prototype property The energy source of this mining drill.
Template:Prototype property 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.
Template:Prototype property The animations to use.
Optional properties
Template:Prototype property The sprite used to show the range of the mining drill.
Template:Prototype property The output slot(s).
Template:Prototype property The maximum circuit wire distance for this entity.
Template:Prototype property Productivity bonus that this machine always has.
Template:Prototype property 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.
Template:Prototype property Mandatory if circuit_wire_max_distance > 0.
Template:Prototype property Mandatory if circuit_wire_max_distance > 0.
Template:Prototype property
Only read if input_fluid_box exists. Even then it's optional.
Template:Prototype property
Only read if input_fluid_box exists. Even then it's optional.
Template:Prototype property
Only read if input_fluid_box exists. Even then it's optional.
Template:Prototype property
Only read if input_fluid_box exists. Even then it's optional.
Template:Prototype property
Only read if input_fluid_box exists. Even then it's optional.
Template:Prototype property
Mandatory if input_fluid_patch_window_base_sprites exists.
input_fluid_patch_window_base_sprites count has to match input_fluid_patch_window_flow_sprites count.