Official Factorio Wiki - User contributions [en]

Types/FluidBox

2022-12-28T11:36:03Z

Deadlock989: Undo revision 190604 by Deadlock989 (talk)

== Basics ==
[[File:Fluidboxes.png|thumb|550px|Visual representation of base_area, base_level and height. When all the fluidboxes are connected, the water leaves fluidbox A and flows into the other 3 boxes through fluidbox B until the water level is equal in all boxes. For more info about fluids, see [[Fluid system#See also]].]]
Used to set the fluid amount an entity can hold, as well as the connection points for pipes leading into and out of the entity.

Entities can have multiple fluidboxes. These can be part of a [[Types/EnergySource#Fluid_energy_source]] or be specified directly in the entity prototype.

A fluidbox can store only one type of fluid at a time. However, a fluid system (multiple connected fluid boxes) can contain multiple different fluids, see [[Fluid_system#Fluid_mixing]].

== Mandatory properties ==

=== pipe_connections ===
'''Type''': [[Types/table]] of [[Types/PipeConnectionDefinition]]

Max number of members is 255.

Connection points to connect to other fluidboxes. This is also marked as blue arrows in alt mode.
Fluid may flow in or out depending on the `type` field of each connection.
Connection points may depend on the direction the entity is facing.

== Optional properties ==

=== base_area ===
'''Type''': [[Types/double]]

'''Default''': 1

Must be greater than 0. The total fluid capacity of the fluid box is <code>base_area × height × 100</code>.

=== base_level ===
'''Type''': [[Types/double]]

'''Default''': 0

Base level is the elevation of the invisible fluid box.
0 is ground level.

-1 puts the '''top''' of the fluid box at the '''bottom''' of a pipe connection, so, fluid "falls" in to it, and can't get out.

1 puts the '''bottom''' of the fluid box at the '''top''' of a pipe connection, so fluid "falls" out of it, but fluids already outside cannot get into it.

In other words:

1 = output only (and will attempt to empty as fast as possible).

-1 = input only (and will attempt to fill as fast as possible).

0 means fluids can freely flow in and out (and like a pipe, will balance to the level of the pipe next to it).

Having a -1 or 1 improperly set on an output or input, respectively, will cause issues like output fluid not leaving the building, or input fluid not entering, regardless of fluid levels in the pipe or fluid box.

=== height ===
'''Type''': [[Types/double]]

'''Default''': 1

Must be greater than 0. The total fluid capacity of the fluid box is <code>base_area × height × 100</code>.

=== filter ===
'''Type''': [[Types/string]]

Name of a [[Prototype/Fluid]]. Can be used to specify which fluid is allowed to enter this fluid box. [https://forums.factorio.com/viewtopic.php?f=28&t=46302]

=== render_layer ===
'''Type''': [[Types/RenderLayer]]

'''Default''': "object"

=== hide_connection_info ===
'''Type''': [[Types/bool]]

'''Default''': false

Hides the blue input/output arrows and icons at each connection point.

=== pipe_covers ===
'''Type''': [[Types/Sprite4Way]]

The pictures to show when another fluid box connects to this one.

=== pipe_picture ===
'''Type''': [[Types/Sprite4Way]]

=== minimum_temperature ===
'''Type''': [[Types/double]]

The minimum temperature allowed into the fluidbox. Only applied if a <code>filter</code> is specified [https://forums.factorio.com/viewtopic.php?p=496738#p496738].

<syntaxhighlight lang="lua">minimum_temperature = 100.0</syntaxhighlight>

=== maximum_temperature ===
'''Type''': [[Types/double]]

The maximum temperature allowed into the fluidbox. Only applied if a <code>filter</code> is specified [https://forums.factorio.com/viewtopic.php?p=496738#p496738].

<syntaxhighlight lang="lua">maximum_temperature = 1000.0</syntaxhighlight>

=== production_type ===
'''Type''': [[Types/string]]

'''Default''': "None"

Possible values:
* "None" or "none"
* "input"
* "input-output"
* "output"

=== secondary_draw_order ===
'''Type''': [[Types/int8]]

'''Default''': 1

Set the secondary draw order for all orientations. Used to determine render order for sprites with the same <code>render_layer</code> in the same position. Sprites with a higher <code>secondary_draw_order</code> are drawn on top.

=== secondary_draw_orders ===
'''Type''': [[Types/table]] of [[Types/int8]]

'''Default''': {north = 1, east = 1, south = 1, west = 1}

Set the secondary draw order for each orientation. Used to determine render order for sprites with the same <code>render_layer</code> in the same position. Sprites with a higher <code>secondary_draw_order</code> are drawn on top.

== Example ==

<syntaxhighlight lang="lua">fluid_box =
{
base_area = 1,
height = 2,
base_level = -1,
pipe_covers = pipecoverspictures(),
pipe_connections =
{
{type = "input-output", position = {-2, 0.5}},
{type = "input-output", position = {2, 0.5}}
},
production_type = "input-output"
},
</syntaxhighlight>

Types/FluidBox

2022-12-28T11:27:13Z

Deadlock989: /* hide_connection_info */

== Basics ==
[[File:Fluidboxes.png|thumb|550px|Visual representation of base_area, base_level and height. When all the fluidboxes are connected, the water leaves fluidbox A and flows into the other 3 boxes through fluidbox B until the water level is equal in all boxes. For more info about fluids, see [[Fluid system#See also]].]]
Used to set the fluid amount an entity can hold, as well as the connection points for pipes leading into and out of the entity.

Entities can have multiple fluidboxes. These can be part of a [[Types/EnergySource#Fluid_energy_source]] or be specified directly in the entity prototype.

A fluidbox can store only one type of fluid at a time. However, a fluid system (multiple connected fluid boxes) can contain multiple different fluids, see [[Fluid_system#Fluid_mixing]].

== Mandatory properties ==

=== pipe_connections ===
'''Type''': [[Types/table]] of [[Types/PipeConnectionDefinition]]

Max number of members is 255.

Connection points to connect to other fluidboxes. This is also marked as blue arrows in alt mode.
Fluid may flow in or out depending on the `type` field of each connection.
Connection points may depend on the direction the entity is facing.

== Optional properties ==

=== base_area ===
'''Type''': [[Types/double]]

'''Default''': 1

Must be greater than 0. The total fluid capacity of the fluid box is <code>base_area × height × 100</code>.

=== base_level ===
'''Type''': [[Types/double]]

'''Default''': 0

Base level is the elevation of the invisible fluid box.
0 is ground level.

-1 puts the '''top''' of the fluid box at the '''bottom''' of a pipe connection, so, fluid "falls" in to it, and can't get out.

1 puts the '''bottom''' of the fluid box at the '''top''' of a pipe connection, so fluid "falls" out of it, but fluids already outside cannot get into it.

In other words:

1 = output only (and will attempt to empty as fast as possible).

-1 = input only (and will attempt to fill as fast as possible).

0 means fluids can freely flow in and out (and like a pipe, will balance to the level of the pipe next to it).

Having a -1 or 1 improperly set on an output or input, respectively, will cause issues like output fluid not leaving the building, or input fluid not entering, regardless of fluid levels in the pipe or fluid box.

=== height ===
'''Type''': [[Types/double]]

'''Default''': 1

Must be greater than 0. The total fluid capacity of the fluid box is <code>base_area × height × 100</code>.

=== filter ===
'''Type''': [[Types/string]]

Name of a [[Prototype/Fluid]]. Can be used to specify which fluid is allowed to enter this fluid box. [https://forums.factorio.com/viewtopic.php?f=28&t=46302]

=== render_layer ===
'''Type''': [[Types/RenderLayer]]

'''Default''': "object"

=== hide_connection_info ===
'''Type''': [[Types/bool]]

'''Default''': false

Hides the blue input/output arrows and icons at each connection point. Defaults to true for storage-tank entities.

=== pipe_covers ===
'''Type''': [[Types/Sprite4Way]]

The pictures to show when another fluid box connects to this one.

=== pipe_picture ===
'''Type''': [[Types/Sprite4Way]]

=== minimum_temperature ===
'''Type''': [[Types/double]]

The minimum temperature allowed into the fluidbox. Only applied if a <code>filter</code> is specified [https://forums.factorio.com/viewtopic.php?p=496738#p496738].

<syntaxhighlight lang="lua">minimum_temperature = 100.0</syntaxhighlight>

=== maximum_temperature ===
'''Type''': [[Types/double]]

The maximum temperature allowed into the fluidbox. Only applied if a <code>filter</code> is specified [https://forums.factorio.com/viewtopic.php?p=496738#p496738].

<syntaxhighlight lang="lua">maximum_temperature = 1000.0</syntaxhighlight>

=== production_type ===
'''Type''': [[Types/string]]

'''Default''': "None"

Possible values:
* "None" or "none"
* "input"
* "input-output"
* "output"

=== secondary_draw_order ===
'''Type''': [[Types/int8]]

'''Default''': 1

Set the secondary draw order for all orientations. Used to determine render order for sprites with the same <code>render_layer</code> in the same position. Sprites with a higher <code>secondary_draw_order</code> are drawn on top.

=== secondary_draw_orders ===
'''Type''': [[Types/table]] of [[Types/int8]]

'''Default''': {north = 1, east = 1, south = 1, west = 1}

Set the secondary draw order for each orientation. Used to determine render order for sprites with the same <code>render_layer</code> in the same position. Sprites with a higher <code>secondary_draw_order</code> are drawn on top.

== Example ==

<syntaxhighlight lang="lua">fluid_box =
{
base_area = 1,
height = 2,
base_level = -1,
pipe_covers = pipecoverspictures(),
pipe_connections =
{
{type = "input-output", position = {-2, 0.5}},
{type = "input-output", position = {2, 0.5}}
},
production_type = "input-output"
},
</syntaxhighlight>

Prototype/MiningDrill

2022-12-26T21:23:32Z

Deadlock989:

{{Prototype parent|Prototype/EntityWithOwner}}
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}}

== 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]].
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.

== 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.

{{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}}

Prototype/Accumulator

2021-01-12T16:54:05Z

Deadlock989: /* Optional properties */

{{Prototype parent|Prototype/EntityWithHealth}}
Entity with energy source with specialised animation for charging/decharging.

{{Prototype TOC|accumulator}}

== Usage in base==
*[[Accumulator]]

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

{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
The capacity of the energy source buffer specifies the capacity of the accumulator. Must be an electric energy source.

{{Prototype property|picture|[[Types/Sprite|Sprite]]}}

{{Prototype property|charge_cooldown|[[Types/uint16|uint16]]}}
Count of ticks to preserve the animation even when the charging ends. Used to prevent rapid blinking of the accumulator with unstable need to use it.

{{Prototype property|discharge_cooldown|[[Types/uint16|uint16]]}}
How long (in ticks) the animation will last after discharge has been initialized.

== Optional properties ==

{{Prototype property|charge_animation|[[Types/Animation|Animation]]|optional=true}}

{{Prototype property|charge_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
Note that some kind of charge_animation must also be defined for the light to appear.

{{Prototype property|discharge_animation|[[Types/Animation|Animation]]|optional=true}}

{{Prototype property|discharge_light|[[Types/LightDefinition|LightDefinition]]|optional=true}}
Note that some kind of discharge_animation must also be defined for the light to appear.

{{Prototype property|circuit_wire_connection_point|[[Types/WireConnectionPoint|WireConnectionPoint]]|optional=true}}
Defines how wires visually connect to this accumulator.

{{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|circuit_connector_sprites|[[Types/CircuitConnectorSprites|CircuitConnectorSprites]]|optional=true}}
The pictures displayed for circuit connections to this accumulator.

{{Prototype property|default_output_signal|[[Types/SignalIDConnector|SignalIDConnector]]|optional=true}}
The name of the signal that is the default for when an accumulator is connected to the circuit network.

== Example ==
<syntaxhighlight lang="lua">{
type = "accumulator",
name = "accumulator",
icon = "__base__/graphics/icons/accumulator.png",
icon_size = 32,
flags = {"placeable-neutral", "player-creation"},
minable = {mining_time = 0.1, result = "accumulator"},
max_health = 150,
corpse = "accumulator-remnants",
collision_box = {{-0.9, -0.9}, {0.9, 0.9}},
selection_box = {{-1, -1}, {1, 1}},
drawing_box = {{-1, -1.5}, {1, 1}},
energy_source =
{
type = "electric",
buffer_capacity = "5MJ",
usage_priority = "tertiary",
input_flow_limit = "300kW",
output_flow_limit = "300kW"
},
picture = accumulator_picture(),
charge_animation = accumulator_charge(),

charge_cooldown = 30,
charge_light = {intensity = 0.3, size = 7, color = {r = 1.0, g = 1.0, b = 1.0}},
discharge_animation = accumulator_discharge(),
discharge_cooldown = 60,
discharge_light = {intensity = 0.7, size = 7, color = {r = 1.0, g = 1.0, b = 1.0}},
vehicle_impact_sound = { filename = "__base__/sound/car-metal-impact.ogg", volume = 0.65 },
working_sound =
{
sound =
{
filename = "__base__/sound/accumulator-working.ogg",
volume = 1
},
idle_sound =
{
filename = "__base__/sound/accumulator-idle.ogg",
volume = 0.4
},
max_sounds_per_type = 5
},

circuit_wire_connection_point = circuit_connector_definitions["accumulator"].points,
circuit_connector_sprites = circuit_connector_definitions["accumulator"].sprites,
circuit_wire_max_distance = default_circuit_wire_max_distance,

default_output_signal = {type = "virtual", name = "signal-A"}
}</syntaxhighlight>

Damage

2020-12-08T16:46:01Z

Deadlock989: /* Piercing power */ Only cannon shells have piercing_damaged defined as of Factorio 1.1 and probably much earlier

{{Languages}}
[[File:player_attacked_by_biters_small.png|thumb|300px|right|Red flashing while taking damage.]]Taking '''damage''' is the effect of lowering the health of the [[player]], [[enemies]] or other entities.
== Overview ==
In Factorio, entities have health, can die/be destroyed, and have resistances. ''Damage'' is defined as the concept of lowering an entity's health by using an attack, such as a gun firing at it, or a biter chewing on it. An entity's resistances will define exactly how much damage the entity will take off of an arbitrary attack.

The player's maximum health is 250 (without [[energy shield]]s). Other entities' health values are listed in their individual entries.

== Achievements ==
The concept of damage is directly connected to the following achievements:
{{Achievement|run-forrest-run}}
{{Achievement|pyromaniac}}
{{Achievement|steamrolled}}
{{Achievement|golem}}
{{Achievement|watch-your-step}}

== Damage types ==
{|class="wikitable"
|-
! Damage type !! Used by
|-
| Physical || Bullets ([[Firearm magazine|regular]]/[[Piercing rounds magazine|piercing]]/[[Uranium rounds magazine|uranium]]), shotgun shells ([[Shotgun shells|regular]]/[[Piercing shotgun shells|piercing]]), [[Enemies#Biters|biters]], [[Defender_capsule|defender robots]]
|-
| Impact || Collision (of [[Locomotive|train]]/[[car]]/[[tank]])
|-
| Fire || [[Flamethrower]]
|-
| Acid || [[Enemies#Worms|Worms]], [[Enemies#Spitters|Spitters]]
|-
| Poison || [[Poison capsule]]
|-
| Explosion || [[Rocket|Rockets]], [[Explosive rocket|Explosive Rockets]], [[Grenade]], [[Cluster grenade]], [[Artillery shell]]
|-
| Laser || [[Turret#Laser Turrets|Laser turrets]], [[Distractor capsule|distractor robots]], [[personal laser defense]]
|-
| Electric || [[Discharge defense]], [[Destroyer capsule|destroyer robots]]
|}

=== Piercing power ===
Piercing power is present with [[tank]] ammunition. It determines how much HP of enemies can a projectile damage before it is no longer able to travel further. To penetrate an enemy, the enemy has to be killed by the projectile, and the damage dealt for the kill must be less than current piercing power.[https://forums.factorio.com/viewtopic.php?f=5&t=30917] The damage dealt also decreases piercing power. For example, shooting medium biters with 75 health with a cannon shell of 300 piercing power means that the shell will pierce through 4 medium biters, killing them, and still destroy/damage one more target.

== Resistance ==
Resistance has two aspects:
=== Decrease, or "flat" resistance ===
Decrease resistance decreases the damage by specified number as long as the resulting damage wouldn't be less than 1. If the result damage would be less than 1, an alternate formula is used.
Let R denote the flat resistance value, D the incoming damage, and M the modified damage, after accounting for flat resistance. Then

if R+1<D

<code>M=D-R</code>

otherwise if D>1

<code>M=1/(R-D+2)</code>

otherwise

<code>M=1/(R+1)</code>.

If flat resistance matches or exceeds the raw damage, then modified damage is asymptotic towards 0, as shown by following example table:

{| class="wikitable"
|-
! Damage !! Flat Resistance !! Modified damage (with 0% resistance)
|-
| 5 || 0 || 5
|-
| 5 || 1 || 4
|-
| 5 || 2 || 3
|-
| 5 || 3 || 2
|-
| 5 || 4 || 1
|-
| 5 || 5 || 1/2
|-
| 5 || 6 || 1/3
|-
| 5 || 7 || 1/4
|-
| 5 || 8 || 1/5
|-
| ... || ... || ...
|}

=== Percentage resistance ===

Percentage resistance reduces the damage by the specified percent. It is applied ''after'' flat/decrease resistances when both are present and thus changes the 'modified damage' value above, decreasing it by the specified percentage. If the value is 100%, the entity is immune to the damage. This is the only way to have an entity immune to a type of damage, as flat reduction cannot reduce damage beneath 1.

As an example, an entity with 25% resistance to physical damage hit with a bullet dealing 100 physical damage would take 75 damage instead of 100.

The formula used for percentage resistance to damage is as follows:

Let M denote the flat-resistance-modified starter damage, and let P denote the percentage resistance (in decimal form, so 25%=0.25), and let F denote final damage.

<code>F = M * (1 - P)</code>

--------

In Factorio, resistances are displayed in the UI as follows:

Decrease resistance/Percentage resistance (Damage type)

So, an entity that displays 10/20% resistance to fire has 10 flat resistance and 20% percent resistance to fire. If the aforementioned entity were to take 30 fire damage, they would instead take 16 damage, after resistances were applied.

The formula used for the above:

16final damage = (30initial raw damage - 10flat resist) * 0.820% resistance

== Combined formulas ==
Let D denote the raw incoming damage (of applicable type), R denoted the flat resistance value (against damage of the applicable type), P the percentage resistance (against damage of the same type) in decimal form (e.g. 20%=0.2), and let F denote the final damage (of applicable type) dealt to the target.
=== If R+1<D ===
F = (D - R) * (1 - P)
=== otherwise if D>1 ===
F = (1 - P) / (R-D+2)
=== otherwise ===
F = (1 - P) / (R+1)

Types/FluidBox

2020-10-07T23:33:14Z

Deadlock989: /* maximum_temperature */

Types/WorkingVisualisation

2020-10-05T20:37:09Z

Deadlock989:

Used by crafting machines to display different graphics when the machine is running.

== Optional properties ==

=== render_layer ===
'''Type''': [[Types/RenderLayer]]

'''Default''': "object"

=== fadeout ===
'''Type''': [[Types/bool]]

'''Default''': false

=== synced_fadeout ===
'''Type''': [[Types/bool]]

'''Default''': false

=== constant_speed ===
'''Type''': [[Types/bool]]

'''Default''': false

Whether the animations are always played at the same speed, not adjusted to the machine speed.

=== always_draw ===
'''Type''': [[Types/bool]]

'''Default''': false

=== animated_shift ===
'''Type''': [[Types/bool]]

'''Default''': false

=== align_to_waypoint ===
'''Type''': [[Types/bool]]

'''Default''': false

=== secondary_draw_order ===
'''Type''': [[Types/int8]]

=== draw_as_sprite ===
'''Type''': [[Types/bool]]

'''Default''': true

=== draw_as_light ===
'''Type''': [[Types/bool]]

'''Default''': false

=== light ===
'''Type''': [[Types/LightDefinition]]

=== effect ===
'''Type''': [[Types/string]]

Either "flicker", "uranium-glow" or "none".

=== apply_recipe_tint ===
'''Type''': [[Types/string]]

Either "primary", "secondary", "tertiary", "quaternary" or "none". Used by [[Prototype/CraftingMachine]].

=== apply_tint ===
'''Type''': [[Types/string]]

Either "resource-color", "input-fluid-base-color", "input-fluid-flow-color", "status" or "none". Used by [[Prototype/MiningDrill]] and [[Prototype/CraftingMachine]] ("status" only?).

=== north_animation ===
'''Type''': [[Types/Animation]]

Either these animations for the directions are loaded, or <code>animation</code> and the positions for the directions are loaded.

=== west_animation ===
'''Type''': [[Types/Animation]]

=== south_animation ===
'''Type''': [[Types/Animation]]

=== east_animation ===
'''Type''': [[Types/Animation]]

=== animation ===
'''Type''': [[Types/Animation]]

Either this and the below positions are loaded, or the animation properties for each direction are loaded.

=== north_position ===
'''Type''': [[Types/vector]]

=== west_position ===
'''Type''': [[Types/vector]]

=== south_position ===
'''Type''': [[Types/vector]]

=== east_position ===
'''Type''': [[Types/vector]]

Types/EntityPrototypeFlags

2019-10-13T09:53:12Z

Deadlock989: /* "breaths-air" */

Array ([[Types/table]]) of strings. The possible strings are listed below.

== "not-rotatable" ==
Can't be rotated before or after placing.

== "placeable-[force]" ==
*"placeable-player"
*"placeable-neutral"
*"placeable-enemy"
placeable neutral/player/enemy determine the default force when placing entities in the map editor and using the *AUTO* option for the force.

== "placeable-off-grid" ==
placeable-off-grid refers to the fact that most entities are placed on an invisible 'grid' within the world, entities with the placeable-off-grid flag do not have to line up with this grid (like trees and land-mines)

== "player-creation" ==
Makes it possible for the biter AI to target the entity as a distraction. Makes it possible to blueprint, deconstruct, and repair the entity (can be turned off again using the specific flags). Enables smoke to be created automatically when building the entity.

== "building-direction-8-way" ==
Uses 45 degree angle increments when selecting direction.

== "filter-directions" ==
Used to automatically detect the proper direction, if possible. Used by base with the pump, train stop, and train signal.

== "fast-replaceable-no-build-while-moving" ==
Fast replace will not apply when building while moving.

== "breaths-air" ==
This is used to specify that the entity breathes air, and so is affected by poison (currently [[Poison_capsule|Poison Capsules]] are the only source).

== "not-repairable" ==
Used to specify that the entity can not be 'healed' by repair-packs (or construction robots with repair packs)

== "not-on-map" ==
The entity does not get drawn on the map.

== "not-blueprintable" ==
The entity can't be used in blueprints.

== "not-deconstructable" ==
The entity can't be deconstructed.

== "hidden" ==
Hides the entity from the bonus GUI (button above the map) and from the made in property of recipe tooltips.

== "hide-alt-info" ==
Hides the alt-info of an entity in alt-mode, for example the recipe icon.

== "fast-replaceable-no-cross-type-while-moving" ==
Do not fast replace over other entity types when building while moving.

== "no-gap-fill-while-building" ==

== "not-flammable" ==
Do not apply fire stickers to the entity.

== "no-automated-item-removal" ==

Prevents inserters and loaders from taking items from this entity.

== "no-automated-item-insertion" ==

Prevents inserters and loaders from inserting items into this entity.

== "no-copy-paste" ==

== "not-selectable-in-game" ==

== "not-upgradable" ==
The entity can't be selected by the Upgrade Planner tool.

== Example ==
flags = {"placeable-neutral", "player-creation"}

Types/BaseAttackParameters

2019-10-04T22:52:15Z

Deadlock989: /* fire_penalty */

The abstract base of all attack parameters.

== Extensions ==
* [[Types/ProjectileAttackParameters]]
* [[Types/BeamAttackParameters]]
* [[Types/StreamAttackParameters]]

== Mandatory properties ==
=== range ===
'''Type''': [[Types/float]]

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

Number of ticks in which it will be possible to shoot again. If < 1, multiple shots can be performed in one tick.

== Optional properties ==
=== min_range ===
'''Type''': [[Types/float]]

'''Default''': 0

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

'''Default''': 1

If this is <= 0, it is set to 1.

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

'''Default''': 0

Used when searching for the nearest enemy, when this is > 0, enemies that aren't burning are preferred over burning enemies. Definition of "burning" for this: Entity has sticker attached to it, and the sticker has a [[Prototype/Sticker#spread_fire_entity|spread_fire_entity]] set.

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

'''Default''': <code>range</code>

If less than <code>range</code>, the entity will choose a random distance between <code>range</code> and <code>min_attack_distance</code> and attack from that distance.

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

'''Default''': 1

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

'''Default''': 1

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

'''Default''': 0

=== warmup ===
'''Type''': [[Types/uint32]]

'''Default''': 0

Number of ticks it takes for the weapon to actually shoot after the order for shooting has been made. This also allows to "adjust" the shooting animation to the effect of shooting.

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

'''Default''': 0

Base game uses
<syntaxhighlight lang="lua">lead_target_for_projectile_speed = 0.2* 0.75 * 1.5, -- this is same as particle horizontal speed of flamethrower fire stream</syntaxhighlight>
Presumably this should be set to the projectile speed to make the unit/turret lead their projectiles.

=== movement_slow_down_factor ===
'''Type''': [[Types/double]]

'''Default''': 1

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

'''Default''': <code>cooldown</code>

=== ammo_type ===
'''Type''': [[Types/AmmoType]]

Can be mandatory.

=== ammo_category ===
'''Type''': [[Types/string]]

The name of a [[Prototype/AmmoCategory]]. Mandatory if <code>ammo_type</code> is not given, otherwise ignored.

=== sound ===
'''Type''': [[Types/Sound]]

=== animation ===
'''Type''': [[Types/RotatedAnimation]]

=== cyclic_sound ===
'''Type''': [[Types/table]]

Table with the following mandatory key/value pairs:
* begin_sound - [[Types/Sound]]
* middle_sound - [[Types/Sound]]
* end_sound - [[Types/Sound]]

=== use_shooter_direction ===
'''Type''': [[Types/bool]]

'''Default''': false

Prototype/Module

2019-08-05T10:47:35Z

Deadlock989: /* Mandatory properties */

{{Prototype parent|Prototype/Item}}
A [[module]].

{{Prototype TOC|module}}

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

{{Prototype property|category|[[Types/string|string]]}}
The name of a module category. Used when upgrading modules. Must match the name of a registered [[Prototype/ModuleCategory]].

{{Prototype property|tier|[[Types/uint32|uint32]]}}

{{Prototype property|effect|[[Types/Effect|Effect]]}}

== Optional properties ==

{{Prototype property|limitation|[[Types/table|table]] of [[Types/string|string]]|optional=true}}
Array of recipe names this module can be used on. If empty, the module can be used on all recipes.

{{Prototype property|limitation_message_key|[[Types/string|string]]|optional=true}}
Mandatory when <code>limitation</code> is present. The locale key of the message that is shown when the player attempts to use the module on a recipe it can't be used on. The locale key will be prefixed with <code>item-limitation.</code> (the "category" of the locale) by the game.

Prototype/MiningDrill

2019-08-02T00:09:48Z

Deadlock989: /* input_fluid_patch_shadow_animations */

{{Prototype parent|Prototype/EntityWithHealth}}

== Basics ==
Prototype type: '''mining-drill'''

A mining drill. Based on [[Prototype/EntityWithHealth]].

== 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"

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

'''Default''': 0

Productivity bonus that this machine always has.

=== 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/Animation4Way]]

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.