Package net.neoforged.neoforge.fluids

Class FluidInteractionRegistry

java.lang.Object

net.neoforged.neoforge.fluids.FluidInteractionRegistry

public final class FluidInteractionRegistry
extends Object

A registry which defines the interactions a source fluid can have with its surroundings. Each possible flow direction is checked for all interactions with the source.

Fluid interactions mimic the behavior of LiquidBlock#shouldSpreadLiquid. As such, all directions, besides Direction.DOWN is tested and then replaced. Any fluids which cause a change in the down interaction must be handled in FlowingFluid#spreadTo and not by this interaction manager.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FluidInteractionRegistry.FluidInteraction	An interface which performs an interaction for a source.
static interface	FluidInteractionRegistry.HasFluidInteraction	An interface which tests whether a source fluid can interact with its surroundings.
static final record	FluidInteractionRegistry.InteractionInformation	Holds the interaction data for a given source type on when to succeed and what to perform.

Field Summary

Fields

Modifier and Type	Field	Description
private static final Map<FluidType,List<FluidInteractionRegistry.InteractionInformation>>	INTERACTIONS

Constructor Summary

Constructors

Constructor	Description
FluidInteractionRegistry()

Method Summary

Modifier and Type	Method	Description
static void	addInteraction(FluidType source, FluidInteractionRegistry.InteractionInformation interaction)	Adds an interaction between a source and its surroundings.
static boolean	canInteract(Level level, BlockPos pos)	Performs all potential fluid interactions at a given position.

Methods inherited from class java.lang.Object

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

Field Details

INTERACTIONS

private static final Map<FluidType,List<FluidInteractionRegistry.InteractionInformation>> INTERACTIONS

Constructor Details

FluidInteractionRegistry

public FluidInteractionRegistry()

Method Details

addInteraction

public static void addInteraction(FluidType source,
 FluidInteractionRegistry.InteractionInformation interaction)

Adds an interaction between a source and its surroundings.

Parameters:

source - the source of the interaction, this will be replaced if the interaction occurs

interaction - the interaction data to check and perform

canInteract

public static boolean canInteract(Level level,
 BlockPos pos)

Performs all potential fluid interactions at a given position.

Note: Only the first interaction check that succeeds will occur.

Parameters:

level - the level the interactions take place in

pos - the position of the source fluid

Returns:

true if an interaction took place, false otherwise