get_prototype(index) → LuaFluidBoxPrototype | The prototype of this fluidbox index. |
get_capacity(index) → double | The capacity of the given fluidbox index. |
get_connections(index) → array of LuaFluidBox | The fluidbox connections for the given fluidbox index. |
get_filter(index) → table | The filter of the given fluidbox index, 'nil' if none. |
set_filter(index, table) → boolean | Set the filter of the given fluidbox index, 'nil' to clear. |
get_flow(index) → double | Flow through the fluidbox in the last tick. |
get_locked_fluid(index) → string | Returns the fluid the fluidbox is locked onto (along with its whole system) Returns 'nil' for no lock |
operator # :: uint [R] | Number of fluid boxes. |
owner :: LuaEntity [R] | The entity that owns this fluidbox. |
operator [] :: Fluid or nil [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. |
Set the filter of the given fluidbox index, 'nil' to clear. Some entities cannot have their fluidbox filter set, notably fluid wagons and crafting machines.
Flow through the fluidbox in the last tick. It is the larger of in-flow and out-flow. Note that wagons do not track it and will return 0.
Returns the fluid the fluidbox is locked onto (along with its whole system) Returns 'nil' for no lock
Number of fluid boxes.
The entity that owns this fluidbox.
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.