Prototype/Boiler - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:44Z

Removed old prototype docs

← Older revision		Revision as of 14:32, 25 October 2024
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.~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:42:50Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:42, 21 September 2023
Line 1:		Line 1:
	'''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]		<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]

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

BilkaBot: Protected "Prototype/Boiler": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:06Z

Protected "Prototype/Boiler": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision		Revision as of 17:52, 16 August 2023
(No difference)

BilkaBot: Migrated prototype doc to separate website

2023-08-16T17:52:06Z

Migrated prototype doc to separate website

← Older revision		Revision as of 17:52, 16 August 2023
Line 1:		Line 1:
			'''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]

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



	{{Prototype parent\|Prototype/EntityWithOwner}}		{{Prototype parent\|Prototype/EntityWithOwner}}
	A [[boiler]].		A [[boiler]].

Bilka: 1.1.51: Prototype/EntityWithOwner added

2022-01-21T19:26:26Z

1.1.51: Prototype/EntityWithOwner added

← Older revision		Revision as of 19:26, 21 January 2022
Line 1:		Line 1:
	{{Prototype parent\|Prototype/~~EntityWithHealth~~}}		{{Prototype parent\|Prototype/EntityWithOwner}}
	A [[boiler]].		A [[boiler]].

Line 5:		Line 5:

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

	{{Prototype property\|energy_source\|[[Types/EnergySource\|EnergySource]]}}		{{Prototype property\|energy_source\|[[Types/EnergySource\|EnergySource]]}}

Bilka: Mode explanation, more info on graphics

2021-11-23T12:09:27Z

Mode explanation, more info on graphics

← Older revision		Revision as of 12:09, 23 November 2021
Line 10:		Line 10:

	{{Prototype property\|fluid_box\|[[Types/FluidBox\|FluidBox]]}}		{{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]]}}		{{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\|energy_consumption\|[[Types/Energy\|Energy]]}}

	{{Prototype property\|burning_cooldown\|[[Types/uint32\|uint32]]}}		{{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.		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.		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\|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]]}}		{{Prototype property\|structure\|[[Types/table\|table]]}}
Line 39:		Line 46:

	This means the table itself is required, but can be empty.		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]]}}		{{Prototype property\|fire_glow\|[[Types/table\|table]]}}
Line 49:		Line 59:

	This means the table itself is required, but can be empty.		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 ==		== Optional properties ==

	{{Prototype property\|fire_glow_flicker_enabled\|[[Types/bool\|bool]]\|false\|optional=true}}		{{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}}		{{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}}		{{Prototype property\|mode\|[[Types/string\|string]]\|"heat-water-inside"\|optional=true}}
	One of "heat-water-inside" or "output-to-separate-pipe".		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}}		{{Prototype property\|patch\|[[Types/table\|table]]\|optional=true}}
Line 66:		Line 83:
	* south - [[Types/Sprite\|Sprite]]		* south - [[Types/Sprite\|Sprite]]
	* west - [[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.

Bilka: /* structure */ fixed type: animation instead of sprite

2020-10-21T09:07:21Z

structure: fixed type: animation instead of sprite

← Older revision		Revision as of 09:07, 21 October 2020
Line 25:		Line 25:
	Table with the following mandatory members:		Table with the following mandatory members:

	* north - [[Types/~~Sprite~~\|~~Sprite~~]]		* north - [[Types/Animation\|Animation]]
	* east - [[Types/~~Sprite~~\|~~Sprite~~]]		* east - [[Types/Animation\|Animation]]
	* south - [[Types/~~Sprite~~\|~~Sprite~~]]		* south - [[Types/Animation\|Animation]]
	* west - [[Types/~~Sprite~~\|~~Sprite~~]]		* west - [[Types/Animation\|Animation]]

	{{Prototype property\|fire\|[[Types/table\|table]]}}		{{Prototype property\|fire\|[[Types/table\|table]]}}

Bilka: Better burning_cooldown description

2020-04-29T14:51:04Z

Better burning_cooldown description

← Older revision		Revision as of 14:51, 29 April 2020
Line 16:		Line 16:

	{{Prototype property\|burning_cooldown\|[[Types/uint32\|uint32]]}}		{{Prototype property\|burning_cooldown\|[[Types/uint32\|uint32]]}}
	~~Related~~ to the light and the ~~animation~~		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\|target_temperature\|[[Types/double\|double]]}}

PyroFire at 13:35, 28 April 2020

2020-04-28T13:35:17Z

← Older revision		Revision as of 13:35, 28 April 2020
Line 16:		Line 16:

	{{Prototype property\|burning_cooldown\|[[Types/uint32\|uint32]]}}		{{Prototype property\|burning_cooldown\|[[Types/uint32\|uint32]]}}
			Related to the light and the animation

	{{Prototype property\|target_temperature\|[[Types/double\|double]]}}		{{Prototype property\|target_temperature\|[[Types/double\|double]]}}

Bilka: fire_glow, fire are mandatory

2020-04-01T18:27:36Z

fire_glow, fire are mandatory

@@ Line 26: / Line 26: @@
 * south - [[Types/Sprite|Sprite]]
 * west - [[Types/Sprite|Sprite]]
 == Optional properties ==
@@ Line 43: / Line 63: @@
 * south - [[Types/Sprite|Sprite]]
 * west - [[Types/Sprite|Sprite]]

← Older revision		Revision as of 09:07, 21 October 2020
Line 25:		Line 25:
	Table with the following mandatory members:		Table with the following mandatory members:

	* north - [[Types/~~Sprite~~\|~~Sprite~~]]		* north - [[Types/Animation\|Animation]]
	* east - [[Types/~~Sprite~~\|~~Sprite~~]]		* east - [[Types/Animation\|Animation]]
	* south - [[Types/~~Sprite~~\|~~Sprite~~]]		* south - [[Types/Animation\|Animation]]
	* west - [[Types/~~Sprite~~\|~~Sprite~~]]		* west - [[Types/Animation\|Animation]]

	{{Prototype property\|fire\|[[Types/table\|table]]}}		{{Prototype property\|fire\|[[Types/table\|table]]}}