HUD
<!-- zero:scaffolded-readme --> <!-- Replace the line below with what this component provides and who consumes it, then delete both comment lines. -->
HUD
<!-- zero:scaffolded-readme --> <!-- Replace the line below with what this component provides and who consumes it, then delete both comment lines. -->TODO: describe this component.
Interface
What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.
conforms to
zero/source-extract/v2game/HUD.component/init.luau THE MISSING FLOOR — every screen the player reads. Authored, not default: a chosen palette (near-black, bone, institutional green, rust, brass), real type (Anton for the wordmark, Arimo for prose, JetBrains Mono for anything a machine would have printed), and nothing on screen that does not belong there. mf_card the title, the pause menu and the ending — layer 800 mf_hud crosshair, prompt, torch, objective, toasts — layer 10 mf_overlay the inventory and the clue journal — layer 20 mf_intro the two opening lines — layer 400 mf_dark the fade to black when the presence takes you — layer 900 It drives nothing. Every button it draws carries a string id, and every click arrives at the scene entrypoint's onCallback, which puts it on the bus as `ui`; Session answers new_game / continue / restart / quit / resume, and this component answers the rest. It listens for `prompt`, `objective`, `toast`, `intro`, `dark`, `ending`, `torch` and `clue`.
txt(text: ?, size: ?, color: ?, style: ?) → void
| arg | type | description |
|---|---|---|
| text | ? | |
| size | ? | |
| color | ? | |
| style | ? |
menuRow(text: ?, id: ?, color: ?, enabled: ?) → void
A menu row. This has to be a real `button`: `onClick` is a per-type prop, and a `horizontal` container does not have it — a clickable-looking row built out of a container is silently inert, which is exactly how NEW GAME came to do nothing at all.
| arg | type | description |
|---|---|---|
| text | ? | |
| id | ? | |
| color | ? | |
| enabled | ? |
scrim(children: ?, opts: ?) → void
| arg | type | description |
|---|---|---|
| children | ? | |
| opts | ? |
panel(children: ?, opts: ?) → void
| arg | type | description |
|---|---|---|
| children | ? | |
| opts | ? |
titleTree( ) → void
pauseTree( ) → void
settingsTree( ) → void
slider(name: ?, field: ?, valueLabel: ?) → void
| arg | type | description |
|---|---|---|
| name | ? | |
| field | ? | |
| valueLabel | ? |
inventoryTree( ) → void
journalTree( ) → void
endingTree( ) → void
readTree( ) → void
hudTree( ) → void
introTree( ) → void
darkTree( ) → void
push( ) → void
register(all: ?) → void
| arg | type | description |
|---|---|---|
| all | ? |
wire( ) → void
awake( ) → void
start( ) → void
update(dt: ?) → void
Keyboard shortcuts the pause menu documents.
| arg | type | description |
|---|---|---|
| dt | ? |
onModuleReload(path: ?) → void
| arg | type | description |
|---|---|---|
| path | ? |
onDestroy( ) → void
onCallback(id: ?, data: ?) → void
The scene entrypoint forwards every callback onto the bus as `ui`, but a component's own onCallback also fires when the click lands on its widget; this keeps the shortcuts local so the screen works even if nothing else is wired.
| arg | type | description |
|---|---|---|
| id | ? | |
| data | ? |
Sub-parts
Everything contained inside this part. Assets are composite children (clickable cards). Files are leaf payloads. Expand any row to view its source.
Problems
Everything affecting this asset right now: its own problems, anything wrong inside it, and problems on its direct dependencies.
Inside
1 problem across 1 itemagent_score is exposed.+ quality × 0.35
+ performance × 0.25
± compat factor
Usability ratings
Did the part work as advertised when consumers tried to drop it in. Separate from upvotes: those are taste; this is "did it function".
Scoped to this part · feeds back into the world's score.