Prototype/Generator: Difference between revisions
(Added prototype type to page) |
(0.17) |
||
| Line 10: | Line 10: | ||
Must be an electric energy source. | Must be an electric energy source. | ||
=== horizontal_animation === | === horizontal_animation === | ||
| Line 24: | Line 21: | ||
The effectivity of the generator with 0.5 being half as effective as a regular steam-engine generator. | The effectivity of the generator with 0.5 being half as effective as a regular steam-engine generator. | ||
== Optional properties == | == Optional properties == | ||
| Line 66: | Line 55: | ||
=== max_power_output === | === max_power_output === | ||
'''Type''': [[Types/Energy]] | '''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. | |||
Revision as of 16:51, 9 April 2019
Basics
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 burner 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 fluid_box is used, otherwise not read.
maximum_temperature
Type: Types/double
Mandatory if fluid_box is used, otherwise not read.
fluid_box
Type: Types/FluidBox
Mandatory if burner is not used, otherwise not read.