Types/EnergySource: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
No edit summary
(Added information about type "fluid".)
Line 4: Line 4:
'''Type''': [[Types/string]]
'''Type''': [[Types/string]]


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


=== emissions ===
=== emissions ===
Line 106: Line 106:
=== pipe_covers ===
=== pipe_covers ===
'''Type''': [[Types/Sprite4Way]]
'''Type''': [[Types/Sprite4Way]]
== Void energy source ==
Void is free energy, there are no additional entries required.
== Fluid energy source ==
=== fluid_box ===
'''Type''': [[Types/FluidBox]]
The fluid type energy source MUST have a fluid box defined.
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]]
Array of 1 or more smoke sources.
=== light_flicker ===
'''Type''': [[Types/LightFlickeringDefinition]]
=== effectivity ===
'''Type''': [[Types/double]]
'''Default''': 1
1 means 100% effectivity. Can't be 0.
=== burns_fluid ===
'''Type''': [[Types/bool]]
'''Default''': false
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
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/bool]]
'''Default''': false
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
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.

Revision as of 16:26, 14 March 2019

Basics

Specifies the way the entity gets its energy.

type

Type: Types/string

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

emissions

Type: Types/double

Default: 0

The pollution an entity emits is emissions times the energy consumption in kW. (This gives you the number that is shown in the entiy tooltip.)

render_no_power_icon

Type: Types/bool

Default: true

Whether to render the Electricity-icon-red.png icon on the entity if it is low on power. Also applies to Fuel-icon-red.png when using a burner energy source.

render_no_network_icon

Type: Types/bool

Default: true

Whether to render the Electricity-icon-unplugged.png icon on the entity if it is not connected to a electric network.

Electric energy source

buffer_capacity

Type: Types/Energy

How much power the entity holds.

usage_priority

Type: Types/ElectricUsagePriority

input_flow_limit

Type: Types/Energy

Default: 0

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

output_flow_limit

Type: Types/Energy

Default: 0

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

drain

Type: Types/Energy

Burner

fuel_inventory_size

Type: Types/ItemStackIndex

burnt_inventory_size

Type: Types/ItemStackIndex

Default: 0

smoke

Type: Types/table of Types/SmokeSource

Array of 1 or more smoke sources.

light_flicker

Type: Types/LightFlickeringDefinition

effectivity

Type: Types/double

Default: 1

1 means 100% effectivity. Can't be 0.

fuel_category

Type: Types/string

Default: "chemical"

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

fuel_categories

Type: Types/table of Types/string

Same as above, only one of them can exist.

Heat energy source

max_temperature

Type: Types/double

specific_heat

Type: Types/Energy

max_transfer

Type: Types/Energy

min_temperature_gradient

Type: Types/double

Default: 1

connections

Type: Types/table of Types/HeatConnection

pipe_covers

Type: Types/Sprite4Way

Void energy source

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

Fluid energy source

fluid_box

Type: Types/FluidBox

The fluid type energy source MUST have a fluid box defined. 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

Array of 1 or more smoke sources.

light_flicker

Type: Types/LightFlickeringDefinition

effectivity

Type: Types/double

Default: 1

1 means 100% effectivity. Can't be 0.

burns_fluid

Type: Types/bool

Default: false

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

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/bool

Default: false

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 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.