Prototype/Generator: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
m (→‎Optional properties: note on smoke)
(Removed old prototype docs)
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== Basics ==
<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]].
== Mandatory properties ==
This prototype inherits all the properties from [[Prototype/EntityWithHealth]].


=== energy_source ===
</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>
'''Type''': [[Types/EnergySource]]
 
Must be an electric energy source.
 
=== fluid_box ===
'''Type''': [[Types/FluidBox]]
 
=== 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.
 
=== fluid_usage_per_tick ===
'''Type''': [[Types/double]]
 
The number of fluid units the generator uses per tick.
 
=== maximum_temperature ===
'''Type''': [[Types/double]]
 
== 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]]

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.