Package net.neoforged.neoforge.fluids

Class BaseFlowingFluid

java.lang.Object

net.minecraft.world.level.material.Fluid

net.minecraft.world.level.material.FlowingFluid

net.neoforged.neoforge.fluids.BaseFlowingFluid

All Implemented Interfaces:

IFluidExtension

Direct Known Subclasses:

BaseFlowingFluid.Flowing, BaseFlowingFluid.Source

public abstract class BaseFlowingFluid
extends FlowingFluid

Base implementation of a FlowingFluid for mods to use.

See Also:

• BaseFlowingFluid.Flowing
• BaseFlowingFluid.Source

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BaseFlowingFluid.Flowing
static class	BaseFlowingFluid.Properties
static class	BaseFlowingFluid.Source

Field Summary

Fields

Modifier and Type	Field	Description
private final @Nullable Supplier<? extends LiquidBlock>	block
private final @Nullable Supplier<? extends Item>	bucket
private final float	explosionResistance
private final Supplier<? extends Fluid>	flowing
private final Supplier<? extends FluidType>	fluidType
private final int	levelDecreasePerBlock
private final int	slopeFindDistance
private final Supplier<? extends Fluid>	still
private final int	tickRate

Fields inherited from class net.minecraft.world.level.material.FlowingFluid

FALLING, LEVEL

Fields inherited from class net.minecraft.world.level.material.Fluid

FLUID_STATE_REGISTRY, stateDefinition

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseFlowingFluid(BaseFlowingFluid.Properties properties)

Method Summary

Modifier and Type	Method	Description
protected void	beforeDestroyingBlock(LevelAccessor worldIn, BlockPos pos, BlockState state)
protected boolean	canBeReplacedWith(FluidState state, BlockGetter level, BlockPos pos, Fluid fluidIn, Direction direction)
protected boolean	canConvertToSource(Level level)
boolean	canConvertToSource(FluidState state, Level level, BlockPos pos)	Returns whether the fluid can create a source.
protected BlockState	createLegacyBlock(FluidState state)
Item	getBucket()
protected int	getDropOff(LevelReader worldIn)
protected float	getExplosionResistance()
Fluid	getFlowing()
FluidType	getFluidType()	Returns the type of this fluid.
Optional<SoundEvent>	getPickupSound()
protected int	getSlopeFindDistance(LevelReader worldIn)
Fluid	getSource()
int	getTickDelay(LevelReader level)
boolean	isSame(Fluid fluidIn)

Methods inherited from class net.minecraft.world.level.material.FlowingFluid

canSpreadTo, createFluidStateDefinition, getAmount, getFlow, getFlowing, getHeight, getLegacyLevel, getNewLiquid, getOwnHeight, getShape, getSlopeDistance, getSource, getSpread, getSpreadDelay, isSolidFace, spread, spreadTo, tick

Methods inherited from class net.minecraft.world.level.material.Fluid

animateTick, builtInRegistryHolder, defaultFluidState, getDripParticle, getStateDefinition, is, isEmpty, isRandomlyTicking, isSource, randomTick, registerDefaultState

Methods inherited from class java.lang.Object

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

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

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

Field Details

fluidType

private final Supplier<? extends FluidType> fluidType

flowing

private final Supplier<? extends Fluid> flowing

still

private final Supplier<? extends Fluid> still

bucket

@Nullable
private final @Nullable Supplier<? extends Item> bucket

block

@Nullable
private final @Nullable Supplier<? extends LiquidBlock> block

slopeFindDistance

private final int slopeFindDistance

levelDecreasePerBlock

private final int levelDecreasePerBlock

explosionResistance

private final float explosionResistance

tickRate

private final int tickRate

Constructor Details

BaseFlowingFluid

protected BaseFlowingFluid(BaseFlowingFluid.Properties properties)

Method Details

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

Overrides:

getFluidType in class Fluid

Returns:

the type of this fluid

getFlowing

public Fluid getFlowing()

Specified by:

getFlowing in class FlowingFluid

getSource

public Fluid getSource()

Specified by:

getSource in class FlowingFluid

canConvertToSource

protected boolean canConvertToSource(Level level)

Specified by:

canConvertToSource in class FlowingFluid

canConvertToSource

public boolean canConvertToSource(FluidState state,
 Level level,
 BlockPos pos)

Description copied from interface: IFluidExtension

Returns whether the fluid can create a source.

Specified by:

canConvertToSource in interface IFluidExtension

Overrides:

canConvertToSource in class FlowingFluid

Parameters:

state - the state of the fluid

level - the level that can get the fluid

pos - the location of the fluid

Returns:

true if the fluid can create a source, false otherwise

beforeDestroyingBlock

protected void beforeDestroyingBlock(LevelAccessor worldIn,
 BlockPos pos,
 BlockState state)

Specified by:

beforeDestroyingBlock in class FlowingFluid

getSlopeFindDistance

protected int getSlopeFindDistance(LevelReader worldIn)

Specified by:

getSlopeFindDistance in class FlowingFluid

getDropOff

protected int getDropOff(LevelReader worldIn)

Specified by:

getDropOff in class FlowingFluid

getBucket

public Item getBucket()

Specified by:

getBucket in class Fluid

canBeReplacedWith

protected boolean canBeReplacedWith(FluidState state,
 BlockGetter level,
 BlockPos pos,
 Fluid fluidIn,
 Direction direction)

Specified by:

canBeReplacedWith in class Fluid

getTickDelay

public int getTickDelay(LevelReader level)

Specified by:

getTickDelay in class Fluid

getExplosionResistance

protected float getExplosionResistance()

Specified by:

getExplosionResistance in class Fluid

createLegacyBlock

protected BlockState createLegacyBlock(FluidState state)

Specified by:

createLegacyBlock in class Fluid

isSame

public boolean isSame(Fluid fluidIn)

Overrides:

isSame in class Fluid

getPickupSound

public Optional<SoundEvent> getPickupSound()

Overrides:

getPickupSound in class Fluid