API 参考 / 只读视图、场景、音频与文本

HudContext

想先跑起来？

这一页是签名与行为参考。覆盖渲染的层与 z 序。直接做一遍：教程 · 自定义 HUD。

覆盖渲染上下文。模组在 GameplayHud#renderOverlay(RenderCanvas, HudContext) 中由宿主传入，用于决定自绘内容画在哪一层、压在什么 z 顺序上。当前宿主恒传入 RenderLayer.OVERLAY 与 zOrder = 0。

方法速览

方法	用途
`layer()`	当前渲染阶段（`RenderLayer`）
`zOrder()`	覆盖层 z 顺序

java

RenderLayer layer();

行为：本次覆盖渲染所处的渲染阶段枚举；renderOverlay 的宿主调用点固定为 RenderLayer.OVERLAY（第 5 层，位于 HUD 之上、后处理滤镜之下）。示例：

java

if (hudCtx.layer() == RenderLayer.OVERLAY) { /* 常规覆盖绘制 */ }

java

int zOrder();

行为：覆盖层内的 z 顺序提示（数值越大越靠上）；当前宿主固定传 0。示例：

java

int z = hudCtx.zOrder();

java

public interface HudContext {
    RenderLayer layer();
    int zOrder();
}

线程：源码未声明额外线程约束（宿主在渲染线程同步传入）。

稳定性：2.0 起冻结：2.x 内只增不破。