LuaFluidBox

class LuaFluidBox - sort
get_capacity(index) → double The capacity of the given fluidbox index.
get_connections() → array of LuaFluidBox The fluidbox connections for the given fluidbox index.
operator # :: uint [R] Number of fluid boxes.
owner :: LuaEntity [R] The entity that owns this fluidbox.
operator [] [R] Access, set or clear a fluid box.
valid :: boolean [R] Is this object valid?
help() → string All methods, and properties that this object supports.

An array of fluid boxes. Entities may contain more than one fluid box, and some can change the number of fluid boxes -- for instance, an assembling machine will change its number of fluid boxes depending on its active recipe.

A fluid box is represented as a table:

Do note that reading from a LuaFluidBox creates a new table and writing will copy the given fields from the table into the engine's own fluid box structure. Therefore, the correct way to update a fluidbox of an entity is to read it first, modify the table, then write the modified table back. Directly accessing the returned table's attributes won't have the desired effect.

Example
Double the temperature of the fluid in entity's first fluid box.
fluid = entity.fluidbox[1]
fluid.temperature = fluid.temperature * 2
entity.fluidbox[1] = fluid
get_capacity(index) → double

The capacity of the given fluidbox index.

Parameters
index :: uint
get_connections() → array of LuaFluidBox

The fluidbox connections for the given fluidbox index.

operator # :: uint [Read-only]

Number of fluid boxes.

owner :: LuaEntity [Read-only]

The entity that owns this fluidbox.

operator [] [Read-only]

Access, set or clear a fluid box. The index must always be in bounds (see LuaFluidBox::operator #); new fluidboxes may not be added or removed using this operator. If the given fluid box doesn't contain any fluid, nil is returned. Similarly, nil can be written to a fluid box to remove all fluid from it.