Update Hud page #281
Open
Update Hud page #281
+37
−25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for nimble-elf-d9d491 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
its-miroma
added
correction
modmuss50
reviewed
Feb 12, 2025
|
|
||
| The `HudRenderCallback` event - provided by Fabric API - is called every frame, and is used to render things to the HUD. | ||
| ::: warning | ||
| Previously, Fabric provided `HudRenderCallback` to render to the hud. Due to changes to hud rendering, this event became extremely limited and is deprecated since Fabric API 0.116. Usage is strongly discouraged. Deprecated events may be removed in the future. |
There was a problem hiding this comment.
Suggested change
| Previously, Fabric provided `HudRenderCallback` to render to the hud. Due to changes to hud rendering, this event became extremely limited and is deprecated since Fabric API 0.116. Usage is strongly discouraged. Deprecated events may be removed in the future. | |
| Previously, Fabric provided `HudRenderCallback` to render to the hud. Due to changes to hud rendering, this event became extremely limited and is deprecated since Fabric API 0.116. Usage is strongly discouraged. |
I dont think you need to mention this, we tend to only remove deprecated APIs when they break becuase of a Mojang change, I expect the old event will be around for a good while longer.
|
|
||
| You should check out the [Draw Context](./draw-context) page to learn more about the draw context. | ||
| To start, we need to register a listener to `HudLayerRegistrationCallback` which registers your layers. Each layer takes a `DrawContext` and a `RenderTickCounter` instance as parameters. See the `HudLayerRegistrationCallback` and related Javadocs for more details on how to use the API. |
There was a problem hiding this comment.
Each layer takes a
DrawContextand aRenderTickCounterinstance as parameters.
This doesnt really tell the full picture, maybe its worth expanding a bit on this and saying that a layer is a IdentifiedLayer that takes a Layer, that is often a lamabda that takes those 2 params?
|
|
||
| public class HudRenderingEntrypoint implements ClientModInitializer { | ||
| @Override | ||
| public void onInitializeClient() { | ||
| // :::1 | ||
| HudRenderCallback.EVENT.register((context, renderTickCounter) -> { | ||
| // Attach our rendering code to before the chat hud layer. Our layer will render right before the chat. The API will take care of z spacing and automatically add 200 after every layer. | ||
| HudLayerRegistrationCallback.EVENT.register(layeredDrawer -> layeredDrawer.attachLayerBefore(IdentifiedLayer.CHAT, Identifier.of(FabricDocsReference.MOD_ID, "hud-example-layer"), (context, tickCounter) -> { |
There was a problem hiding this comment.
Id maybe split this into multiple lines, and possibly move the layer code out into a method.
E.g
public static final Identifier HUD_LAYER = Identifier.of(FabricDocsReference.MOD_ID, "hud-example-layer");
HudLayerRegistrationCallback.EVENT.register(layeredDrawer -> {
layeredDrawer.attachLayerBefore(IdentifiedLayer.CHAT, HUD_LAYER, this::render);
});
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.