Prototype/Fluid: Difference between revisions
m (→Mandatory properties: default_temperature description) |
(1.1) |
||
| Line 11: | Line 11: | ||
{{Prototype property|default_temperature|[[Types/double|double]]}} | {{Prototype property|default_temperature|[[Types/double|double]]}} | ||
Also the minimum temperature of the fluid. Has to be lower than <code>max_temperature</code>. | Also the minimum temperature of the fluid. Has to be lower than <code>max_temperature</code>. | ||
{{Prototype property|base_color|[[Types/Color|Color]]}} | {{Prototype property|base_color|[[Types/Color|Color]]}} | ||
| Line 21: | Line 19: | ||
== Optional properties == | == Optional properties == | ||
{{Prototype property|max_temperature|[[Types/double|double]]|value of <code>default_temperature</code>|optional=true}} | |||
{{Prototype property|heat_capacity|[[Types/Energy|Energy]]|"1KJ"|optional=true}} | {{Prototype property|heat_capacity|[[Types/Energy|Energy]]|"1KJ"|optional=true}} | ||
Revision as of 19:37, 2 December 2020
Template:Prototype parent A fluid.
Mandatory properties
Inherits all properties from PrototypeBase.
Template:Prototype property
Also the minimum temperature of the fluid. Has to be lower than max_temperature.
Template:Prototype property 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.
Template:Prototype property Used only for pipe windows or storage tank fill gauges.
Optional properties
Template:Prototype property Joule needed to heat 1 Unit by 1 °C.
Template:Prototype property Scales pollution generated when the fluid is consumed.
Template:Prototype property The value of this property may not be an empty string. It either has to be nil, or a non-empty string.
Template:Prototype property
Above this temperature the gas_flow animation is used to display the fluid inside storage tanks and pipes.
Template:Prototype property Hides the fluid from the signal selection screen.
Custom properties
The base mod reads the following property in data-updates.lua to determine if the fluid should be barreled. The property itself is not read by the C++ part of the game which means that it is discarded by the game when loading finishes.
- auto_barrel - bool - Optional, defaults to true. Whether the fluid should be included in the barrel recipes automatically generated in data-updates.lua in the base mod.
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
}