Prototype/Fluid: Difference between revisions
(Changed links going to the redirect Prototype to go to PrototypeBase.) |
(Set prototype parent) |
||
Line 1: | Line 1: | ||
{{Prototype parent|PrototypeBase}} | |||
== Basics == | == Basics == | ||
Prototype type: '''fluid''' | Prototype type: '''fluid''' |
Revision as of 14:48, 24 July 2019
Basics
Prototype type: fluid
A fluid.
Mandatory properties
Inherits all properties from PrototypeBase.
icons, icon, icon_size (IconSpecification)
Type: Types/IconSpecification
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.
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.
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.
gas_temperature
Type: Types/double
Default: max value of double (1.7976931348623158e+308)
Type: Types/bool
Default: false
Hides the fluid from the signal selection screen.
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
{
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
}