Package org.moddingx.libx.base

Class FluidBase

java.lang.Object

org.moddingx.libx.base.FluidBase

All Implemented Interfaces:

net.minecraft.world.level.ItemLike, Registerable

@PlainRegisterable
public class FluidBase
extends Object
implements net.minecraft.world.level.ItemLike, Registerable

A Registerable that registers a fluid type, source and flowing fluid, a liquid block and a bucket item.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FluidBase.Builder

Nested classes/interfaces inherited from interface org.moddingx.libx.registration.Registerable

Registerable.EntryCollector

Field Summary

Fields

Modifier and Type	Field	Description
protected final ModX	mod

Constructor Summary

Constructors

Constructor	Description
FluidBase(ModX mod, FluidBase.Builder fluidBuilder)

Method Summary

Modifier and Type	Method	Description
final net.minecraft.world.item.Item	asItem()	This is the same as getBucketItem() and allows FluidBase to be used as an ItemLike.
protected ClientExtensionInfo.Fluid	createClientExtensions(net.minecraft.resources.ResourceLocation id)	Creates the client extensions for this fluid.
static FluidBase.Builder	fluidBuilder()	Creates a new fluid builder for setting the basic fluid properties to be passed in the constructor.
final net.minecraft.world.item.BucketItem	getBucketItem()	Gets the bucket item for this FluidBase.
final net.minecraft.world.level.material.Fluid	getFlowingFluid()	Gets the flowing fluid for this FluidBase.
final net.minecraft.world.level.material.Fluid	getFluid()	Gets the source fluid for this FluidBase.
final net.neoforged.neoforge.fluids.FluidType	getFluidType()	Gets the fluid type for this FluidBase.
final net.minecraft.world.level.block.LiquidBlock	getLiquidBlock()	Gets the liquid block for this FluidBase.
final net.minecraft.world.level.material.Fluid	getSourceFluid()	Gets the source fluid for this FluidBase.
void	registerAdditional(RegistrationContext ctx, Registerable.EntryCollector builder)	Registers additional objects.
void	registerClientAdditional(RegistrationContext ctx, Registerable.EntryCollector builder)	Similar to Registerable.registerAdditional(RegistrationContext, EntryCollector) but only invoked on the client.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.moddingx.libx.registration.Registerable

setupClient, setupCommon

Field Details

mod

protected final ModX mod

Constructor Details

FluidBase

public FluidBase(ModX mod,
 FluidBase.Builder fluidBuilder)

Method Details

createClientExtensions

protected ClientExtensionInfo.Fluid createClientExtensions(net.minecraft.resources.ResourceLocation id)

Creates the client extensions for this fluid. The default implementation creates client extensions that have no special properties, use a still texture located at [namespace]:block/[path] and a flowing texture located at [namespace]:block/[path]_flowing.

registerAdditional

@OverridingMethodsMustInvokeSuper
public void registerAdditional(RegistrationContext ctx,
 Registerable.EntryCollector builder)

Description copied from interface: Registerable

Registers additional objects. Those may be Registerable as well. These objects will be registered with the id of this object and optionally a name suffix.

Specified by:

registerAdditional in interface Registerable

registerClientAdditional

@OverridingMethodsMustInvokeSuper
public void registerClientAdditional(RegistrationContext ctx,
 Registerable.EntryCollector builder)

Description copied from interface: Registerable

Similar to Registerable.registerAdditional(RegistrationContext, EntryCollector) but only invoked on the client.

Specified by:

registerClientAdditional in interface Registerable

getFluidType

@Nonnull
public final net.neoforged.neoforge.fluids.FluidType getFluidType()

Gets the fluid type for this FluidBase.

getFluid

@Nonnull
public final net.minecraft.world.level.material.Fluid getFluid()

Gets the source fluid for this FluidBase. This is the same as getSourceFluid(). One should prefer this method over getSourceFluid() when needing a representative for the whole fluid type, for example when creating fluid stacks.

getSourceFluid

@Nonnull
public final net.minecraft.world.level.material.Fluid getSourceFluid()

Gets the source fluid for this FluidBase. This is the same as getFluid(). One should prefer this method over getFluid() when a distinction between source and flowing fluids is to be made.

getFlowingFluid

@Nonnull
public final net.minecraft.world.level.material.Fluid getFlowingFluid()

Gets the flowing fluid for this FluidBase.

getLiquidBlock

@Nonnull
public final net.minecraft.world.level.block.LiquidBlock getLiquidBlock()

Gets the liquid block for this FluidBase.

getBucketItem

@Nonnull
public final net.minecraft.world.item.BucketItem getBucketItem()

Gets the bucket item for this FluidBase.

asItem

@Nonnull
public final net.minecraft.world.item.Item asItem()

This is the same as getBucketItem() and allows FluidBase to be used as an ItemLike.

Specified by:

asItem in interface net.minecraft.world.level.ItemLike

fluidBuilder

public static FluidBase.Builder fluidBuilder()

Creates a new fluid builder for setting the basic fluid properties to be passed in the constructor.