Prototype/Generator - Revision history

BilkaBot: Removed old prototype docs

2024-10-25T14:32:52Z

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}}~~
	~~An entity that produces power from fluids, for example a [[steam engine]].~~

	~~{{Prototype TOC\|generator}}~~

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

	~~{{Prototype property\|energy_source\|[[Types/EnergySource\|EnergySource]]}}~~
	~~Must be an electric energy source.~~

	~~{{Prototype property\|fluid_box\|[[Types/FluidBox\|FluidBox]]}}~~
	~~This must have a filter if <code>max_power_output</code> is not defined.~~

	~~{{Prototype property\|horizontal_animation\|[[Types/Animation\|Animation]]}}~~

	~~{{Prototype property\|vertical_animation\|[[Types/Animation\|Animation]]}}~~

	~~{{Prototype property\|effectivity\|[[Types/double\|double]]}}~~
	~~How much energy the generator produces compared to how much energy it consumes. For example, an effectivity of 0.5 means that half of the consumed energy is output as power.~~

	~~{{Prototype property\|fluid_usage_per_tick\|[[Types/double\|double]]}}~~
	~~The number of fluid units the generator uses per tick.~~

	~~{{Prototype property\|maximum_temperature\|[[Types/double\|double]]}}~~
	Used to calculate the <code>max_power_output</code> if it is not defined and <code>burns_fluid</code> is false. Then, the max power output is <code>(min(fluid_max_temp, maximum_temperature) - fluid_default_temp) × fluid_usage_per_tick × fluid_heat_capacity × effectivity</code>, the fluid is the filter specified on the <code>fluid_box</code>.

	~~The maximum temperature to which the efficiency can increase. At this temperature the generator will run at 100% efficiency. Note: Higher temperature fluid can still be consumed.~~

	~~== Optional properties ==~~

	~~{{Prototype property\|smoke\|[[Types/table\|table]] of [[Types/SmokeSource\|SmokeSource]]\|optional=true}}~~
	~~Array of 1 or more smoke sources.~~

	~~{{Prototype property\|burns_fluid\|[[Types/bool\|bool]]\|false\|optional=true}}~~
	~~If set to true, the available power output is based on the [[Prototype/Fluid#fuel_value\|fuel_value]] of the fluid. Otherwise, the available power output will be based on the fluid temperature.~~

	~~{{Prototype property\|scale_fluid_usage\|[[Types/bool\|bool]]\|false\|optional=true}}~~
	~~Scales the generator's fluid usage to its maximum power output.~~

	~~Setting this to true prevents the generator from overconsuming fluid, for example when higher than <code>maximum_temperature</code> fluid is fed to the generator.<br>~~
	If scale_fluid_usage is false, the generator consumes the full <code>fluid_usage_per_tick</code> and any of the extra energy in the fluid (in the form of higher temperature) is wasted. The [[steam engine]] exhibits this behavior when fed steam from [[heat exchanger]]s.

	~~{{Prototype property\|destroy_non_fuel_fluid\|[[Types/bool\|bool]]\|true\|optional=true}}~~
	~~This property is used when:~~
	* <code>burns_fluid</code> is true and the fluid has a [[Prototype/Fluid#fuel_value\|fuel_value]] of 0
	* or <code>burns_fluid</code> is false and the fluid is at default temperature
	~~In these cases, this property determines whether the fluid should be destroyed, meaning that the fluid is consumed at the rate of <code>fluid_usage_per_tick</code>, without producing any power.~~

	~~{{Prototype property\|min_perceived_performance\|[[Types/double\|double]]\|0.25\|optional=true}}~~
	~~Animation runs at least this fast. This corresponds to the sound.~~

	~~{{Prototype property\|performance_to_sound_speedup\|[[Types/double\|double]]\|0.5\|optional=true}}~~

	~~{{Prototype property\|max_power_output\|[[Types/Energy\|Energy]]\|optional=true}}~~
	~~The power production of the generator is capped to this value. This is also the value that is shown as the maximum power output in the tooltip of the generator.~~

	~~<code>fluid_box</code> must have a filter if this is not defined.~~

BilkaBot: Updated styling of prototype doc migration note

2023-09-21T10:43:07Z

Updated styling of prototype doc migration note

← Older revision		Revision as of 10:43, 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/GeneratorPrototype.html https://lua-api.factorio.com/latest/prototypes/GeneratorPrototype.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/GeneratorPrototype.html https://lua-api.factorio.com/latest/prototypes/GeneratorPrototype.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/Generator": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2023-08-16T17:52:34Z

Protected "Prototype/Generator": 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:34Z

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/GeneratorPrototype.html https://lua-api.factorio.com/latest/prototypes/GeneratorPrototype.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}}
	An entity that produces power from fluids, for example a [[steam engine]].		An entity that produces power from fluids, for example a [[steam engine]].

Bilka: added example for effectivity

2022-04-22T13:29:39Z

added example for effectivity

← Older revision		Revision as of 13:29, 22 April 2022
Line 18:		Line 18:

	{{Prototype property\|effectivity\|[[Types/double\|double]]}}		{{Prototype property\|effectivity\|[[Types/double\|double]]}}
	How much energy the generator produces compared to how much energy it consumes.		How much energy the generator produces compared to how much energy it consumes. For example, an effectivity of 0.5 means that half of the consumed energy is output as power.

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

Curiosity: explain effectivity better

2022-04-16T07:18:33Z

explain effectivity better

← Older revision		Revision as of 07:18, 16 April 2022
Line 18:		Line 18:

	{{Prototype property\|effectivity\|[[Types/double\|double]]}}		{{Prototype property\|effectivity\|[[Types/double\|double]]}}
	~~The effectivity of~~ the generator ~~with 0.5 being half as effective as a regular steam-engine generator~~.		How much energy the generator produces compared to how much energy it consumes.

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

Bilka: 1.1.51: Prototype/EntityWithOwner added

2022-01-21T19:26:47Z

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}}
	An entity that produces power from fluids, for example a [[steam engine]].		An entity that produces power from fluids, for example a [[steam engine]].

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: 1.1.47: destroy_non_fuel_fluid added

2021-11-26T11:13:18Z

1.1.47: destroy_non_fuel_fluid added

← Older revision		Revision as of 11:13, 26 November 2021
Line 34:		Line 34:

	{{Prototype property\|burns_fluid\|[[Types/bool\|bool]]\|false\|optional=true}}		{{Prototype property\|burns_fluid\|[[Types/bool\|bool]]\|false\|optional=true}}
			If set to true, the available power output is based on the [[Prototype/Fluid#fuel_value\|fuel_value]] of the fluid. Otherwise, the available power output will be based on the fluid temperature.

	{{Prototype property\|scale_fluid_usage\|[[Types/bool\|bool]]\|false\|optional=true}}		{{Prototype property\|scale_fluid_usage\|[[Types/bool\|bool]]\|false\|optional=true}}
Line 40:		Line 41:
	Setting this to true prevents the generator from overconsuming fluid, for example when higher than <code>maximum_temperature</code> fluid is fed to the generator.<br>		Setting this to true prevents the generator from overconsuming fluid, for example when higher than <code>maximum_temperature</code> fluid is fed to the generator.<br>
	If scale_fluid_usage is false, the generator consumes the full <code>fluid_usage_per_tick</code> and any of the extra energy in the fluid (in the form of higher temperature) is wasted. The [[steam engine]] exhibits this behavior when fed steam from [[heat exchanger]]s.		If scale_fluid_usage is false, the generator consumes the full <code>fluid_usage_per_tick</code> and any of the extra energy in the fluid (in the form of higher temperature) is wasted. The [[steam engine]] exhibits this behavior when fed steam from [[heat exchanger]]s.

			{{Prototype property\|destroy_non_fuel_fluid\|[[Types/bool\|bool]]\|true\|optional=true}}
			This property is used when:
			* <code>burns_fluid</code> is true and the fluid has a [[Prototype/Fluid#fuel_value\|fuel_value]] of 0
			* or <code>burns_fluid</code> is false and the fluid is at default temperature
			In these cases, this property determines whether the fluid should be destroyed, meaning that the fluid is consumed at the rate of <code>fluid_usage_per_tick</code>, without producing any power.

	{{Prototype property\|min_perceived_performance\|[[Types/double\|double]]\|0.25\|optional=true}}		{{Prototype property\|min_perceived_performance\|[[Types/double\|double]]\|0.25\|optional=true}}

Bilka: maximum_temperature clarification, max_power_output and scale_fluid_usage explanation

2021-11-04T18:22:40Z

maximum_temperature clarification, max_power_output and scale_fluid_usage explanation

← Older revision		Revision as of 18:22, 4 November 2021
Line 11:		Line 11:

	{{Prototype property\|fluid_box\|[[Types/FluidBox\|FluidBox]]}}		{{Prototype property\|fluid_box\|[[Types/FluidBox\|FluidBox]]}}
			This must have a filter if <code>max_power_output</code> is not defined.

	{{Prototype property\|horizontal_animation\|[[Types/Animation\|Animation]]}}		{{Prototype property\|horizontal_animation\|[[Types/Animation\|Animation]]}}
Line 23:		Line 24:

	{{Prototype property\|maximum_temperature\|[[Types/double\|double]]}}		{{Prototype property\|maximum_temperature\|[[Types/double\|double]]}}
	The maximum temperature to which the efficiency can increase. ~~After~~ this temperature the generator will run at 100% efficiency. Note: ~~higher temperatures~~ can still be consumed.		Used to calculate the <code>max_power_output</code> if it is not defined and <code>burns_fluid</code> is false. Then, the max power output is <code>(min(fluid_max_temp, maximum_temperature) - fluid_default_temp) × fluid_usage_per_tick × fluid_heat_capacity × effectivity</code>, the fluid is the filter specified on the <code>fluid_box</code>.

			The maximum temperature to which the efficiency can increase. At this temperature the generator will run at 100% efficiency. Note: Higher temperature fluid can still be consumed.

	== Optional properties ==		== Optional properties ==
Line 34:		Line 37:
	{{Prototype property\|scale_fluid_usage\|[[Types/bool\|bool]]\|false\|optional=true}}		{{Prototype property\|scale_fluid_usage\|[[Types/bool\|bool]]\|false\|optional=true}}
	Scales the generator's fluid usage to its maximum power output.		Scales the generator's fluid usage to its maximum power output.

			Setting this to true prevents the generator from overconsuming fluid, for example when higher than <code>maximum_temperature</code> fluid is fed to the generator.<br>
			If scale_fluid_usage is false, the generator consumes the full <code>fluid_usage_per_tick</code> and any of the extra energy in the fluid (in the form of higher temperature) is wasted. The [[steam engine]] exhibits this behavior when fed steam from [[heat exchanger]]s.

	{{Prototype property\|min_perceived_performance\|[[Types/double\|double]]\|0.25\|optional=true}}		{{Prototype property\|min_perceived_performance\|[[Types/double\|double]]\|0.25\|optional=true}}
Line 41:		Line 47:

	{{Prototype property\|max_power_output\|[[Types/Energy\|Energy]]\|optional=true}}		{{Prototype property\|max_power_output\|[[Types/Energy\|Energy]]\|optional=true}}
			The power production of the generator is capped to this value. This is also the value that is shown as the maximum power output in the tooltip of the generator.

			<code>fluid_box</code> must have a filter if this is not defined.

Meifraye at 16:02, 21 October 2021

2021-10-21T16:02:20Z

← Older revision		Revision as of 16:02, 21 October 2021
Line 23:		Line 23:

	{{Prototype property\|maximum_temperature\|[[Types/double\|double]]}}		{{Prototype property\|maximum_temperature\|[[Types/double\|double]]}}
			The maximum temperature to which the efficiency can increase. After this temperature the generator will run at 100% efficiency. Note: higher temperatures can still be consumed.

	== Optional properties ==		== Optional properties ==