FluidBox

Used to set the fluid amount an entity can hold, as well as the connection points for pipes leading into and out of the entity.

Entities can have multiple fluidboxes. These can be part of a FluidEnergySource, or be specified directly in the entity prototype.

Type

struct

Properties

volume

• Type: FluidAmount
• Optional: false

Must be greater than 0.

pipe_connections

• Type: Array<PipeConnectionDefinition>
• Optional: false

Connection points to connect to other fluidboxes. This is also marked as blue arrows in alt mode. Fluid may flow in or out depending on the type field of each connection.

Connection points may depend on the direction the entity is facing. These connection points cannot share positions with one another or the connection points of another fluid box belonging to the same entity.

Can't have more than 255 connections.

filter

• Type: FluidID
• Optional: true

Can be used to specify which fluid is allowed to enter this fluid box. See here.

render_layer

• Type: RenderLayer
• Optional: true

draw_only_when_connected

• Type: boolean
• Optional: true

hide_connection_info

• Type: boolean
• Optional: true

Hides the blue input/output arrows and icons at each connection point.

volume_reservation_fraction

• Type: float
• Optional: true

A fraction of the volume that will be "reserved" and cannot be removed by flow operations. This does nothing if the fluidbox is part of a fluid segment.

pipe_covers

• Type: Sprite4Way
• Optional: true

The pictures to show when no fluid box is connected to this one.

pipe_covers_frozen

• Type: Sprite4Way
• Optional: true

pipe_picture

• Type: Sprite4Way
• Optional: true

pipe_picture_frozen

• Type: Sprite4Way
• Optional: true

mirrored_pipe_picture

• Type: Sprite4Way
• Optional: true

Pipe picture variation used when owner machine is flipped. If no picture is loaded, pipe_picture is used instead.

mirrored_pipe_picture_frozen

• Type: Sprite4Way
• Optional: true

Frozen pipe picture variation used when owner machine is flipped. If no picture is loaded, pipe_picture_frozen is used instead.

minimum_temperature

• Type: float
• Optional: true

The minimum temperature allowed into the fluidbox. Only applied if a filter is specified.

Examples

minimum_temperature = 100.0

maximum_temperature

• Type: float
• Optional: true

The maximum temperature allowed into the fluidbox. Only applied if a filter is specified.

Examples

maximum_temperature = 1000.0

max_pipeline_extent

• Type: uint32
• Optional: true

The max extent that a pipeline with this fluidbox can span. A given pipeline's extent is calculated as the min extent of all the fluidboxes that comprise it.

production_type

• Type: ProductionType
• Optional: true

secondary_draw_order

• Type: int8
• Optional: true

Set the secondary draw order for all orientations. Used to determine render order for sprites with the same render_layer in the same position. Sprites with a higher secondary_draw_order are drawn on top.

secondary_draw_orders

• Type: FluidBoxSecondaryDrawOrders
• Optional: true

Set the secondary draw order for each orientation. Used to determine render order for sprites with the same render_layer in the same position. Sprites with a higher secondary_draw_order are drawn on top.

The individual directions default to the value of secondary_draw_order.

always_draw_covers

• Type: boolean
• Optional: true

Defaults to true if pipe_picture is not defined, otherwise defaults to false.

enable_working_visualisations

• Type: Array<string>
• Optional: true

Array of the WorkingVisualisation::name of working visualisations to enable when this fluidbox is present.

If draw_only_when_connected is true, then the working visualisation are only enabled when this is *connected*.