Log inGet started
◇
component · drop-in viewer
asset⌬ componentcomponentprimary: init.luau·originates fromworld e2fc9693-0…

Hud

The face of UMBRAL, on the camera rig: the HUD, the title screen and the map.

by◐Catapulta33·posted 9d ago
What it does

umbral.Hud

The face of UMBRAL, on the camera rig: the HUD, the title screen and the map.

Attaches to: the CameraRig of the scene's PlayerPrototype (the scene calls tryAttach(rig, "umbral.Hud", {})), beside the Camera, umbral.Look and AudioListener.

What it puts on the glass

  • umbral_hud — the corner of play.png: bell medallion, VIDA and CORO in tapered bronze cases, the region name, the way into the map. Layer 20.
  • umbral_title — title.png: the bronze wordmark, the subtitle, the drowned bell, the filigree corners, the menu. Shown on entering play, layer 60, and taken down by NUEVA PARTIDA.
  • umbral_map — the rooms of umbral.Config.MAP drawn as a plan, with Ilva's mark on it.

All three scale from ui.screenSize().width, so a phone gets the same display fitted to a 410-point canvas.

What it reads

health, healthMax, coro and coroMax off the local player's umbral.Ilva component, found through layers.active.players.localPlayer, its children, or the body entity. Every read is pcalled and falls back to a safe value, because that component is another slice's and may not be attached yet. The bars ease toward the values rather than snapping.

The region comes from the world position against umbral.Config.REGIONS, and the same walk drives the region's bordón, Ilva's footsteps (one per stride of travel), the impact when a landed strike fills the Coro, a lower impact when health drops, and the bell on the echo control. Slots the engine cannot answer are skipped, never raised.

Callbacks

title_new, title_options, title_quit, toggle_map, close_map. They only fire in play.

Interface

What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.

conforms to

zero/source-extract/v2

UMBRAL · the face of the game. Lives on the camera rig. It puts up the three screens the game has — the HUD (`play.png`), the title (`title.png`) and the map — and keeps them honest: the bars follow `umbral.Ilva`'s health and Coro every frame, the region name follows the room she is standing in, and the same loop is what makes her footsteps and the room's bordón sound. Everything the slice depends on is read defensively: `umbral.Ilva` is written by another slice and may not be there, the sound clips may still be baking, and the engine's input surface differs by platform. A missing piece falls back to a safe value rather than taking the HUD with it.

canvasWidth( ) → void

canvasHeight( ) → void

localPlayerEntity( ) → void

findIlva( ) → void

readIlva( ) → void

field(name: ?, fallback: ?) → void

argtypedescription
name?
fallback?

regionFor(x: ?) → void

argtypedescription
x?

buildHud( ) → void

buildTitle( ) → void

buildMap( ) → void

showHud(on: ?) → void

argtypedescription
on?

echoPressed( ) → void

awake( ) → void

start( ) → void

standDownStockTouch( ) → void

The engine's own touch overlay (controlsKit's eight-way diamond) and the game's own three buttons from `umbral.input` were both on the glass, one on top of the other. The game's buttons are the ones drawn for UMBRAL, so the stock diamond is stood down here rather than in anyone else's files.

update(dt: ?) → void

argtypedescription
dt?

onCallback(id: ?, data: ?) → void

argtypedescription
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.

Showing up to 3 levels deep. Open a part to see what it holds further down.

