FluidPrototype - Prototype Docs

FluidPrototype 'fluid' Example code

A fluid.

Properties

icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
icon optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
default_temperature	:: float	Also the minimum temperature of the fluid. [...]
Also the minimum temperature of the fluid. [...]
base_color	:: Color	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.
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	:: Color	Used only for pipe windows or storage tank fill gauges.
Used only for pipe windows or storage tank fill gauges.
visualization_color optional	:: Color	Color to use for visualization. [...]
Color to use for visualization. [...]
max_temperature optional	:: float
heat_capacity optional	:: Energy	Joule needed to heat 1 Unit by 1 °C.
Joule needed to heat 1 Unit by 1 °C.
fuel_value optional	:: Energy
emissions_multiplier optional	:: double	Scales pollution generated when the fluid is consumed.
Scales pollution generated when the fluid is consumed.
gas_temperature optional	:: float	Above this temperature the `gas_flow` animation is used to display the fluid inside storage tanks and pipes.
Above this temperature the `gas_flow` animation is used to display the fluid inside storage tanks and pipes.
auto_barrel optional	:: boolean	Whether the fluid should be included in the barrel recipes automatically generated by the base mod. [...]
Whether the fluid should be included in the barrel recipes automatically generated by the base mod. [...]

Inherited from Prototype

factoriopedia_alternative optional	:: string	The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]
custom_tooltip_fields optional	:: array[CustomTooltipField]	Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.

Inherited from PrototypeBase

type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
factoriopedia_description optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroup optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.
hidden[overridden] optional	:: boolean	Hides the fluid from the signal selection screen.
Hides the fluid from the signal selection screen.
hidden_in_factoriopedia optional	:: boolean
parameter optional	:: boolean	Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
factoriopedia_simulation optional	:: SimulationDefinition	The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.

base_color	:: Color	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.
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.
default_temperature	:: float	Also the minimum temperature of the fluid. [...]
Also the minimum temperature of the fluid. [...]
flow_color	:: Color	Used only for pipe windows or storage tank fill gauges.
Used only for pipe windows or storage tank fill gauges.
auto_barrel optional	:: boolean	Whether the fluid should be included in the barrel recipes automatically generated by the base mod. [...]
Whether the fluid should be included in the barrel recipes automatically generated by the base mod. [...]
emissions_multiplier optional	:: double	Scales pollution generated when the fluid is consumed.
Scales pollution generated when the fluid is consumed.
fuel_value optional	:: Energy
gas_temperature optional	:: float	Above this temperature the `gas_flow` animation is used to display the fluid inside storage tanks and pipes.
Above this temperature the `gas_flow` animation is used to display the fluid inside storage tanks and pipes.
heat_capacity optional	:: Energy	Joule needed to heat 1 Unit by 1 °C.
Joule needed to heat 1 Unit by 1 °C.
icon optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
max_temperature optional	:: float
visualization_color optional	:: Color	Color to use for visualization. [...]
Color to use for visualization. [...]

Inherited from Prototype

custom_tooltip_fields optional	:: array[CustomTooltipField]	Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.
factoriopedia_alternative optional	:: string	The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]

Inherited from PrototypeBase

name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
factoriopedia_description optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
factoriopedia_simulation optional	:: SimulationDefinition	The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.
hidden[overridden] optional	:: boolean	Hides the fluid from the signal selection screen.
Hides the fluid from the signal selection screen.
hidden_in_factoriopedia optional	:: boolean
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
parameter optional	:: boolean	Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
subgroup optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.

Properties

icons :: array[IconData] optional

Can't be an empty array.

icon :: FileName optional

Path to the icon file.

Only loaded, and mandatory if icons is not defined.

icon_size :: SpriteSizeType optional

Default: 64

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 :: float

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

base_color :: Color

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 :: Color

Used only for pipe windows or storage tank fill gauges.

visualization_color :: Color optional

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 :: float optional

Default: value of default_temperature

heat_capacity :: Energy optional

Default: "1kJ"

Joule needed to heat 1 Unit by 1 °C.

Example

heat_capacity = "0.2kJ"

fuel_value :: Energy optional

Default: "0J"

Example

fuel_value = "3MJ"

emissions_multiplier :: double optional

Default: 1.0

Scales pollution generated when the fluid is consumed.

gas_temperature :: float optional

Default: max value of float

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

auto_barrel :: boolean optional

Default: true

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.

Overridden Properties

hidden :: boolean optional

Default: false

Hides the fluid from the signal selection screen.

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 = 64,
  order = "a[fluid]-a[water]"
}

Factorio Prototype Docs Version 2.0.72

FluidPrototype 'fluid' Example code

Properties

Properties

icons :: array[IconData] optional

icon :: FileName optional

icon_size :: SpriteSizeType optional

default_temperature :: float

base_color :: Color

flow_color :: Color

visualization_color :: Color optional

max_temperature :: float optional

heat_capacity :: Energy optional

Example

fuel_value :: Energy optional

Example

emissions_multiplier :: double optional

gas_temperature :: float optional

auto_barrel :: boolean optional

Overridden Properties

hidden :: boolean optional

Example

Prototypes

Types

Defines

Factorio Prototype DocsVersion 2.0.72

FluidPrototype 'fluid' Example code

Properties

Properties

icons :: array[IconData] optional

icon :: FileName optional

icon_size :: SpriteSizeType optional

default_temperature :: float

base_color :: Color

flow_color :: Color

visualization_color :: Color optional

max_temperature :: float optional

heat_capacity :: Energy optional

Example

fuel_value :: Energy optional

Example

emissions_multiplier :: double optional

gas_temperature :: float optional

auto_barrel :: boolean optional

Overridden Properties

hidden :: boolean optional

Example

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.0.72