372
edits
Changes
From Forge Community Wiki
Copy Block Entity Renderer to MC1.18 archive
A <code>BlockEntityRenderer</code> or <code>BER</code> is used to render blocks in a way that cannot be represented with a static baked model (JSON, OBJ, B3D, etc.). A block entity renderer requires the block to have a <code>BlockEntity</code>.
== Creating a BER ==
To create a BER, create a class that inherits from <code>BlockEntityRenderer</code>. It takes a generic argument specifying the block's <code>BlockEntity</code> class. The generic argument is used in the BER's <code>render</code> method.
Only one BER exists for a given <code>BlockEntityType</code>. Therefore, values that are specific to a single instance in the world should be stored in the block entity being passed to the renderer rather than in the BER itself. For example, an integer that increments every frame, if stored in the BER, will increment every frame for every block entity of this type in the world.
=== <code> render </code> ===
This method is called every frame in order to render the block entity.
=== Parameters ===
* <code>blockEntity</code>: This is the instance of the block entity being rendered.
* <code>partialTicks</code>: The amount of time, in fractions of a tick, that has passed since the last full tick.
* <code>poseStack</code>: A stack holding four-dimensional matrix entries offset to the current position of the block entity.
* <code>bufferSource</code>: A rendering buffer able to access a vertex consumer.
* <code>combinedLight</code>: An integer of the current light value on the block entity.
* <code>combinedOverlay</code>: An integer set to the current overlay of the block entity, usually <code>OverlayTexture#NO_OVERLAY</code> or 655,360.
==Registering a BER==
In order to register a BER, you must subscribe to the <code>EntityRenderersEvent$RegisterRenderers</code> event on the mod event bus and call <code>#registerBlockEntityRenderer</code>.
== Creating a BER ==
To create a BER, create a class that inherits from <code>BlockEntityRenderer</code>. It takes a generic argument specifying the block's <code>BlockEntity</code> class. The generic argument is used in the BER's <code>render</code> method.
Only one BER exists for a given <code>BlockEntityType</code>. Therefore, values that are specific to a single instance in the world should be stored in the block entity being passed to the renderer rather than in the BER itself. For example, an integer that increments every frame, if stored in the BER, will increment every frame for every block entity of this type in the world.
=== <code> render </code> ===
This method is called every frame in order to render the block entity.
=== Parameters ===
* <code>blockEntity</code>: This is the instance of the block entity being rendered.
* <code>partialTicks</code>: The amount of time, in fractions of a tick, that has passed since the last full tick.
* <code>poseStack</code>: A stack holding four-dimensional matrix entries offset to the current position of the block entity.
* <code>bufferSource</code>: A rendering buffer able to access a vertex consumer.
* <code>combinedLight</code>: An integer of the current light value on the block entity.
* <code>combinedOverlay</code>: An integer set to the current overlay of the block entity, usually <code>OverlayTexture#NO_OVERLAY</code> or 655,360.
==Registering a BER==
In order to register a BER, you must subscribe to the <code>EntityRenderersEvent$RegisterRenderers</code> event on the mod event bus and call <code>#registerBlockEntityRenderer</code>.