Prototype/Generator: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Set prototype parent)
(Removed old prototype docs)
 
(11 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]


== Basics ==
</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 type: '''generator'''
 
A power generator, for example a [[steam engine]].
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].
 
=== energy_source ===
'''Type''': [[Types/EnergySource]]
 
Must be an electric energy source.
 
=== horizontal_animation ===
'''Type''': [[Types/Animation]]
 
=== vertical_animation ===
'''Type''': [[Types/Animation]]
 
=== effectivity ===
'''Type''': [[Types/double]]
 
The effectivity of the generator with 0.5 being half as effective as a regular steam-engine generator.
 
== Optional properties ==
 
=== smoke ===
'''Type''': [[Types/table]] of [[Types/SmokeSource]]
 
Array of 1 or more smoke sources.
 
=== burns_fluid ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
=== scale_fluid_usage ===
'''Type''': [[Types/bool]]
 
'''Default''': false
 
Scales the generator's fluid usage to its maximum power output.
 
=== min_perceived_performance ===
'''Type''': [[Types/double]]
 
'''Default''': 0.25
 
Animation runs at least this fast. This corresponds to the sound.
 
=== performance_to_sound_speedup ===
'''Type''': [[Types/double]]
 
'''Default''': 0.5
 
=== max_power_output ===
'''Type''': [[Types/Energy]]
 
Mandatory if <code>burner</code> is used, otherwise optional.
 
=== burner ===
'''Type''': [[Types/EnergySource]]
 
Must be a burner energy source.
 
=== fluid_usage_per_tick ===
'''Type''': [[Types/double]]
 
The number of fluid units the generator uses per tick.
 
Mandatory if <code>fluid_box</code> is used, otherwise not read.
 
=== maximum_temperature ===
'''Type''': [[Types/double]]
 
Mandatory if <code>fluid_box</code> is used, otherwise not read.
 
=== fluid_box ===
'''Type''': [[Types/FluidBox]]
 
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.

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