IFluidHandler
Link to ifluidhandler
Importing the class
Link to importing-the-class
It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.
ZenScript Copyimport crafttweaker.api.capability.IFluidHandler;
Methods
Link to methods
Name: drain
Drains fluid out of the internal tanks.
Returns: A new FluidStack representing the fluid that was drained along with how much was drained.
Return Type: IFluidStack
ZenScript Copy// IFluidHandler.drain(maxDrain as int, action as IFluidHandlerAction) as IFluidStack
myIFluidHandler.drain(400, <constant:forge:fluid_action:execute>);
| Parameter | Type | Description |
|---|---|---|
Parameter maxDrain | Type int | Description How much fluid should be drained. |
Parameter action | Type IFluidHandlerAction | Description Determines if the drain is simulated or executed. |
Name: drain
Drains fluid out of the internal tanks.
Returns: A new FluidStack representing the fluid that was drained along with how much was drained.
Return Type: IFluidStack
ZenScript Copy// IFluidHandler.drain(resource as IFluidStack, action as IFluidHandlerAction) as IFluidStack
myIFluidHandler.drain(<fluid:minecraft:water> * 400, <constant:forge:fluid_action:execute>);
| Parameter | Type | Description |
|---|---|---|
Parameter resource | Type IFluidStack | Description The fluid and the maximum amount of the fluid to drain. |
Parameter action | Type IFluidHandlerAction | Description Determines if the drain is simulated or executed. |
Name: fill
Fills the internal tanks with the given fluid.
Returns: The amount of the fluid that will be used by the fill.
Return Type: int
ZenScript Copy// IFluidHandler.fill(resource as IFluidStack, action as IFluidHandlerAction) as int
myIFluidHandler.fill(<fluid:minecraft:water>, <constant:forge:fluid_action:execute>);
| Parameter | Type | Description |
|---|---|---|
Parameter resource | Type IFluidStack | Description The fluid to fill. |
Parameter action | Type IFluidHandlerAction | Description Determines if the fill is simulated or executed. |
Name: getFluidInTank
Gets the fluid in the given tank.
Returns: The fluid in the tank.
Return Type: IFluidStack
ZenScript Copy// IFluidHandler.getFluidInTank(tank as int) as IFluidStack
myIFluidHandler.getFluidInTank(0);
| Parameter | Type | Description |
|---|---|---|
Parameter tank | Type int | Description The tank to get the fluid of. |
Name: getTankCapacity
Gets the capacity of the given tank.
Returns: The capacity of the given tank.
Return Type: int
ZenScript Copy// IFluidHandler.getTankCapacity(tank as int) as int
myIFluidHandler.getTankCapacity(0);
| Parameter | Type | Description |
|---|---|---|
Parameter tank | Type int | Description The tank to get the capacity of. |
Name: getTanks
Gets the number of tanks in this fluid handler.
A single handler can have many tanks holding different fluids
Returns: The number of tanks in this fluid handler.
Return Type: int
ZenScript Copy// IFluidHandler.getTanks() as int
myIFluidHandler.getTanks();
Name: isFluidValid
Checks if the given fluid is valid for the given tank.
Returns: true if the fluid is valid, false otherwise.
Return Type: boolean
ZenScript Copy// IFluidHandler.isFluidValid(tank as int, stack as IFluidStack) as boolean
myIFluidHandler.isFluidValid(0, <fluid:minecraft:water>);
| Parameter | Type | Description |
|---|---|---|
Parameter tank | Type int | Description The tank to check. |
Parameter stack | Type IFluidStack | Description The fluid to check. |
Properties
Link to properties
| Name | Type | Has Getter | Has Setter | Description |
|---|---|---|---|---|
Name tanks | Type int | Has Getter true | Has Setter false | Description Gets the number of tanks in this fluid handler. A single handler can have many tanks holding different fluids |