net.fabricmc.fabric.api.client.render.fluid.v1

Interface FluidRenderHandler

public interface FluidRenderHandler

Interface for handling the rendering of a FluidState.

Method Summary

Modifier and Type	Method and Description
default int	getFluidColor(@Nullable net.minecraft.world.BlockRenderView view, @Nullable net.minecraft.util.math.BlockPos pos, net.minecraft.fluid.FluidState state) Get the tint color for a fluid being rendered at a given position.
net.minecraft.client.texture.Sprite[]	getFluidSprites(@Nullable net.minecraft.world.BlockRenderView view, @Nullable net.minecraft.util.math.BlockPos pos, net.minecraft.fluid.FluidState state) Get the sprites for a fluid being rendered at a given position.

Method Detail

getFluidSprites

net.minecraft.client.texture.Sprite[] getFluidSprites(@Nullable
                                                      @Nullable net.minecraft.world.BlockRenderView view,
                                                      @Nullable
                                                      @Nullable net.minecraft.util.math.BlockPos pos,
                                                      net.minecraft.fluid.FluidState state)

Get the sprites for a fluid being rendered at a given position. For optimal performance, the sprites should be loaded as part of a resource reload and *not* looked up every time the method is called!

The "fabric-textures" module contains sprite rendering facilities, which may come in handy here.

Parameters:

view - The world view pertaining to the fluid. May be null!

pos - The position of the fluid in the world. May be null!

state - The current state of the fluid.

Returns:

An array of size two: the first entry contains the "still" sprite, while the second entry contains the "flowing" sprite.

getFluidColor

default int getFluidColor(@Nullable
                          @Nullable net.minecraft.world.BlockRenderView view,
                          @Nullable
                          @Nullable net.minecraft.util.math.BlockPos pos,
                          net.minecraft.fluid.FluidState state)

Get the tint color for a fluid being rendered at a given position.

Note: As of right now, our hook cannot handle setting a custom alpha tint here - as such, it must be contained in the texture itself!

Parameters:

view - The world view pertaining to the fluid. May be null!

pos - The position of the fluid in the world. May be null!

state - The current state of the fluid.

Returns:

The tint color of the fluid.