FluidPrototype

A fluid.

Parent

• Prototype

Properties

icons

• Type: Array<IconData>
• Optional: true
• Override: false

Can't be an empty array.

icon

• Type: FileName
• Optional: true
• Override: false

Path to the icon file.

Only loaded, and mandatory if icons is not defined.

icon_size

• Type: SpriteSizeType
• Optional: true
• Override: false

The size of the square icon, in pixels. E.g. 32 for a 32px by 32px icon. Must be larger than 0.

Only loaded if icons is not defined.

default_temperature

• Type: float
• Optional: false
• Override: false

Also the minimum temperature of the fluid. Has to be lower than max_temperature.

base_color

• Type: Color
• Optional: false
• Override: false

Used by bars that show the fluid color, like the flamethrower turret fill bar in the tooltip, or the fill bar for the fluid wagon tooltip; and for the pipe windows and storage tank fill gauges.

flow_color

• Type: Color
• Optional: false
• Override: false

Used only for pipe windows or storage tank fill gauges.

visualization_color

• Type: Color
• Optional: true
• Override: false

Color to use for visualization. This color should be vibrant and easily distinguished.

If not specified, this will be auto-generated from base_color by converting to HSV, decreasing saturation by 10% and setting value to 80%.

max_temperature

• Type: float
• Optional: true
• Override: false

heat_capacity

• Type: Energy
• Optional: true
• Override: false

Joule needed to heat 1 Unit by 1 °C.

Examples

heat_capacity = "0.2kJ"

fuel_value

• Type: Energy
• Optional: true
• Override: false

Examples

fuel_value = "3MJ"

emissions_multiplier

• Type: double
• Optional: true
• Override: false

Scales pollution generated when the fluid is consumed.

gas_temperature

• Type: float
• Optional: true
• Override: false

Above this temperature the gas_flow animation is used to display the fluid inside storage tanks and pipes.

auto_barrel

• Type: boolean
• Optional: true
• Override: false

Whether the fluid should be included in the barrel recipes automatically generated by the base mod.

This property is not read by the game engine itself, but the base mod's data-updates.lua file. This means it is discarded by the game engine after loading finishes.

hidden

• Type: boolean
• Optional: true
• Override: true

Hides the fluid from the signal selection screen.