net.fabricmc.fabric.api.blockrenderlayer.v1

Interface BlockRenderLayerMap

public interface BlockRenderLayerMap

Use to associate blocks or fluids with block render layer other than default. Replaces the renderLayer property previously on Block.

BlockRenderLayer controls how sprite pixels for fluids and blocks are blended with the scene. Consult the vanilla BlockRenderLayer implementation for examples.

The Fabric Renderer API can be used to control this at a per-quad level at the code via BlendMode.

Client-side only.

Field Summary

Fields

Modifier and Type	Field and Description
static BlockRenderLayerMap	INSTANCE

Method Summary

Modifier and Type	Method and Description
void	putBlock(net.minecraft.block.Block block, net.minecraft.client.render.RenderLayer renderLayer) Map (or re-map) a block state with a render layer.
void	putBlocks(net.minecraft.client.render.RenderLayer renderLayer, net.minecraft.block.Block... blocks) Map (or re-map) multiple block states with a render layer.
void	putFluid(net.minecraft.fluid.Fluid fluid, net.minecraft.client.render.RenderLayer renderLayer) Map (or re-map) a fluid state with a render layer.
void	putFluids(net.minecraft.client.render.RenderLayer renderLayer, net.minecraft.fluid.Fluid... fluids) Map (or re-map) multiple fluid states with a render layer.
void	putItem(net.minecraft.item.Item item, net.minecraft.client.render.RenderLayer renderLayer) Map (or re-map) a item with a render layer.
void	putItems(net.minecraft.client.render.RenderLayer renderLayer, net.minecraft.item.Item... items) Map (or re-map) multiple items with a render layer.

Field Detail

INSTANCE

static final BlockRenderLayerMap INSTANCE

Method Detail

putBlock

void putBlock(net.minecraft.block.Block block,
              net.minecraft.client.render.RenderLayer renderLayer)

Map (or re-map) a block state with a render layer. Re-mapping is not recommended but if done, last one in wins. Must be called from client thread prior to world load/rendering. Best practice will be to call from mod's client initializer.

Parameters:

block - Identifies block to be mapped.

renderLayer - Render layer. Should be one of the layers used for terrain rendering.

putBlocks

void putBlocks(net.minecraft.client.render.RenderLayer renderLayer,
               net.minecraft.block.Block... blocks)

Map (or re-map) multiple block states with a render layer. Re-mapping is not recommended but if done, last one in wins. Must be called from client thread prior to world load/rendering. Best practice will be to call from mod's client initializer.

Parameters:

renderLayer - Render layer. Should be one of the layers used for terrain rendering.

blocks - Identifies blocks to be mapped.

putItem

void putItem(net.minecraft.item.Item item,
             net.minecraft.client.render.RenderLayer renderLayer)

Map (or re-map) a item with a render layer. Re-mapping is not recommended but if done, last one in wins. Must be called from client thread prior to world load/rendering. Best practice will be to call from mod's client initializer.

Parameters:

item - Identifies item to be mapped.

renderLayer - Render layer. Should be one of the layers used for entity rendering.

putItems

void putItems(net.minecraft.client.render.RenderLayer renderLayer,
              net.minecraft.item.Item... items)

Map (or re-map) multiple items with a render layer. Re-mapping is not recommended but if done, last one in wins. Must be called from client thread prior to world load/rendering. Best practice will be to call from mod's client initializer.

Parameters:

renderLayer - Render layer. Should be one of the layers used for entity rendering.

items - Identifies items to be mapped.

putFluid

void putFluid(net.minecraft.fluid.Fluid fluid,
              net.minecraft.client.render.RenderLayer renderLayer)

Map (or re-map) a fluid state with a render layer. Re-mapping is not recommended but if done, last one in wins. Must be called from client thread prior to world load/rendering. Best practice will be to call from mod's client initializer.

Parameters:

fluid - Identifies fluid to be mapped.

renderLayer - Render layer. Should be one of the layers used for terrain rendering.

putFluids

void putFluids(net.minecraft.client.render.RenderLayer renderLayer,
               net.minecraft.fluid.Fluid... fluids)

Map (or re-map) multiple fluid states with a render layer. Re-mapping is not recommended but if done, last one in wins. Must be called from client thread prior to world load/rendering. Best practice will be to call from mod's client initializer.

Parameters:

renderLayer - Render layer. Should be one of the layers used for terrain rendering.

fluids - Identifies fluids to be mapped.