GeneratorPrototype

An entity that produces power from fluids, for example a steam engine.

Parent

• EntityWithOwnerPrototype

Properties

energy_source

• Type: ElectricEnergySource
• Optional: false
• Override: false

fluid_box

• Type: FluidBox
• Optional: false
• Override: false

This must have a filter if max_power_output is not defined.

horizontal_animation

• Type: Animation
• Optional: true
• Override: false

vertical_animation

• Type: Animation
• Optional: true
• Override: false

horizontal_frozen_patch

• Type: Sprite
• Optional: true
• Override: false

vertical_frozen_patch

• Type: Sprite
• Optional: true
• Override: false

effectivity

• Type: double
• Optional: true
• Override: false

How much energy the generator produces compared to how much energy it consumes. For example, an effectivity of 0.5 means that half of the consumed energy is output as power.

fluid_usage_per_tick

• Type: FluidAmount
• Optional: false
• Override: false

The number of fluid units the generator uses per tick.

maximum_temperature

• Type: float
• Optional: false
• Override: false

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.

Used to calculate the max_power_output if it is not defined and burns_fluid is false. Then, the max power output is (min(fluid_max_temp, maximum_temperature) - fluid_default_temp) × fluid_usage_per_tick × fluid_heat_capacity × effectivity, the fluid is the filter specified on the fluid_box.

smoke

• Type: Array<SmokeSource>
• Optional: true
• Override: false

burns_fluid

• Type: boolean
• Optional: true
• Override: false

If set to true, the available power output is based on the FluidPrototype::fuel_value. Otherwise, the available power output will be based on the fluid temperature and FluidPrototype::heat_capacity: energy = fluid_amount * (fluid_temperature - fluid_default_temperature) * fluid_heat_capacity * effectivity

scale_fluid_usage

• Type: boolean
• Optional: true
• Override: false

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 thanmaximum_temperature fluid is fed to the generator.

If scale_fluid_usage is false, the generator consumes the full fluid_usage_per_tick 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 exchangers.

destroy_non_fuel_fluid

• Type: boolean
• Optional: true
• Override: false

This property is used when burns_fluid is true and the fluid has a fuel_value of 0.

This property is also used when burns_fluid 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 fluid_usage_per_tick, without producing any power.

perceived_performance

• Type: PerceivedPerformance
• Optional: true
• Override: false

Affects animation speed and working sound.

max_power_output

• Type: Energy
• Optional: true
• Override: false

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.

fluid_box must have a filter if this is not defined.