Prototype/Boiler: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Updated styling of prototype doc migration note)
(Removed old prototype docs)
 
Line 2: Line 2:


</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>
</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>
{{Prototype parent|Prototype/EntityWithOwner}}
A [[boiler]].
{{Prototype TOC|boiler}}
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithOwner]].
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]}}
The input fluid box.<br>
If <code>mode</code> is "heat-water-inside", the fluid is heated up directly in this fluidbox.
{{Prototype property|output_fluid_box|[[Types/FluidBox|FluidBox]]}}
The output fluid box.<br>
If <code>mode</code> is "output-to-separate-pipe" and this has a [[Types/FluidBox#filter|filter]], the input fluid is converted to the output fluid that is set in the filter (in a 1:1 ratio).<br>
If <code>mode</code> is "heat-water-inside", this fluidbox is not used.
{{Prototype property|energy_consumption|[[Types/Energy|Energy]]}}
{{Prototype property|burning_cooldown|[[Types/uint32|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.
{{Prototype property|target_temperature|[[Types/double|double]]}}
When <code>mode</code> is "output-to-separate-pipe", this is the temperature that the input fluid must reach to be moved to output fluid box.<br>
When <code>mode</code> is "heat-water-inside" this is unused. Instead, the fluid [[Prototype/Fluid#max_temperature|max_temperature]] is the target temperature for heating the fluid.
{{Prototype property|structure|[[Types/table|table]]}}
Table with the following mandatory members:
* north - [[Types/Animation|Animation]]
* east - [[Types/Animation|Animation]]
* south - [[Types/Animation|Animation]]
* west - [[Types/Animation|Animation]]
{{Prototype property|fire|[[Types/table|table]]}}
Table with the following optional members:
* north - [[Types/Animation|Animation]]
* east - [[Types/Animation|Animation]]
* south - [[Types/Animation|Animation]]
* west - [[Types/Animation|Animation]]
This means the table itself is required, but can be empty.
Animation that is drawn on top of the <code>structure</code> when <code>burning_cooldown</code> is larger than 1. The animation alpha can be controlled by the energy source light intensity, depending on <code>fire_flicker_enabled</code>.<br>
The secondary draw order of this is higher than the secondary draw order of <code>fire_glow</code>, so this is drawn above <code>fire_glow</code>.
{{Prototype property|fire_glow|[[Types/table|table]]}}
Table with the following optional members:
* north - [[Types/Animation|Animation]]
* east - [[Types/Animation|Animation]]
* south - [[Types/Animation|Animation]]
* west - [[Types/Animation|Animation]]
This means the table itself is required, but can be empty.
Animation that is drawn on top of the <code>structure</code> when <code>burning_cooldown</code> is larger than 1. The animation alpha that be controlled by the energy source light intensity, depending on <code>fire_glow_flicker_enabled</code>.<br>
The secondary draw order of this is lower than the secondary draw order of <code>fire</code>, so this is drawn below <code>fire</code>.
== Optional properties ==
{{Prototype property|fire_glow_flicker_enabled|[[Types/bool|bool]]|false|optional=true}}
If this is set to false, <code>fire_glow</code> alpha is always 1 instead of being controlled by the light intensity of the energy source.
{{Prototype property|fire_flicker_enabled|[[Types/bool|bool]]|false|optional=true}}
If this is set to false, <code>fire</code> alpha is always 1 instead of being controlled by the light intensity of the energy source.
{{Prototype property|mode|[[Types/string|string]]|"heat-water-inside"|optional=true}}
One of "heat-water-inside" or "output-to-separate-pipe".<br>
In the "heat-water-inside" mode, fluid in the <code>fluid_box</code> is continuously heated from the input temperature up to its [[Prototype/Fluid#max_temperature|max_temperature]].<br>
In the "output-to-separate-pipe" mode, fluid is transferred from the <code>fluid_box</code> to the <code>output_fluid_box</code> when enough energy is available to [[Prototype/Fluid#heat_capacity|heat]] the fluid to the <code>target_temperature</code>. Setting a filter on the <code>output_fluid_box</code> 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.
{{Prototype property|patch|[[Types/table|table]]|optional=true}}
Table with the following optional members:
* north - [[Types/Sprite|Sprite]]
* east - [[Types/Sprite|Sprite]]
* south - [[Types/Sprite|Sprite]]
* west - [[Types/Sprite|Sprite]]
Drawn above the <code>structure</code>, in the "higher-object-under" [[Types/RenderLayer]]. May be useful to correct problems with neighboring pipes overlapping the structure graphics.

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

Retrieved from "https://wiki.factorio.com/index.php?title=Prototype/Boiler&oldid=202847"