27+items
▣
module · born here
❒asset
# umbral.Config The one shared module. Every number UMBRAL obeys and every table it reads lives here so a system never invents its own copy. **Read by:** `scenes/main.scene/build.luau` (which builds the map from `MAP`), `umbral.Art` (region palettes and backdrop depths), `umbral.Ilva` (the `PLAYER` tuning table), `umbral.Enemies` and `umbral.Hud`. ## What it holds | Table | What it is | |---|---| | `PALETTE` | The seven colours the whole game is drawn in, as linear rgb. Void, stone, bronze, turquoise, amber, bone, blood. | | `PLAYER` | Ilva's tuning: health, the Coro's maximum and what fills and spends it, the healing ring, i-frames, the two swings' damage and timing, the Badajo's reach, the echo's radius and duration. | | `REGIONS` | The nine regions: id, display name, the palette tint it leans on, its musical bordón, and the depth band its backdrop sits at. | | `MAP` | The geometry: `solids` (solid rectangles), `oneWay` (jumped up through), `braziers`, `bells`, and the spawn point. | ## Conventions A tile is **one world unit** and the grid is whole units. Gameplay is the plane `z = 0`. Rectangles are `{ x, y, w, h }` with `x, y` the bottom-left corner. Ilva's collision box is `0.625 × 1.25`, so a corridor is at least 3 units high and a doorway at least 2. A bell is named `bell_<name>`; hidden geometry is named `hidden_<anything>`. Those two names are the only contract between the art pass and the echo mechanic. `Config.colour(name)` returns the three channels of a palette entry so a light can be built from a name rather than from numbers repeated in five files.
▲ 0↑ born
▣
module · born here
❒asset
# umbral.sound.Sound The game's voice, in one module: the region bordón, the impact, the echo bell, the footsteps and the boss theme. ```lua local Sound = require("umbral.sound.Sound") Sound.region("nave") -- pitch the drone to that region's note, from Config.REGIONS Sound.impact() -- a landed strike: dry impact, metal tail, room resonance Sound.bell() -- the echo bell Sound.step() -- one hollow metal footstep Sound.music("boss") -- El Ciego de la Nave's theme; Sound.music() stops it ``` It owns one entity with three `Audio` components (ambience / music / one-shots), created on first use and reused after, and it resolves each clip from `umbral/sound/clips/` — a clip that is not baked yet is skipped instead of raising, so the game keeps running. The bordón is one generated bowed drone, pitched per region to the note `umbral.Config.REGIONS` gives it (D2 at the Campanario, A1 in the Nave, …). `corazon` has no note on purpose: the Corazón de la Campana is the one region with no drone, and that silence is the design.
▲ 0↑ born
▣
module · born here
❒asset
# umbral.ui.HudScreen The in-play HUD, from `references/raw/play.texture/play.png`: the bell medallion, the VIDA bar and the CORO bar, the region name and the way into the map. `HudScreen.build(state)` returns the widget tree; it holds no state, so the component rebuilds it whenever a value moves. | key | what | |---|---| | `health`, `healthMax` | fragments of the bell she has left; the bar is cut into that many ticks | | `coro`, `coroMax` | the Coro; filled by landing hits, spent to heal | | `region` | `{ name, id }` — the name set at the bottom left | | `width` | the canvas width in points; everything scales from it, so a phone gets a smaller HUD | The VIDA fill is bone, the CORO fill turquoise, both inside the same bronze case with the tapered right end the reference draws. The region row is the tap target that opens the map.
▲ 0↑ born
▣
module · born here
❒asset
# umbral.ui.TitleScreen The title screen, from `references/raw/title.texture/title.png`. `TitleScreen.build({ width, optionsOpen })` returns the tree: - **UMBRAL**, drawn as SVG text in EB Garamond with a bronze gradient, a dark engraved offset and a turquoise halo, over a hairline and the subtitle `BAJO EL MAR, ALGUIEN SIGUE LLAMANDO` in wide-tracked small caps. - **The drowned bell** hanging in the shaft of turquoise light, its crack lit, the water line under it and the room blacking out at the edges. - **Filigree corners** mirrored on all four, and the menu down the left — `NUEVA PARTIDA`, `OPCIONES`, `SALIR` — each a serif caps row with a bronze gem in front of it, sliding in after the wordmark. - `optionsOpen` adds the controls panel, listing what the game binds on keyboard. Callbacks are the row ids: `title_new`, `title_options`, `title_quit`; `umbral.Hud` handles them.
▲ 0↑ born
▣
module · born here
❒asset
# umbral.ui.MapScreen The map screen. It is drawn from `umbral.Config.MAP`, so every solid the scene builds appears as a room outline, the one-way ledges as hairlines, the bells as turquoise lanterns and the braziers as amber points — the map cannot drift from the rooms it describes. `MapScreen.build({ width, player })` returns the tree with the bone mark at `player` and the `close_map` callback on the way back. Opens from the region row of the HUD, and from `M`.
▲ 0↑ born
◇
component · born here
❒asset
# umbral.Ilva Ilva herself, beyond her body: the bell fragments she has left, the Coro, the Badajo's two swings, i-frames and knockback, the healing ring, death and the return to the last bell, and the game's signature verb — ring a bell and the room's hidden geometry shows. **Attaches to:** the player body, beside `twoDKit.Player2D`. The motor on that body owns her movement; this component never replaces it, it reads `state()` and touches her position only to hold her during a healing ring, to shove her with a blow, and to put her back at the last bell. It reads its controls through the `umbral` controlsKit scheme (`Combat.registerScheme`). ## Fields | Field | Sync | What | |---|---|---| | `health` | yes | Bell fragments left. The HUD draws this. | | `healthMax` | yes | Bell fragments she can hold. | | `coro` | yes | The Coro: filled by a landed strike, spent by the healing ring. | | `coroMax` | yes | How much Coro she can hold. | | `dead` | yes | Down, and walking back to the last bell. | | `swing` | yes | `light`, `heavy`, or empty. | | `chain` | yes | Where she is in the three-strike chain. | | `healing` | yes | Holding the healing ring: held still until it lands or she lets go. | | `revealed` | yes | The room's hidden geometry is lit by the last echo. | | `lastBell` | yes | The last bell she rang, bare name. Respawn goes there. | | `invuln` | no | Seconds of i-frames left after a blow. | ## Verbs - **Toque ligero** — tap attack. Three chainable strikes; the third reaches further and recovers slower. A press inside `chainFrom` queues the next one. - **Toque pesado** — hold attack past the light swing. Descending, heavier, anchors her. - **Campanada** — hold heal standing on the ground with Coro to spare. She is pinned to the spot for `healTime`, pays `coroPerHeal`, gains `healAmount`. - **Eco** — press echo. Rings the nearest `bell_` in `ecoRadius` and shows every `hidden_` entity for `ecoTime` seconds. A swing that touches a bell does the same. ## Methods `takeHit(damage, dirX)` — a blow from anything that wants to hurt her. `kill()`, `addCoro(amount)`, `status()`.
▲ 0↑ born
backing path · umbral/Hud.component

Problems

Everything affecting this asset right now: its own problems, anything wrong inside it, and problems on its direct dependencies.

0problems
No problems reported on this asset or on the parts this page shows. Parts it leaves out are not counted here.
⌬ZeroMind agent review · awaiting first pass
Findings
Reviewer findings (handle · model · tag · quoted note) appear here once the per-pass review log lands. Today only the rolled-up agent_score is exposed.
usability—
did it work as advertised
quality—
authoring polish + cohesion
performance—
frame & memory budget held
agent review score
—
/ 100
awaiting first pass
usability × 0.40
+ 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".

—%no reports yet
Sign in to report whether this part worked for you.
Discussion

Scoped to this part · feeds back into the world's score.

0comments
Sign in to post.sign in
No comments yet. Be the first.