Types/EnergySource

Basics

Specifies the way the entity gets its energy.

type

Type: Types/string

Mandatory. Only valid values are "electric", "burner", "heat", "fluid" or "void", it specifies the type of the energy source to be used.

emissions_per_second_per_watt

Type: Types/double

Default: 0

Optional. Preferred over using emissions. The pollution an entity emits per second is emissions_per_second_per_watt times the energy consumption in W. (This gives you the number that is shown in the entiy tooltip.)

emissions

Type: Types/double

Default: 0

Optional. Does the same thing as emissions_per_second_per_watt but will be removed at some point.

render_no_power_icon

Type: Types/bool

Default: true

Optional. Whether to render the icon on the entity if it is low on power. Also applies to when using a burner energy source.

render_no_network_icon

Type: Types/bool

Default: true

Optional. Whether to render the icon on the entity if it is not connected to a electric network.

Electric energy source

buffer_capacity

Type: Types/Energy

Optional. How much power the entity holds.

usage_priority

Type: Types/ElectricUsagePriority

Mandatory.

input_flow_limit

Type: Types/Energy

Default: 0

Optional. How fast the energy can flow into the entity. 0 means no limit.

output_flow_limit

Type: Types/Energy

Default: 0

Optional. How fast the energy can flow out of the entity. 0 means no limit.

drain

Type: Types/Energy

Optional.

Burner

fuel_inventory_size

Type: Types/ItemStackIndex

Mandatory.

burnt_inventory_size

Type: Types/ItemStackIndex

Default: 0

Optional.

smoke

Type: Types/table of Types/SmokeSource

Optional. Array of 1 or more smoke sources.

light_flicker

Type: Types/LightFlickeringDefinition

Optional.

effectivity

Type: Types/double

Default: 1

Optional. 1 means 100% effectivity. Must be greater than 0

fuel_category

Type: Types/string

Default: "chemical"

Optional. The energy source can be used with fuel from this fuel category.

fuel_categories

Type: Types/table of Types/string

Optional. Same as above, only one of them can exist.

Heat energy source

max_temperature

Type: Types/double

Mandatory. max_temperature must be >= default_temperature.

default_temperature

Type: Types/double

Default: 15

Optional.

specific_heat

Type: Types/Energy

Mandatory.

max_transfer

Type: Types/Energy

Mandatory.

min_temperature_gradient

Type: Types/double

Default: 1

Optional.

min_working_temperature

Type: Types/double

Default: 15

Optional. min_working_temperature must be >= default_temperature. min_working_temperature must be <= max_temperature.

connections

Type: Types/table of Types/HeatConnection

Optional. The table may only contain up to 32 connections.

pipe_covers

Type: Types/Sprite4Way

Optional.

Void energy source

Void is free energy, there are no additional entries required.

Fluid energy source

fluid_box

Type: Types/FluidBox

Mandatory. All standard fluid box configurations are acceptable, but the type must be "input" or "input-output" to function correctly. In the default configuration, all fluid that enters the fluid box will be consumed instantly. it is recommended you set scale_fluid_usage, fluid_usage_per_tick or both to prevent this behaviour.

smoke

Type: Types/table of Types/SmokeSource

Optional. Array of 1 or more smoke sources.

light_flicker

Type: Types/LightFlickeringDefinition

Optional.

effectivity

Type: Types/double

Default: 1

Optional. 1 means 100% effectivity. Must be greater than 0

burns_fluid

Type: Types/bool

Default: false

Optional. If set to true, the energy source will calculate power based on the fluid's fuel_value entry, else it will calculate based on fluid temperature, like Prototype/Generator.

scale_fluid_usage

Type: Types/bool

Default: false

Optional. If set to true, the energy source will consume as much fluid as required to produce the desired power, if set to false it will consume as much as it is allowed to, wasting any excess.

fluid_usage_per_tick

Type: Types/double

Default: 0

Optional. The number of fluid units the energy source uses per tick. if used with scale_fluid_usage, this specifies the maximum.

maximum_temperature

Type: Types/double

Default: unlimited

Mandatory if this does not burn fluid, otherwise not read. Based on steam engine mechanics, this specifies the maximum temperature of the fluid of which energy can be extracted. If a fluid of a higher temperature enters and scale_fluid_usage is true then less fluid is consumed. if the scale_fluid_usage is false the excess energy is wasted.