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 level, BlockPos pos, FluidState state, RandomSource random)

Holder.Reference<Fluid>

builtInRegistryHolder()

Deprecated.

protected abstract boolean

canBeReplacedWith(FluidState state, BlockGetter level, BlockPos pos, Fluid fluid, Direction direction)

protected void

createFluidStateDefinition(StateDefinition.Builder<Fluid,FluidState> builder)

protected abstract BlockState

createLegacyBlock(FluidState state)

final FluidState

defaultFluidState()

abstract int

getAmount(FluidState state)

abstract Item

getBucket()

protected ParticleOptions

getDripParticle()

protected abstract float

getExplosionResistance()

protected abstract Vec3

getFlow(BlockGetter blockReader, BlockPos pos, FluidState fluidState)

FluidType

getFluidType()

Returns the type of this fluid.

abstract float

getHeight(FluidState state, BlockGetter level, BlockPos pos)

abstract float

getOwnHeight(FluidState state)

Optional<SoundEvent>

getPickupSound()

abstract VoxelShape

getShape(FluidState state, BlockGetter level, BlockPos pos)

StateDefinition<Fluid,FluidState>

getStateDefinition()

abstract int

getTickDelay(LevelReader level)

boolean

is(TagKey<Fluid> tag)

Deprecated.

protected boolean

isEmpty()

protected boolean

isRandomlyTicking()

boolean

isSame(Fluid fluid)

abstract boolean

isSource(FluidState state)

protected void

randomTick(Level level, BlockPos pos, FluidState state, RandomSource random)

protected final void

registerDefaultState(FluidState state)

protected void

tick(Level level, BlockPos pos, FluidState state)

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> builder)
- getStateDefinition
  
  public StateDefinition<Fluid,FluidState> getStateDefinition()
- registerDefaultState
  
  protected final void registerDefaultState(FluidState state)
- defaultFluidState
  
  public final FluidState defaultFluidState()
- getBucket
  
  public abstract Item getBucket()
- animateTick
  
  protected void animateTick(Level level, BlockPos pos, FluidState state, RandomSource random)
- tick
  
  protected void tick(Level level, BlockPos pos, FluidState state)
- randomTick
  
  protected void randomTick(Level level, BlockPos pos, FluidState state, RandomSource random)
- getDripParticle
  
  @Nullable protected ParticleOptions getDripParticle()
- canBeReplacedWith
  
  protected abstract boolean canBeReplacedWith(FluidState state, BlockGetter level, BlockPos pos, Fluid fluid, Direction direction)
- getFlow
  
  protected abstract Vec3 getFlow(BlockGetter blockReader, BlockPos pos, FluidState fluidState)
- getTickDelay
  
  public abstract int getTickDelay(LevelReader level)
- isRandomlyTicking
  
  protected boolean isRandomlyTicking()
- isEmpty
  
  protected boolean isEmpty()
- getExplosionResistance
  
  protected abstract float getExplosionResistance()
- getHeight
  
  public abstract float getHeight(FluidState state, BlockGetter level, BlockPos pos)
- getOwnHeight
  
  public abstract float getOwnHeight(FluidState state)
- createLegacyBlock
  
  protected abstract BlockState createLegacyBlock(FluidState state)
- isSource
  
  public abstract boolean isSource(FluidState state)
- getAmount
  
  public abstract int getAmount(FluidState state)
- isSame
  
  public boolean isSame(Fluid fluid)
- is
  
  @Deprecated public boolean is(TagKey<Fluid> tag)
  
  Deprecated.
- getShape
  
  public abstract VoxelShape getShape(FluidState state, BlockGetter level, BlockPos pos)
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- 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
- getPickupSound
  
  public Optional<SoundEvent> getPickupSound()
- builtInRegistryHolder
  
  @Deprecated public Holder.Reference<Fluid> builtInRegistryHolder()
  
  Deprecated.

Class Fluid

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

FLUID_STATE_REGISTRY

stateDefinition

defaultFluidState

builtInRegistryHolder

forgeFluidType

Constructor Details

Fluid

Method Details

createFluidStateDefinition

getStateDefinition

registerDefaultState

defaultFluidState

getBucket

animateTick

tick

randomTick

getDripParticle

canBeReplacedWith

getFlow

getTickDelay

isRandomlyTicking

isEmpty

getExplosionResistance

getHeight

getOwnHeight

createLegacyBlock

isSource

getAmount

isSame

is

getShape

toString

getFluidType

getPickupSound

builtInRegistryHolder