Prototype/Generator: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Converted to SMW format)
(Removed old prototype docs)
 
(10 intermediate revisions by 4 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]
A power generator, 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|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.
 
== 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}}
 
{{Prototype property|scale_fluid_usage|[[Types/bool|bool]]|false|optional=true}}
Scales the generator's fluid usage to its maximum power output.
 
{{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}}
Mandatory if <code>burner</code> is used, otherwise optional.
 
{{Prototype property|burner|[[Types/EnergySource|EnergySource]]|optional=true}}
Must be a burner energy source.
 
{{Prototype property|fluid_usage_per_tick|[[Types/double|double]]|optional=true}}
The number of fluid units the generator uses per tick.
 
Mandatory if <code>fluid_box</code> is used, otherwise not read.
 
{{Prototype property|maximum_temperature|[[Types/double|double]]|optional=true}}
Mandatory if <code>fluid_box</code> is used, otherwise not read.
 
{{Prototype property|fluid_box|[[Types/FluidBox|FluidBox]]|optional=true}}
Mandatory if <code>burner</code> is '''not''' used, otherwise not read.

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.