Types/EnergySource: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Doc is for "what this does", not "what this should do" or "what something else does")
(Removed old prototype docs)
Tag: Replaced
 
(29 intermediate revisions by 7 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/types/EnergySource.html https://lua-api.factorio.com/latest/types/EnergySource.html]
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.
</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>
 
=== emissions_per_second_per_watt ===
'''Type''': [[Types/double]]
 
'''Default''': 0
 
Optional. Preferred over using <code>emissions</code>. 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 <code>emissions_per_second_per_watt</code> but will be removed at some point.
 
=== render_no_power_icon ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
Optional. Whether to render the [[File:Electricity-icon-red.png|50px]] icon on the entity if it is low on power. Also applies to [[File:Fuel-icon-red.png|50px]] when using a burner energy source.
 
=== render_no_network_icon ===
'''Type''': [[Types/bool]]
 
'''Default''': true
 
Optional. Whether to render the [[File:Electricity-icon-unplugged.png|50px]] 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 [[Prototype/FuelCategory|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. Does not do anything.

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/types/EnergySource.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.

Retrieved from "https://wiki.factorio.com/index.php?title=Types/EnergySource&oldid=202673"