IFluidStack
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.
import crafttweaker.api.fluid.IFluidStack;Implemented Interfaces
IFluidStack implements the following interfaces. That means all methods defined in these interfaces are also available in IFluidStack
Casters
| Result Type | Is Implicit |
|---|---|
Result Type Fluid | Is Implicit true |
Result Type FluidIngredient | Is Implicit true |
Result Type IData | Is Implicit true |
Methods
Return Type: IData
// IFluidStack.asIData() as IData
myIFluidStack.asIData();Return Type: IFluidStack
// IFluidStack.asImmutable() as IFluidStack
myIFluidStack.asImmutable();Checks if this IFluidStack, contains the given IFluidStack by checking if the fluids are the same, and if this fluid’s amount is bigger than the given fluid’s amount
Returns: true if this fluid contains the other fluid
Return Type: boolean
IFluidStack.containsOther(other as IFluidStack) as boolean| Parameter | Type | Description |
|---|---|---|
Parameter other | Type IFluidStack | Description other IFluidStack to compare against |
Copies the stack. Only needed when mutable stacks are involved.
Returns: A new stack, that contains the same info as this one
Return Type: IFluidStack
// IFluidStack.copy() as IFluidStack
myIFluidStack.copy();Returns the BEP to get this thingy
Return Type: string
// IFluidStack.getCommandString() as string
myIFluidStack.getCommandString();Returns the NBT tag attached to this FluidStack.
Returns: MapData of the FluidStack’s NBT Tag, null if it doesn’t exist.
Return Type: MapData
// IFluidStack.getTag() as MapData
myIFluidStack.getTag();Return Type: boolean
// IFluidStack.isImmutable() as boolean
myIFluidStack.isImmutable();Makes this stack mutable
Returns: A new Stack, that is mutable.
Return Type: IFluidStack
// IFluidStack.mutable() as IFluidStack
myIFluidStack.mutable();Sets the fluid amount in MilliBuckets (mB)
Returns: A new stack, or this stack, depending if this stack is mutable
Return Type: IFluidStack
// IFluidStack.setAmount(amount as int) as IFluidStack
myIFluidStack.setAmount(1000);| Parameter | Type | Description |
|---|---|---|
Parameter amount | Type int | Description The amount to multiply this stack |
Sets the tag for the FluidStack.
Returns: This FluidStack if it is mutable, a new one with the changed property otherwise
Return Type: IFluidStack
// IFluidStack.withTag(tag as MapData?) as IFluidStack
myIFluidStack.withTag({Display: {lore: ["Hello"]}});| Parameter | Type | Description |
|---|---|---|
Parameter tag | Type MapData? | Description The tag to set. |
Operators
Checks if this IFluidStack, contains the given IFluidStack by checking if the fluids are the same, and if this fluid’s amount is bigger than the given fluid’s amount
other as IFluidStack in myIFluidStackSets the fluid amount in MilliBuckets (MB)
myIFluidStack * amount as intmyIFluidStack * 1000myIFluidStack | other as FluidIngredientProperties
| Name | Type | Has Getter | Has Setter | Description |
|---|---|---|---|---|
Name amount | Type int | Has Getter true | Has Setter false | Description Gets the fluid amount in MilliBuckets (mB). |
Name commandString | Type string | Has Getter true | Has Setter false | Description Returns the BEP to get this thingy |
Name empty | Type boolean | Has Getter true | Has Setter false | Description Gets whether or not this fluid stack is empty. |
Name fluid | Type Fluid | Has Getter true | Has Setter false | Description Retrieves this fluid stack’s fluid. |
Name hasTag | Type boolean | Has Getter true | Has Setter false | Description Returns true if this FluidStack has a Tag |
Name isImmutable | Type boolean | Has Getter true | Has Setter false | Description |
Name registryName | Type ResourceLocation | Has Getter true | Has Setter false | Description Gets the registry name for the fluid this stack is representing. |
Name tag | Type MapData | Has Getter true | Has Setter false | Description Returns the NBT tag attached to this FluidStack. |