Skip to main content

HudDefinition

Defined in: src/lib/module/index.ts:105

HUD feature definition.

Properties

PropertyTypeDescriptionDefined in
hudAbsolute?booleanIf true, positions the HUD absolutely in its grid cell without affecting layout. Useful for overlays like notifications that shouldn't push other elements. Default falsesrc/lib/module/index.ts:136
hudGroup?stringHUD group for visibility control. Groups can be shown/hidden together (e.g., hide all "default" HUDs when opening a full-screen page). Default "default"src/lib/module/index.ts:129
hudPosition?HudPositionGrid position in the 3x3 HUD layout. Default "top-left"src/lib/module/index.ts:115
hudPriority?numberRender priority (lower = renders first/on top). Also used as z-index for absolute HUDs. Default 0src/lib/module/index.ts:122
panel() => Promise<{ default: unknown; }>Lazy import for the panel component.src/lib/module/index.ts:109