Prototype/Boiler: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
structure: fixed type: animation instead of sprite
BilkaBot (talk | contribs)
Removed old prototype docs
 
(5 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Prototype parent|Prototype/EntityWithHealth}}
<div class="stub"><p>'''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 https://lua-api.factorio.com/latest/prototypes/BoilerPrototype.html]
A [[boiler]].


{{Prototype TOC|boiler}}
</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>
 
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
 
{{Prototype property|energy_source|[[Types/EnergySource|EnergySource]]}}
 
{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]}}
 
{{Prototype property|output_fluid_box|[[Types/FluidBox|FluidBox]]}}
 
{{Prototype property|energy_consumption|[[Types/Energy|Energy]]}}
 
{{Prototype property|burning_cooldown|[[Types/uint32|uint32]]}}
Controls for how long 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]]}}
 
{{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.
 
{{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.
 
== Optional properties ==
 
{{Prototype property|fire_glow_flicker_enabled|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|fire_flicker_enabled|[[Types/bool|bool]]|false|optional=true}}
 
{{Prototype property|mode|[[Types/string|string]]|"heat-water-inside"|optional=true}}
One of "heat-water-inside" or "output-to-separate-pipe".
 
{{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]]

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.