Clarify an aspect about the block renderer registry (FabricMC#1035)

* Clarify an aspect about the block renderer registry. * Update fabric-renderer-registries-v1/src/main/java/net/fabricmc/fabric/api/client/rendereregistry/v1/BlockEntityRendererRegistry.java Co-authored-by: liach <[email protected]> Co-authored-by: liach <[email protected]>
DimensionalDevelopment · Sep 27, 2020 · bbdb433 · bbdb433
1 parent 616c012
commit bbdb433
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/...n/java/net/fabricmc/fabric/api/client/rendereregistry/v1/BlockEntityRendererRegistry.java b/...n/java/net/fabricmc/fabric/api/client/rendereregistry/v1/BlockEntityRendererRegistry.java
@@ -32,10 +32,12 @@ public interface BlockEntityRendererRegistry {
 	BlockEntityRendererRegistry INSTANCE = new BlockEntityRendererRegistryImpl();
 
 	/**
-	 * Register a BlockEntityRenderer for a BlockEntityType. Can be called clientside before the world is rendered
+	 * Register a BlockEntityRenderer for a BlockEntityType. Can be called clientside before the world is rendered.
 	 *
 	 * @param blockEntityType the {@link BlockEntityType} to register a renderer for
-	 * @param blockEntityRenderer a function that returns a {@link BlockEntityRenderer}
+	 * @param blockEntityRenderer a function that returns a {@link BlockEntityRenderer}, called
+	 *                            when {@link BlockEntityRenderDispatcher} is initialized or immediately if the dispatcher
+	 *                            class is already loaded
 	 * @param <E> the {@link BlockEntity}
 	 */
 	<E extends BlockEntity> void register(BlockEntityType<E> blockEntityType, Function<BlockEntityRenderDispatcher, BlockEntityRenderer<E>> blockEntityRenderer);