Skip to main content

FluidStorage

info

FluidStorage is the utility class responsible for managing fluids (mB) for entities.

It provides a scoreboard‑based fluid system that allows machines, tanks, and other containers to:

  • store fluids
  • insert and extract fluids
  • transfer fluids between entities
  • interact with fluid containers (buckets, cells, etc.)
  • display fluid visually
  • manage large values safely using mantissa/exponent storage

Like EnergyStorage, this system stores values using mantissa/exponent scaling so large fluid values remain safe for scoreboard storage.

Each FluidStorage instance represents one tank index of an entity.

Index

Properties​

Pentity
Pindex
PscoreId
Pscores
Ptype
Pcap

Static Properties​

PitemFluidStorages
PitemFluidHolders

Static Methods​

MinitializeSingle
MinitializeMultiple
MinitializeObjectives
MgetMaxLiquids
MnormalizeValue
McombineValue
MformatFluid
MgetFluidFromText
MgetContainerData
Minitialize
MtransferBetween
MfindType
MhandleFluidItemInteraction
MaddfluidToTank
MgetTankCapacity

Methods​

MsetCap
MgetCap
Mset
Mget
Madd
Mconsume
MgetFreeSpace
Mhas
MisFull
MgetType
MsetType
MtryInsert
MfluidItem
MtransferTo
MreceiveFrom
MtransferToNetwork
MtransferFluids
Mdisplay

Constructor

new FluidStorage​

new FluidStorage(entity: Entity, index?: number)

Creates a new fluid manager attached to the given entity.

Parameters​

  • entityEntity

    Entity representing the machine or tank container.

  • indexnumber

    Tank index managed by this instance.

Behavior​

  1. Stores a reference to the entity.
  2. Retrieves the entity scoreboard identity.
  3. Loads the scoreboard objectives for the specified tank index.
  4. Reads and caches the tank capacity.
  5. Determines the fluid type stored in the tank.

Properties

entity​

Type: Entity

Entity representing the machine or tank storing fluid.

index​

Type: number

Index of the fluid tank handled by this instance.

Example:

const tank0 = new FluidStorage(entity, 0)
const tank1 = new FluidStorage(entity, 1)

scoreId​

Type: ScoreboardIdentity

Scoreboard identity used to store the tank values.

scores​

Cached scoreboard objectives for this tank.

Structure:

{
 fluid,
 fluidExp,
 fluidCap,
 fluidCapExp
}

type​

Type: string

Current fluid type stored in the tank.

Examples:

water
lava
oil
empty

cap​

Type: number

Cached maximum capacity of the tank.

Static Properties

itemFluidStorages​

Defines items that contain fluids.

Example:

FluidStorage.itemFluidStorages["minecraft:lava_bucket"]

Returns:

{ amount:1000, type:"lava", output:"minecraft:bucket" }

itemFluidHolders​

Defines items capable of extracting fluids.

Example:

{
 "minecraft:bucket":{
    types:{
      water:"minecraft:water_bucket",
      lava:"minecraft:lava_bucket"
    },
    required:1000
 }
}

Static Methods

initializeSingle​

Creates a single tank for an entity.

initializeMultiple​

Initializes multiple tanks for a machine.

initializeObjectives​

Ensures scoreboard objectives exist for a tank index.

getMaxLiquids​

Returns how many tanks an entity supports.

normalizeValue​

Converts a value into mantissa/exponent format.

combineValue​

Reconstructs a number from mantissa/exponent.

formatFluid​

Formats fluid values into readable units.

Example:

5000 → 5.0 kB

getFluidFromText​

Extracts fluid information from formatted text.

getContainerData​

Returns fluid container data for an item.

initialize​

Initializes fluid scoreboards for an entity.

transferBetween​

Transfers fluid between two block locations.

findType​

Finds the first tank matching a fluid type.

handleFluidItemInteraction​

Handles player interaction with fluid items.

addfluidToTank​

Creates a tank entity and inserts fluid.

getTankCapacity​

Returns the default capacity for tank blocks.

Methods

setCap​

Sets the tank capacity.

getCap​

Returns the tank capacity.

set​

Sets the current fluid amount.

get​

Returns the stored fluid amount.

add​

Adds or removes fluid from the tank.

consume​

Consumes fluid from the tank.

getFreeSpace​

Returns remaining tank capacity.

has​

Checks if the tank has a minimum amount of fluid.

isFull​

Returns true if the tank is full.

getType​

Returns the stored fluid type.

setType​

Sets the tank fluid type.

tryInsert​

Attempts to insert a fluid type into the tank.

fluidItem​

Handles item‑based fluid interactions.

transferTo​

Transfers fluid to another FluidStorage instance.

receiveFrom​

Receives fluid from another tank.

transferToNetwork​

Transfers fluid to connected tanks in the fluid network.

Supported modes:

  • nearest
  • farthest
  • round

transferFluids​

Transfers fluid based on block facing direction.

display​

Displays a 48‑frame fluid bar item in the entity inventory.

Example

const tank = new FluidStorage(entity, 0)

tank.setCap(32000)
tank.setType("water")

tank.add(1000)

if (tank.has(500)) {
  tank.consume(500)
}

tank.display()

Notes

FluidStorage is the core fluid system used across Dorios machines and tanks.

It is used by:

  • fluid tanks
  • machines with internal liquids
  • fluid transport networks

All fluid values are stored using scoreboards with mantissa/exponent scaling to support very large fluid values safely.