Package net.minecraft.world.level.material

Class Fluid

java.lang.Object

net.minecraft.world.level.material.Fluid

All Implemented Interfaces:

IFluidExtension

Direct Known Subclasses:

EmptyFluid, FlowingFluid

public abstract class Fluid
extends Object
implements IFluidExtension

Field Summary

Fields

Modifier and Type	Field	Description
private final Holder.Reference<Fluid>	builtInRegistryHolder
private FluidState	defaultFluidState
static final IdMapper<FluidState>	FLUID_STATE_REGISTRY
private FluidType	forgeFluidType
protected final StateDefinition<Fluid,FluidState>	stateDefinition

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Fluid()

Method Summary

Modifier and Type	Method	Description
protected void	animateTick(Level pLevel, BlockPos pPos, FluidState pState, RandomSource pRandom)
Holder.Reference<Fluid>	builtInRegistryHolder()	Deprecated.
protected abstract boolean	canBeReplacedWith(FluidState pState, BlockGetter pLevel, BlockPos pPos, Fluid pFluid, Direction pDirection)
protected void	createFluidStateDefinition(StateDefinition.Builder<Fluid,FluidState> pBuilder)
protected abstract BlockState	createLegacyBlock(FluidState pState)
final FluidState	defaultFluidState()
protected void	entityInside(Level pLevel, BlockPos pPos, Entity pEntity, InsideBlockEffectApplier pEffectApplier)
AABB	getAABB(FluidState pState, BlockGetter pLevel, BlockPos pPos)
abstract int	getAmount(FluidState pState)
abstract Item	getBucket()
protected ParticleOptions	getDripParticle()
protected abstract float	getExplosionResistance()
protected abstract Vec3	getFlow(BlockGetter pBlockReader, BlockPos pPos, FluidState pFluidState)
FluidType	getFluidType()	Returns the type of this fluid.
abstract float	getHeight(FluidState pState, BlockGetter pLevel, BlockPos pPos)
abstract float	getOwnHeight(FluidState pState)
Optional<SoundEvent>	getPickupSound()
abstract VoxelShape	getShape(FluidState pState, BlockGetter pLevel, BlockPos pPos)
StateDefinition<Fluid,FluidState>	getStateDefinition()
abstract int	getTickDelay(LevelReader pLevel)
boolean	is(TagKey<Fluid> pTag)	Deprecated.
protected boolean	isEmpty()
protected boolean	isRandomlyTicking()
boolean	isSame(Fluid pFluid)
abstract boolean	isSource(FluidState pState)
protected void	randomTick(ServerLevel pLevel, BlockPos pPos, FluidState pState, RandomSource pRandom)
protected final void	registerDefaultState(FluidState pState)
protected void	tick(ServerLevel pLevel, BlockPos pPos, BlockState pBlockState, FluidState pFluidState)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.neoforged.neoforge.common.extensions.IFluidExtension

canConvertToSource, canExtinguish, canHydrate, getAdjacentBlockPathType, getBlockPathType, getExplosionResistance, move, supportsBoating

Field Details

FLUID_STATE_REGISTRY

public static final IdMapper<FluidState> FLUID_STATE_REGISTRY

stateDefinition

protected final StateDefinition<Fluid,FluidState> stateDefinition

defaultFluidState

private FluidState defaultFluidState

builtInRegistryHolder

private final Holder.Reference<Fluid> builtInRegistryHolder

forgeFluidType

private FluidType forgeFluidType

Constructor Details

Fluid

protected Fluid()

Method Details

createFluidStateDefinition

protected void createFluidStateDefinition(StateDefinition.Builder<Fluid,FluidState> pBuilder)

getStateDefinition

public StateDefinition<Fluid,FluidState> getStateDefinition()

registerDefaultState

protected final void registerDefaultState(FluidState pState)

defaultFluidState

public final FluidState defaultFluidState()

getBucket

public abstract Item getBucket()

animateTick

protected void animateTick(Level pLevel,
 BlockPos pPos,
 FluidState pState,
 RandomSource pRandom)

tick

protected void tick(ServerLevel pLevel,
 BlockPos pPos,
 BlockState pBlockState,
 FluidState pFluidState)

randomTick

protected void randomTick(ServerLevel pLevel,
 BlockPos pPos,
 FluidState pState,
 RandomSource pRandom)

entityInside

protected void entityInside(Level pLevel,
 BlockPos pPos,
 Entity pEntity,
 InsideBlockEffectApplier pEffectApplier)

getDripParticle

@Nullable
protected ParticleOptions getDripParticle()

canBeReplacedWith

protected abstract boolean canBeReplacedWith(FluidState pState,
 BlockGetter pLevel,
 BlockPos pPos,
 Fluid pFluid,
 Direction pDirection)

getFlow

protected abstract Vec3 getFlow(BlockGetter pBlockReader,
 BlockPos pPos,
 FluidState pFluidState)

getTickDelay

public abstract int getTickDelay(LevelReader pLevel)

isRandomlyTicking

protected boolean isRandomlyTicking()

isEmpty

protected boolean isEmpty()

getExplosionResistance

protected abstract float getExplosionResistance()

getHeight

public abstract float getHeight(FluidState pState,
 BlockGetter pLevel,
 BlockPos pPos)

getOwnHeight

public abstract float getOwnHeight(FluidState pState)

createLegacyBlock

protected abstract BlockState createLegacyBlock(FluidState pState)

isSource

public abstract boolean isSource(FluidState pState)

getAmount

public abstract int getAmount(FluidState pState)

isSame

public boolean isSame(Fluid pFluid)

is

@Deprecated
public boolean is(TagKey<Fluid> pTag)

Deprecated.

getShape

public abstract VoxelShape getShape(FluidState pState,
 BlockGetter pLevel,
 BlockPos pPos)

toString

public String toString()

Overrides:

toString in class Object

getAABB

@Nullable
public AABB getAABB(FluidState pState,
 BlockGetter pLevel,
 BlockPos pPos)

getPickupSound

public Optional<SoundEvent> getPickupSound()

builtInRegistryHolder

@Deprecated
public Holder.Reference<Fluid> builtInRegistryHolder()

Deprecated.

getFluidType

public FluidType getFluidType()

Description copied from interface: IFluidExtension

Returns the type of this fluid.

Important: This MUST be overridden on your fluid, otherwise an error will be thrown.

Specified by:

getFluidType in interface IFluidExtension

Returns:

the type of this fluid