IFluidHandler

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

import crafttweaker.api.capability.IFluidHandler;

Operators

Gets the fluid in the given tank.

// IFluidHandler[tank as int] as IFluidStack
myIFluidHandler[myInt]

Parameters:

tank: int Type: int - The tank to get the fluid of.

Return Type: IFluidStack

Members

Drains fluid out of the internal tanks.

Returns: A new FluidStack representing the fluid that was drained along with how much was drained.

// IFluidHandler.drain(resource as IFluidStack, action as IFluidHandlerAction) as IFluidStack;
myIFluidHandler.drain(<fluid:minecraft:water> * 400, <constant:neoforge:fluid_action:execute>);

Parameters:

resource: IFluidStack Type: IFluidStack - The fluid and the maximum amount of the fluid to drain.

action: IFluidHandlerAction Type: IFluidHandlerAction - Determines if the drain is simulated or executed.

Return Type: IFluidStack

Drains fluid out of the internal tanks.

Returns: A new FluidStack representing the fluid that was drained along with how much was drained.

// IFluidHandler.drain(maxDrain as int, action as IFluidHandlerAction) as IFluidStack;
myIFluidHandler.drain(400, <constant:neoforge:fluid_action:execute>);

Parameters:

maxDrain: int Type: int - How much fluid should be drained.

action: IFluidHandlerAction Type: IFluidHandlerAction - Determines if the drain is simulated or executed.

Return Type: IFluidStack

Fills the internal tanks with the given fluid.

Returns: The amount of the fluid that will be used by the fill.

// IFluidHandler.fill(resource as IFluidStack, action as IFluidHandlerAction) as int;
myIFluidHandler.fill(<fluid:minecraft:water>, <constant:neoforge:fluid_action:execute>);

Parameters:

resource: IFluidStack Type: IFluidStack - The fluid to fill.

action: IFluidHandlerAction Type: IFluidHandlerAction - Determines if the fill is simulated or executed.

Return Type: int

Gets the fluid in the given tank.

Returns: The fluid in the tank.

// IFluidHandler.getFluidInTank(tank as int) as IFluidStack;
myIFluidHandler.getFluidInTank(0);

Parameters:

tank: int Type: int - The tank to get the fluid of.

Return Type: IFluidStack

Gets the capacity of the given tank.

Returns: The capacity of the given tank.

// IFluidHandler.getTankCapacity(tank as int) as int;
myIFluidHandler.getTankCapacity(0);

Parameters:

tank: int Type: int - The tank to get the capacity of.

Return Type: int

Checks if the given fluid is valid for the given tank.

Returns: true if the fluid is valid, false otherwise.

// IFluidHandler.isFluidValid(tank as int, stack as IFluidStack) as bool;
myIFluidHandler.isFluidValid(0, <fluid:minecraft:water>);

Parameters:

tank: int Type: int - The tank to check.

stack: IFluidStack Type: IFluidStack - The fluid to check.

Return Type: bool

Gets the number of tanks in this fluid handler.

A single handler can have many tanks holding different fluids

// IFluidHandler.tanks as int
myIFluidHandler.tanks

Return Type: int