UniHudRender
Minecraft-independent entry point for registering and managing in-game HUD layers.
Overview
UniHudRender provides static helper methods to bind widget trees or UniRenderLayer instances to the game's in-game HUD (UniRenderTarget.HUD). Layers can define dynamic visibility predicates and z-ordering priority.
Z-Ordering and Visibility Filtering
Layers with higher priority integers render on top of lower priority layers.
- Default Priority: 0
- Visibility Predicate: Controls conditional visibility per frame (e.g. hiding when F1 mode is active).
Registering a HUD Widget
Widget healthBar = new HealthBarWidget();
UniRenderLayerRegistration reg = UniHudRender.register(
new UniRenderLayer(healthBar),
ctx -> true,
10
);
API
UniHudRender::clear()
clear()
Clears and closes all registered HUD layers.
UniHudRender::register(UniRenderLayer)
register(UniRenderLayer)
Registers a configured UniRenderLayer as a HUD layer with default visibility and priority 0.
| Parameter | Type | Description |
|---|---|---|
layer |
UniRenderLayer |
Configured UniRenderLayer. |
Returns UniRenderLayerRegistration: Registration handle..
UniHudRender::register(UniRenderLayer, Predicate, int)
register(UniRenderLayer, Predicate
Registers a UniRenderLayer in HUD with visibility condition and priority.
| Parameter | Type | Description |
|---|---|---|
layer |
UniRenderLayer |
Render layer to register. |
visibility |
Predicate |
Visibility predicate tested before rendering. |
priority |
int |
Rendering order priority. |
Returns UniRenderLayerRegistration: Registration handle..
UniHudRender::register(Widget)
register(Widget)
Registers a root widget as a HUD layer with default settings.
| Parameter | Type | Description |
|---|---|---|
root |
Widget |
Root widget to render. |
Returns UniRenderLayerRegistration: Registration handle..
UniHudRender::register(Widget, UIContext)
register(Widget, UIContext)
Registers a root widget with an explicit UIContext as a HUD layer.
| Parameter | Type | Description |
|---|---|---|
root |
Widget |
Root widget to render. |
context |
UIContext |
UIContext to bind. |
Returns UniRenderLayerRegistration: Registration handle..