Package net.fabricmc.fabric.api.rendering.data.v1

Interface RenderAttachedBlockView

All Superinterfaces:
BlockRenderView, BlockView, HeightLimitView
public interface RenderAttachedBlockView extends BlockRenderView
BlockRenderView-extending interface to be used by FabricBakedModel for dynamic model customization. It ensures thread safety and exploits data cached in render chunks for performance and data consistency. This interface is guaranteed to be implemented on every BlockRenderView subclass, and as such any BlockRenderView can be safely cast to RenderAttachedBlockView.

There are differences from regular World access that consumers must understand:

BlockEntity implementations that provide data for model customization should implement RenderAttachmentBlockEntity which will be queried on the main thread when a render chunk is enqueued for rebuild. The model should retrieve the results by casting the BlockRenderView to this class and then calling getBlockEntityRenderAttachment(BlockPos). While BlockView.getBlockEntity(net.minecraft.util.math.BlockPos) is not disabled, it is not thread-safe for use on render threads. Models that violate this guidance are responsible for any necessary synchronization or collision detection.

BlockView.getBlockState(net.minecraft.util.math.BlockPos) and BlockView.getFluidState(net.minecraft.util.math.BlockPos) will always reflect the state cached with the render chunk. Block and fluid states can thus be different from main-thread world state due to lag between block update application from network packets and render chunk rebuilds. Use of {link #getCachedRenderData()} will ensure consistency of model state with the rest of the chunk being rendered.

Models should avoid using BlockView.getBlockEntity(BlockPos) to ensure thread safety because this view may be accessed outside the main client thread. Models that require Block Entity data should implement RenderAttachmentBlockEntity on their block entity class, cast the BlockRenderView to RenderAttachedBlockView and then use getBlockEntityRenderAttachment(BlockPos) to retrieve the data. When called from the main thread, that method will simply retrieve the data directly.

  • Method Details

    • getBlockEntityRenderAttachment

      @Nullable default @Nullable Object getBlockEntityRenderAttachment(BlockPos pos)
      For models associated with Block Entities that implement RenderAttachmentBlockEntity this will be the most recent value provided by that implementation for the given block position.

      Null in all other cases, or if the result from the implementation was null.

      Parameters:
      pos - Position of the block for the block model.