pylon-core/io.github.pylonmc.pylon.core.block.base/PylonFluidTank

PylonFluidTank

interface PylonFluidTank : PylonFluidBlock(source)

A common pattern is a 'fluid tank' which can only store one fluid at a time, but can store many types of fluids. PylonFluidTank implements this pattern.

You must call setCapacity for this block to work.

As with PylonFluidBufferBlock, you do not need to handle saving buffers or implement any of the PylonFluidBlock methods for this; this is all done automatically.

Properties

fluidAmount

open val fluidAmount: Double

The amount of fluid stored in the tank

fluidCapacity

open val fluidCapacity: Double

The capacity of the tank

fluidSpaceRemaining

open val fluidSpaceRemaining: Double

The amount of space remaining in the tank

fluidType

open val fluidType: PylonFluid?

The type of fluid stored in the tank

Functions

addFluid

open fun addFluid(amount: Double): Boolean

Adds to the tank only if the new amount of fluid is greater than zero and fits in the tank.

canSetFluid

open fun canSetFluid(amount: Double): Boolean

Checks if a new amount of fluid is greater than zero and fits inside the tank.

fluidAmountRequested

open override fun fluidAmountRequested(fluid: PylonFluid, deltaSeconds: Double): Double

Returns the amount of the given fluid that the machine wants to receive next tick.

getDirectionalPoint

open fun getDirectionalPoint(): String?

getFacing

open override fun getFacing(): BlockFace?

getSuppliedFluids

open override fun getSuppliedFluids(deltaSeconds: Double): Map<PylonFluid, Double>

Returns a map of fluid types - and their corresponding amounts - that can be supplied by the block for this fluid tick. deltaSeconds is the time since the last fluid tick.

isAllowedFluid

abstract fun isAllowedFluid(fluid: PylonFluid): Boolean

onFluidAdded

open override fun onFluidAdded(fluid: PylonFluid, amount: Double)

amount is always at most getRequestedFluids().get(fluid) and will never be zero or less.

onFluidRemoved

open override fun onFluidRemoved(fluid: PylonFluid, amount: Double)

amount is always at least getSuppliedFluids().get(fluid) and will never be zero or less.

removeFluid

open fun removeFluid(amount: Double): Boolean

Removes from the tank only if the new amount of fluid is greater than zero and fits in the tank.

setCapacity

open fun setCapacity(capacity: Double)

Sets the capacity of the fluid tank

setFluid

open fun setFluid(amount: Double): Boolean

Sets the fluid amount only if the new amount of fluid is greater than zero and fits in the tank.

setFluidType

open fun setFluidType(fluid: PylonFluid?)

Sets the type of fluid in the fluid tank