Package mcp.mobius.waila.api.data

Class FluidData

java.lang.Object

mcp.mobius.waila.api.data.FluidData

All Implemented Interfaces:

IData

Direct Known Subclasses:

FluidData.PlatformDependant

@NonExtendable
public abstract class FluidData
extends Object
implements IData

Adds fluid information to an object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FluidData.CauldronDescriptor
static interface	FluidData.FluidDescription
static interface	FluidData.FluidDescriptionContext<T extends Fluid>
static interface	FluidData.FluidDescriptor<T extends Fluid>
static class	FluidData.PlatformDependant<T>
static interface	FluidData.PlatformTranslator<T>
static enum	FluidData.Unit

Nested classes/interfaces inherited from interface mcp.mobius.waila.api.IData

IData.Type<D extends IData>

Field Summary

Fields

Modifier and Type	Field	Description
static final Identifier	CONFIG_DISPLAY_UNIT
static final Identifier	ID
static final IData.Type<FluidData>	TYPE

Constructor Summary

Constructors

Constructor	Description
FluidData()

Method Summary

Modifier and Type	Method	Description
FluidData	add(Fluid fluid, net.minecraft.core.component.DataComponentPatch data, double stored, double capacity)	Adds a fluid entry.
static void	describeCauldron(Class<? extends Block> clazz, FluidData.CauldronDescriptor descriptor)	Describes what fluids are contained in the specified cauldron-like block type that store fluid on its block state.
static void	describeCauldron(Block block, FluidData.CauldronDescriptor descriptor)	Describes what fluids are contained in the specified cauldron-like block that store fluid on its block state.
static <T extends Fluid> void	describeFluid(Class<T> clazz, FluidData.FluidDescriptor<T> descriptor)	Describes how the fluids of the specified type will be shown in the client.
static <T extends Fluid> void	describeFluid(T fluid, FluidData.FluidDescriptor<T> descriptor)	Describes how the specific fluid will be shown in the client.
static <S> FluidData.PlatformDependant<S>	of(FluidData.PlatformTranslator<S> translator)	Creates a fluid data with platform-specific translator.
static <S> FluidData.PlatformDependant<S>	of(FluidData.PlatformTranslator<S> translator, int slotCountHint)	Creates a fluid data with platform-specific translator.
static FluidData	of(FluidData.Unit unit)	Creates a fluid data.
static FluidData	of(FluidData.Unit unit, int slotCountHint)	Creates a fluid data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface mcp.mobius.waila.api.IData

type

Field Details

ID

public static final Identifier ID

TYPE

public static final IData.Type<FluidData> TYPE

CONFIG_DISPLAY_UNIT

public static final Identifier CONFIG_DISPLAY_UNIT

Constructor Details

FluidData

public FluidData()

Method Details

describeFluid

@ClientOnly
public static <T extends Fluid> void describeFluid(T fluid,
 FluidData.FluidDescriptor<T> descriptor)

Describes how the specific fluid will be shown in the client.

Most platforms likely has API to do this already, so user might not need to register their own implementation here.

• On Forge, FluidType will be used for fluid name and IClientFluidTypeExtensions for fluid sprite.
• On Fabric, FluidVariantAttributeHandler will be used for fluid name and FluidVariantRenderHandler for fluid sprite.

Throws:

IllegalArgumentException - if the fluid is a FlowingFluid and is not the source fluid instance

describeFluid

@ClientOnly
public static <T extends Fluid> void describeFluid(Class<T> clazz,
 FluidData.FluidDescriptor<T> descriptor)

Describes how the fluids of the specified type will be shown in the client.

Most platforms likely has API to do this already, so user might not need to register their own implementation here.

• On Forge, FluidType will be used for fluid name and IClientFluidTypeExtensions for fluid sprite.
• On Fabric, FluidVariantAttributeHandler will be used for fluid name and FluidVariantRenderHandler for fluid sprite.

describeCauldron

public static void describeCauldron(Block block,
 FluidData.CauldronDescriptor descriptor)

Describes what fluids are contained in the specified cauldron-like block that store fluid on its block state.

Some platforms have API to attach this information, so user might not need to register their own implementation here.

• On Fabric, CauldronFluidContent is used to get the information.

describeCauldron

public static void describeCauldron(Class<? extends Block> clazz,
 FluidData.CauldronDescriptor descriptor)

Describes what fluids are contained in the specified cauldron-like block type that store fluid on its block state.

Some platforms have API to attach this information, so user might not need to register their own implementation here.

• On Fabric, CauldronFluidContent is used to get the information.

of

public static FluidData of(FluidData.Unit unit)

Creates a fluid data.

Parameters:

unit - the fluid unit of measurement

See Also:

• FabricFluidData.of()
• ForgeFluidData.of()
• NeoFluidData.of()

of

public static FluidData of(FluidData.Unit unit,
 int slotCountHint)

Creates a fluid data.

Parameters:

unit - the fluid unit of measurement

slotCountHint - hint of how many the slots probably are to minimize growing the list more than necessary, the user can call add(net.minecraft.world.level.material.Fluid, net.minecraft.core.component.DataComponentPatch, double, double) more than the specified count

See Also:

• FabricFluidData.of()
• ForgeFluidData.of()
• NeoFluidData.of()

of

public static <S> FluidData.PlatformDependant<S> of(FluidData.PlatformTranslator<S> translator)

Creates a fluid data with platform-specific translator.

Use the helper methods from the platform specific API package.

Parameters:

translator - the translator that gets the fluid, nbt, and (optionally) amount from a platform-specific object

See Also:

• FabricFluidData.of()
• ForgeFluidData.of()
• NeoFluidData.of()

of

public static <S> FluidData.PlatformDependant<S> of(FluidData.PlatformTranslator<S> translator,
 int slotCountHint)

Creates a fluid data with platform-specific translator.

Use the helper methods from the platform specific API package.

Parameters:

translator - the translator that gets the fluid, nbt, and (optionally) amount from a platform-specific object

slotCountHint - hint of how many the slots probably are to minimize growing the list more than necessary, the user can call add(net.minecraft.world.level.material.Fluid, net.minecraft.core.component.DataComponentPatch, double, double) more than the specified count

See Also:

• FabricFluidData.of(int)
• ForgeFluidData.of(int)
• NeoFluidData.of(int)

add

public FluidData add(Fluid fluid,
 net.minecraft.core.component.DataComponentPatch data,
 double stored,
 double capacity)

Adds a fluid entry.

Parameters:

fluid - the fluid instance, will be normalized as the source fluid if it is a FlowingFluid

data - the fluid's NBT data, will NOT be modified so it safe to not copy it

stored - the stored amount of the fluid, in the specified unit

capacity - the maximum capacity of this slot, in the specified unit