nova.core.component.fluid

Interface FluidBlock

public interface FluidBlock

An interface applied to blocks that are fluids

Method Summary

Modifier and Type	Method and Description
java.util.Optional<Fluid>	drain(boolean doDrain) Attempt to drain the block.
java.util.Optional<Fluid>	getFluid() Returns the Fluid associated with this Block.

Method Detail

getFluid

java.util.Optional<Fluid> getFluid()

Returns the Fluid associated with this Block.

Returns:

The Fluid associated with this Block.

drain

java.util.Optional<Fluid> drain(boolean doDrain)

Attempt to drain the block. This method should be called by devices such as pumps. NOTE: The block is intended to handle its own state changes.

Parameters:

doDrain - If false, the drain will only be simulated.

Returns:

The drained fluid amount.