Prototype/Boiler
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/BoilerPrototype.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.
Prototype definitions » PrototypeBase » Prototype/Entity » Prototype/EntityWithHealth » Prototype/EntityWithOwner » Prototype/Boiler
A boiler.
Mandatory properties
This prototype inherits all the properties from Prototype/EntityWithOwner.
energy_source
Type: EnergySource
fluid_box
Type: FluidBox
The input fluid box.
If mode is "heat-water-inside", the fluid is heated up directly in this fluidbox.
output_fluid_box
Type: FluidBox
The output fluid box.
If mode is "output-to-separate-pipe" and this has a filter, the input fluid is converted to the output fluid that is set in the filter (in a 1:1 ratio).
If mode is "heat-water-inside", this fluidbox is not used.
energy_consumption
Type: Energy
burning_cooldown
Type: uint32
Controls for how many ticks the boiler will show the fire and fire_glow after the energy source runs out of energy.
Note that fire and fire_glow alpha is set to the light intensity of the energy source, so 0 light intensity means the fire is invisible. For burner energy sources, the light intensity will reach zero rather quickly after the boiler runs out of fuel, effectively capping the time that fire and fire_glow will be shown after the boiler runs out of fuel.
target_temperature
Type: double
When mode is "output-to-separate-pipe", this is the temperature that the input fluid must reach to be moved to output fluid box.
When mode is "heat-water-inside" this is unused. Instead, the fluid max_temperature is the target temperature for heating the fluid.
structure
Type: table
Table with the following mandatory members:
fire
Type: table
Table with the following optional members:
This means the table itself is required, but can be empty.
Animation that is drawn on top of the structure when burning_cooldown is larger than 1. The animation alpha can be controlled by the energy source light intensity, depending on fire_flicker_enabled.
The secondary draw order of this is higher than the secondary draw order of fire_glow, so this is drawn above fire_glow.
fire_glow
Type: table
Table with the following optional members:
This means the table itself is required, but can be empty.
Animation that is drawn on top of the structure when burning_cooldown is larger than 1. The animation alpha that be controlled by the energy source light intensity, depending on fire_glow_flicker_enabled.
The secondary draw order of this is lower than the secondary draw order of fire, so this is drawn below fire.
Optional properties
fire_glow_flicker_enabled
Type: bool
Default: false
If this is set to false, fire_glow alpha is always 1 instead of being controlled by the light intensity of the energy source.
fire_flicker_enabled
Type: bool
Default: false
If this is set to false, fire alpha is always 1 instead of being controlled by the light intensity of the energy source.
mode
Type: string
Default: "heat-water-inside"
One of "heat-water-inside" or "output-to-separate-pipe".
In the "heat-water-inside" mode, fluid in the fluid_box is continuously heated from the input temperature up to its max_temperature.
In the "output-to-separate-pipe" mode, fluid is transferred from the fluid_box to the output_fluid_box when enough energy is available to heat the fluid to the target_temperature. Setting a filter on the output_fluid_box allows to specify that the input fluid should be converted to the filtered fluid, instead of it simply being transferred when it can be heated.
patch
Type: table
Table with the following optional members:
Drawn above the structure, in the "higher-object-under" Types/RenderLayer. May be useful to correct problems with neighboring pipes overlapping the structure graphics.