Difference between revisions of "Block Entity Renderer"
(Fix formatting) |
m (Missed one) |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 6: | Line 6: | ||
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. | 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> === | + | === <code>render</code> === |
| − | |||
This method is called every frame in order to render the block entity. | This method is called every frame in order to render the block entity. | ||
=== Parameters === | === Parameters === | ||
| + | |||
* <code>blockEntity</code>: This is the instance of the block entity being rendered. | * <code>blockEntity</code>: This is the instance of the block entity being rendered. | ||
| − | * <code> | + | * <code>partialTick</code>: The amount of time, in a fraction 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>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>bufferSource</code>: A rendering buffer able to access a vertex consumer. | ||
| Line 18: | Line 18: | ||
* <code>combinedOverlay</code>: An integer set to the current overlay of the block entity, usually <code>OverlayTexture#NO_OVERLAY</code> or 655,360. | * <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== | + | == 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>. | 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>. | ||
Latest revision as of 19:04, 12 October 2022
A BlockEntityRenderer or BER 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 BlockEntity.
Creating a BER
To create a BER, create a class that inherits from BlockEntityRenderer. It takes a generic argument specifying the block's BlockEntity class. The generic argument is used in the BER's render method.
Only one BER exists for a given BlockEntityType. 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.
render
This method is called every frame in order to render the block entity.
Parameters
blockEntity: This is the instance of the block entity being rendered.partialTick: The amount of time, in a fraction of a tick, that has passed since the last full tick.poseStack: A stack holding four-dimensional matrix entries offset to the current position of the block entity.bufferSource: A rendering buffer able to access a vertex consumer.combinedLight: An integer of the current light value on the block entity.combinedOverlay: An integer set to the current overlay of the block entity, usuallyOverlayTexture#NO_OVERLAYor 655,360.
Registering a BER
In order to register a BER, you must subscribe to the EntityRenderersEvent$RegisterRenderers event on the mod event bus and call #registerBlockEntityRenderer.