Prototype/Generator: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(1.1.47: destroy_non_fuel_fluid added)
(Removed old prototype docs)
 
(6 intermediate revisions by 3 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/GeneratorPrototype.html https://lua-api.factorio.com/latest/prototypes/GeneratorPrototype.html]
An entity that produces power from fluids, for example a [[steam engine]].


{{Prototype TOC|generator}}
</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]]}}
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]]}}
The effectivity of the generator with 0.5 being half as effective as a regular steam-engine generator.
 
{{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,&nbsp;maximum_temperature)&nbsp;-&nbsp;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.

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/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 on the forums.

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