Prototype/Fluid: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
(Removed old prototype docs)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
== Mandatory properties ==
<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/prototypes/FluidPrototype.html https://lua-api.factorio.com/latest/prototypes/FluidPrototype.html]
Inherits all properties from [[Prototype]].


=== icons, icon,  icon_size (IconSpecification) ===
</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>
'''Type''': [[Types/IconSpecification]]
 
=== subgroup ===
'''Type''': [[Types/string]]
 
'''Default''': "fluid"
 
The value of this property may not be an empty string. It either has to be nil, or a non-empty string.
 
=== default_temperature ===
'''Type''': [[Types/double]]
 
Also the minimum temperature of the fluid.
 
=== max_temperature ===
'''Type''': [[Types/double]]
 
=== base_color ===
'''Type''': [[Types/Color]]
 
Used by bars that show the fluid color, like the flamethrower turret fill bar in the tooltip, or the fill bar for the fluidwagon tooltip; and for the pipe windows and storage tank fill gauges.
 
=== flow_color ===
'''Type''': [[Types/Color]]
 
Used only for pipe windows or storage tank fill gauges.
 
=== pressure_to_speed_ratio ===
'''Type''': [[Types/double]]
 
=== flow_to_energy_ratio ===
'''Type''': [[Types/double]]
 
Flow to energy ratio can't be negative.
 
== Optional properties ==
 
=== heat_capacity ===
'''Type''': [[Types/Energy]]
 
'''Default''': "1KJ"
 
Joule needed to heat 1 Unit by 1 °C.
 
=== fuel_value ===
'''Type''': [[Types/Energy]]
 
'''Default''': "0J"
 
=== emissions_multiplier ===
'''Type''': [[Types/double]]
 
'''Default''': 1.0
 
Scales pollution generated when the fluid is consumed.
 
=== gas_temperature ===
'''Type''': [[Types/double]]
 
'''Default''': max value of double (1.7976931348623158e+308)
 
=== max_push_amount ===
'''Type''': [[Types/double]]
 
'''Default''': 1
 
When two fluids interact how much of it can be pushed at most.
 
=== ratio_to_push ===
'''Type''': [[Types/double]]
 
'''Default''': 2.1
 
How much more height must one fluid have to push the other.
 
=== auto_barrel ===
'''Type''': [[Types/bool]]
 
Whether the fluid should be included in the barrel recipes automatically generated in data-updates.lua in the base mod. Not actually a property of the prototype, so it is discarded by the game when loading finishes.
 
== Example ==
<syntaxhighlight lang="lua"> {
    type = "fluid",
    name = "water",
    default_temperature = 15,
    max_temperature = 100,
    heat_capacity = "0.2KJ",
    base_color = {r=0, g=0.34, b=0.6},
    flow_color = {r=0.7, g=0.7, b=0.7},
    icon = "__base__/graphics/icons/fluid/water.png",
    icon_size = 32,
    order = "a[fluid]-a[water]",
    pressure_to_speed_ratio = 0.4,
    flow_to_energy_ratio = 0.59
  }</syntaxhighlight>

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/prototypes/FluidPrototype.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=Prototype/Fluid&oldid=202897"