Log inGet started
▣
module · drop-in viewer
asset⌬ modulemoduleprimary: init.luau·part ofmodule zinput.module·originates fromworld 07158574-5…

touchControls

On-screen touch overlay: a renderer + worker, not an event-driven widget net. The worker reads raw touches (`Zin.touch.slots()`) and routes them into zone geometry derived from the live bindings, writing `Zin.virtual` (stick/button/drag). `Zin.tick` runs the worker early — after…

byzero-proxy @ DESKTOP-DB3UJOJ·posted 4mo ago
What it does

touchControls

On-screen touch overlay: a renderer + worker, not an event-driven widget net. The worker reads raw touches (Zin.touch.slots()) and routes them into zone geometry derived from the live bindings, writing Zin.virtual (stick/button/drag). Zin.tick runs the worker early — after Virtual._beginFrame() clears the previous tick's drag deltas and before the binding evaluators read Zin.virtual — so the touch binding kinds consume those values on the SAME tick they're written. The renderer (a canvas screen declaring pointerEvents = "none") only draws and takes no pointer, so every widget beneath it, in any screen at any layer, still receives the presses that land on it. Backs Zin.touchControls.

Who a contact belongs to

  • A contact that begins on a drawn button, the fan or an open sheet entry is that control's alone. The overlay states those circles to the input layer with input.setTouchClaims (in the window's pixels, where the input layer meets a contact as it arrives), and a contact beginning inside one drives no pointer: no widget beneath the button is pressed by it, and no mouse button reads held.
  • Each contact is routed on its own, by where it began, so a thumb on the stick and a finger on a HUD button each do their own job. The overlay also states the stick and look zones to the input layer (setTouchClaims's zones). A contact beginning in a zone drives the pointer while no other contact does, and the UI decides whether a widget beneath it takes its press. When one does, the contact is the widget's: on the tick after it began, the zone that took it lets it go before it has moved anything. When none does, the input layer hands the contact to the overlay: it lets the pointer go, the scene reads no press from it, and the next finger to land drives the pointer, so it presses a content button while the thumb steers. A contact beginning in a zone while another contact drives the pointer is the zone's at once. Zin.touch states each contact's owner ("zin_touch_controls" for a contact the overlay holds).
  • A contact the input layer gives another owner (its owner names a claim owner other than the overlay's: a world that draws touch controls of its own states their regions with input.setTouchClaims too) is that owner's. The overlay routes it to none of its controls, so a press on a world's own button presses no button, stick or look area of the overlay's lying beneath it.
  • Everything left falls to the stick and look zones below.

Coordinate space

Touch contacts (Zin.touch.slots() — t.x/t.y/t.dx/t.dy) carry PHYSICAL pixels of the scene viewport the overlay draws over, measured from its top-left: the space Zin.state.get().mouse_position reads the pointer in. Every widget geometry computation — button/stick positions, the canvas root's style.width/height — lives in ui.screenSize()'s LOGICAL space (the space ui.registerScreen / ui.getLayoutInfo use), which differs from the physical space whenever the display's pixels_per_point ~= 1 (HiDPI). An internal logicalScale helper computes the screenSize / viewportSize ratio once per tick, and every touch coordinate this module reads is scaled by it before use.

Safe area

Every control keeps inside the part of the overlay no system bar, display cutout or on-screen keyboard covers. ui.safeArea() states that part of the picture the overlay's screen lays out in (the scene viewport's, at ui.screenSize()), and the overlay takes it into its own space, which leaves a safe rect L/T in from the left and top edges, SW x SH in size (the whole picture where the picture lies inside the window's safe area, as a Scene panel does). The zones, the button column and the stick all lie inside it, a contact beginning outside it starts none of them, and layout().safe reports it.

The space the controls leave a game screen

The overlay states the bounding square of every drawn button, the fan and the open sheet's entries with ui.setControlRegions("zin_touch_controls", rects), in the points of ui.screenSize(), the canvas a game's screens lay out on, and states them again whenever they change (a button added or removed, the context, the screen size or the safe area changing, the fan sheet opening) and withdraws them when the overlay leaves the screen. A game screen reads them as ui.safeArea().controls, and an anchor of any other screen moves clear of them on its own. The list holds the drawn controls alone: a widget laid out over the stick or look zone takes the presses that land on it.

Size on the glass

Every radius, inset and gap is in the points ui.screenSize() reports. On a phone or a tablet a point covers at least the display's density (ui.displayScale()), so the controls keep one physical size on every phone and in both orientations: a 40 point "small" button is 80 dp across, past the 48 dp touch target. layout() reports the radii in points; multiply by the pixels one of the overlay's points covers for their size on the glass: the width ui.getLayoutInfo("zin_touch_controls_canvas") gives its canvas, over layout().safe.width, times ui.pixelRatio(). Button labels are canvas text sized from the button's radius, so the user's text scale leaves them inside their circles.

Zone geometry (fractions of the safe rect, SW/SH)

  • stick - activation region x < L + 0.4*SW and y > T + 0.4*SH (left 40%, bottom 60%). A floating stick: the base spawns at the touch's start point, the thumb clamps to a 96px radius, and the vector fed to Zin.virtual.setStick is offset / 96 with y screen-down positive (matching setStick's documented convention).
  • buttons — one circle per touchButton binding among the LIVE bindings (Zin.scheme.bindings() — what awake components asked for, so every button corresponds to a control some world actually consumes), budgeted into a two-column band along the safe rect's right edge, between 45% of its height and its bottom edge less the inset. Buttons sort by (priority, id) - the touchButton's priority option, authored default 50, synthesized default 100 — with same-group buttons kept adjacent, then fill the two columns growing inward from the bottom-right corner. Each circle is the radius ITS OWN size option names (small 40px, medium 56px, large 72px), so a scheme mixing a large action button with a small pause pip draws them at 72 and 40 whatever else is live; the largest of those radii is the slot pitch and the row budget the column packs on, so the set decides where a button sits and the button's own declaration decides how big it is. More than 4 authored buttons walk every button one step down its own size, which layout() reports as appliedSize. Anything past the two-column budget doesn't render individually — the last slot becomes a ... fan button; tapping it opens a rows-of-3 grid sheet holding the overflow (same tap/hold behavior as a regular button), and tapping the fan again, or any layout-invalidating context/map change, closes it.
  • corner buttons - a touchButton whose place is "corner" sits in the top-right corner of the safe area instead, in a row growing leftward along the top edge in (priority, id) order, each at its own size. A row ends at the look area's left edge (L + 0.4*SW), so the top-left quadrant stays free, and the next button starts a row below it. Corner buttons count toward neither the column's budget nor its step-down, keep their place whatever the column holds, and the column's band starts below their lowest row. The app menu's Menu button (@builtin::inputMaps.app) is one.
  • drag - everything else in the safe rect at x >= L + 0.4*SW (accumulates into Zin.virtual.addDrag every tick from the contact's per-frame delta).
  • the remaining top-left quadrant (x < L + 0.4*SW and y <= T + 0.4*SH) is unclaimed - free for other UI.

A control is drawn only when it is live AND subscribed: a button offered for a control nothing listens to is an offer that cannot be kept, so the layout tracks Zin.scheme.subscriberEpoch() alongside Zin.scheme.generation().

Only bindings whose context matches the current input context (Zin.context.current()) contribute controls, so a vehicle-context Brake button neither renders nor claims touches while the default context is on top. The layout rebuilds when the live set, the subscriber count, the context, the screen size or the safe area changes.

A record-shaped map applied through Zin.map.activate contributes its touch classes too. A control whose name is already live as an asset is skipped, so a world carrying both never draws the same control twice under two ids.

A contact is assigned to a region on its began phase only (a contact-id -> assignment map) and released on ended / cancelled / vanishing from Zin.touch.slots(). Button circle hit-tests (visible buttons, the fan, the open sheet's entries) take precedence over the stick/drag zone checks — a button is a precise target and wins wherever it lands, including inside a zone (the open sheet grows leftward and can reach the stick zone on a narrow screen). A contact claimed by the stick or a button never also feeds the drag zone (a contact is assigned to exactly one region), so its projected-mouse / touchDrag state never competes with a look/aim consumer reading Zin.virtual.drag — no extra suppression is needed beyond the region assignment itself.

A pinch and the drag region share the same space, so the two are arbitrated once per tick. The contacts the stick and the buttons hold are published to Zin.gestures, which forms its two-finger pair out of what is left; while the active map declares a touchPinch control and that pair is down, the drag region reports nothing. A pinch made over the look surface therefore reaches the pinch control alone, a thumb resting on the movement stick is no part of a pinch so the other thumb keeps looking, and lifting one finger from a pinch drags again.

Rendering

One screen ("zin_touch_controls", layer 200) whose root is a single transparent canvas sized to the safe rect, taking no pointer. The screen lays out inside the safe area, so the canvas starts at the rect's corner and every command is drawn from there. Commands rebuild only when the draw state actually changed (a dirty flag) — buttons are always drawn while mounted; the stick draws only while a stick contact is live.

Auto-mount

Every _advance() checks Zin.surface.current() — "touch" registers (lazily, once) and shows the screen; anything else hides it. Visibility is purely the surface class, in edit and play alike. M._forceMount(true) bypasses the surface gate for headless testing. Touch routing runs on every tick a contact is down, held by a control or waiting on the UI's answer, and on every tick the overlay is on screen or coming up, whatever the mount state, so a forced or real touch always drives Zin.virtual even before the overlay is visible. A session nobody is touching, with the overlay off screen, routes nothing.

Adding a control while the world runs

The overlay draws a button for a control that is live and subscribed, so adding one at runtime is adding a control asset, activating it, and subscribing to it — the three steps a component takes in awake, in one call:

local h = Zin.touchControls.addControl({
    name = "cast", label = "Cast",
    kbm = Zin.bindings.key("KeyF"),
    gamepad = Zin.bindings.padButton("north"),
    onPressed = function() castSpell() end,
})
Zin.touchControls.removeControl(h)

The control becomes a real <name>.inputMap/<name>.inputBinding/ under /source/runtimeControls/, so it is inspectable, rebindable and publishable like any other, and its name is its id in Zin.scheme.bindings() / Zin.scheme.fired(). removeControl releases it — off the screen, out of the live set, every subscription dropped — and leaves the asset, so re-adding the same name reuses it and its guid.

M.button(opts) is the same idea against a record-shaped map applied through Zin.map.activate, in two flavors:

  • { action = "jump" } attaches an extra touchButton binding to an existing action on the active map.
  • { emit = "KeyF", label = "Cast" } registers an overlay-only button: a synthetic emit:KeyF action carrying both the kbm key binding and the touchButton, so the emulation floor drives KeyF through the same binding/emulation path every other control uses.

Both return a handle for M.removeButton(handle).

Exports

  • M.addControl(opts: ControlOpts) -> number / M.removeControl(handle) -> boolean — add or release a control while the world runs.
  • M.controls() -> { { handle, name, path } } — every control addControl currently holds, in the order they were added.
  • M.button(opts) -> number / M.removeButton(handle) -> boolean — the button API described above.
  • M.claimed() -> { number } — the contact ids currently claimed by the stick, a button, or the drag zone.
  • M.primaryClaimed() -> boolean — whether an on-screen control owns the contact driving the pointer (Zin.touch pointer = true). Zin.bindings consults this so a thumb on the stick or the look area does not also fire whatever the world bound to left-click in the frames before the UI has decided its press, while a finger on bare scene beside a thumb on the stick reads as the press it is.
  • M.layout() -> { buttons, fan?, stick?, drag?, pinch?, width, height, safe } - the current control layout (a copy): buttons is the budgeted, VISIBLE stack in draw order, the corner rows after the column, each entry { id, label, actionName, priority, size, appliedSize, group, place, cx, cy, radius } in ui.screenSize() space: place is "column" or "corner", size is the step the binding declared and appliedSize the one radius came from, which differ only where a rich scheme's step-down moved a button one size down; fan is nil unless the button set exceeded the two-column budget, else { open, cx, cy, radius, buttons } — open is whether the overflow sheet is expanded, buttons the overflowed entries at their sheet positions (tappable only while open); stick / drag name the axis + virtual zone each region feeds, and pinch the axis the two-finger recognizer feeds; safe is the safe rect { x, y, width, height } every control keeps inside. Backs custom control-placement UI and headless tests that aim simulated touches at a button's (or the fan's) center.
  • M._advance() — internal: one tick (touch routing, layout, auto-mount, repaint). Wired into Zin.tick, before Zin.emulation._advance().
  • M._forceMount(on: boolean) — test-only: force mounting regardless of Zin.surface.current().
  • M._setViewportOverride(w?, h?) — test-only: override the logical screen size the layout budget/fan math reads, without resizing the real window. Pass nil/nil to clear.
  • M._reset() — test-only: unmount, clear routing/layout state, drop buttons, release every runtime control, close the fan, and clear the viewport override.

Interface

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

conforms to

zero/source-extract/v2

ZinputTouchControls Module On-screen touch overlay: a renderer and a worker. The worker (`_advance()`, wired into `Zin.tick`) reads raw touches (`Zin.touch.slots()`) and routes them into zone geometry derived from the active effective map, writing `Zin.virtual` (stick/button/drag). `Zin.tick` runs this worker early — right after `Virtual._beginFrame()` clears the previous tick's drag deltas and before the axis/action evaluators read `Zin.virtual` — so the values it writes are consumed THIS tick, not the next. The renderer (a `canvas` screen declaring `pointerEvents = "none"`) only draws and takes no pointer, so every widget beneath it, in any screen, still receives the presses that land on it. Backs `Zin.touchControls`. Who a contact belongs to: * a contact beginning on a drawn button, the fan or an open sheet entry is that control's alone. The overlay states those circles to the input layer (`input.setTouchClaims`), which keeps such a contact from driving the pointer, so no widget beneath the button is pressed by it. * each contact is routed on its own, by where it began. The overlay states the stick and look zones to the input layer too, as zones: a contact beginning in one drives the pointer while no other contact does, and the UI decides whether a widget takes its press. When it does, the contact is the widget's: the stick and look zones let it go on the tick after it began, before it has moved anything. When none does, the input layer hands the contact to the overlay (its `owner` reads this module's claim owner): it lets the pointer go, so the next finger to land presses a content widget while the first steers. A contact beginning in a zone while another drives the pointer is the zone's at once. * a contact the input layer gives another owner (its `owner` names a claim owner other than this module's: a world that draws touch controls of its own states their regions the same way) is that owner's. The overlay routes it to none of its controls, so a press on a world's own button presses no button, stick or look area of the overlay's lying beneath it. * the rest falls to the stick and look zones below. Coordinate space: touch contacts (`Zin.touch.slots()`: `t.x`/`t.y`/ `t.dx`/`t.dy`) carry PHYSICAL pixels of the scene viewport the overlay draws over, measured from its top-left. Every widget geometry below (button/stick positions, the canvas root's `style.width/height`) lives in `ui.screenSize()`'s LOGICAL space (the space `ui.registerScreen` / `getLayoutInfo` use), and `ui.pixelRatio()` is the factor between the two: the picture the overlay draws over spans `ui.screenSize() * ui.pixelRatio()` window pixels whatever the render scale rasterizes the scene at (`getViewportSize()` reports that raster, which a render scale below 1 makes smaller than the picture). `logicalScale` computes the logical-per-physical ratio once per tick, and every touch coordinate this module reads is scaled by it before use. The regions the drawn controls claim (`input.setTouchClaims`) are stated on the window, where the input layer meets a contact as it arrives, so they are carried across the viewport's origin (`viewportOrigin`), which an editor's Scene panel places away from the window's corner. Safe area: every control keeps inside the part of the overlay no system bar, display cutout or on-screen keyboard covers. `ui.safeArea()` states that part of the picture the overlay's screen lays out in (the scene viewport's, at `ui.screenSize()`); `safeInsets` takes it into the overlay's own space, where it leaves a safe rect `L`/`T` in from the left and top edges, `SW` x `SH` in size. Zones, the button column and the stick all lie inside it, and the canvas is that rect: the screen lays out inside the same safe area, so its root starts at `L`/`T`. The space the controls leave a game screen: the bounding square of every drawn button, the fan and the open sheet's entries is stated to the UI (`ui.setControlRegions`, owner `"zin_touch_controls"`) in the points of `ui.screenSize()`, restated whenever it changes and withdrawn while the overlay is off screen. A game screen reads it as `ui.safeArea().controls`, and its anchors keep clear of it. Zone geometry (fractions of the safe rect, `SW`/`SH`): * stick - activation region `x < L + 0.4*SW and y > T + 0.4*SH` (left 40%, bottom 60%). A floating stick: the base spawns at the touch's start point; the thumb clamps to a 96px radius; the vector fed to `Zin.virtual.setStick` is `offset / 96` with `y` screen-down positive (matching `setStick`'s documented convention). * buttons — one circle per touchButton binding among the LIVE bindings (`Zin.scheme.bindings()` — what awake components asked for, so every button corresponds to a control some world actually consumes), plus the compatibility registry's touch classes (`Zin.map.effective()`) — every one of them while that map is a scheme a world took up or the live scheme declares no touch control, and the attached ones alone otherwise, budgeted into the right-edge band between 45% of the safe rect's height and its bottom edge less the inset. Buttons sort by `(priority, id)` — a touchButton's `priority` option (authored default 50; synthesized buttons default 100) — with same-`group` buttons kept adjacent, then fill up to two columns growing inward from the bottom-right corner, one row per button pair. Each button's circle is the radius ITS OWN `size` option names (`small` 40px, `medium` 56px, `large` 72px), so a scheme states a hierarchy between its controls and the overlay draws it; the largest of those radii is the slot pitch the whole column packs on, which is what the count of live buttons decides. A circle reads its control's label, or the `icon` glyph the binding named in its place. More than 4 authored buttons walk every button one step down its own size (`large` -> `medium` -> `small`) so a rich scheme keeps more of itself on screen, and `layout()` reports the step each radius came from as `appliedSize`. Buttons beyond the two-column budget don't render individually — the last slot becomes a `...` fan button; tapping it opens a rows-of-3 grid sheet holding the overflow (same tap/hold behavior as a regular button), and tapping the fan again, or any layout-invalidating context/map change, closes it. * corner buttons - a touchButton whose `place` is `"corner"` sits in the top-right corner of the safe area instead, in a row growing leftward along the top edge in `(priority, id)` order, each at its own size. A row ends at the look area's left edge (`L + 0.4*SW`), so the top-left quadrant stays free, and the next button starts a row below it. It works the app around the game (the app menu's pause action), so it keeps one place whatever the column holds and stays out of the bottom-right, where a game puts its actions and draws controls of its own. Corner buttons count toward neither the column's budget nor its step-down, and the column's band starts below their row. Only bindings whose `context` matches the current input context (`Zin.context.current()`) contribute controls; the layout rebuilds when the live set, the context, the screen size or the safe area changes. * drag - everything else at `x >= L + 0.4*SW` (a touch here accumulates into `Zin.virtual.addDrag` every tick via the contact's per-frame delta). * the remaining top-left quadrant (`x < L + 0.4*SW and y <= T + 0.4*SH`) is unclaimed - free for other UI. A contact is assigned to a region on its `began` phase only (via a contact-id -> assignment map) and released on `ended` / `cancelled` / vanishing from `Zin.touch.slots()`. A tap that began and lifted inside one frame is first met already `ended`; on a button it holds the button for that frame and lets go on the next. Button circle hit-tests (visible buttons, the fan, the open sheet's entries) take precedence over the stick/drag zone checks — a button is a precise target and wins wherever it lands, including inside a zone (the open sheet can reach the stick zone on a narrow screen). A contact claimed by the stick or a button never also feeds the drag zone (a contact is assigned to exactly one region), so its projected-mouse / `touchDrag` state never competes with a look/aim consumer reading `Zin.virtual.drag` — no extra suppression is needed beyond the region assignment itself. A pinch and the drag region share the same space, so the two are arbitrated once per tick. The contacts the stick and the buttons hold are published to `Zin.gestures`, which forms its two-finger pair out of what is left; while the active map declares a `touchPinch` control and that pair is down, the drag region reports nothing. A pinch made over the look surface therefore reaches the pinch control alone, a thumb resting on the movement stick is no part of a pinch so the other thumb keeps looking, and lifting one finger from a pinch drags again. Rendering: one screen (`"zin_touch_controls"`, layer 200) whose root is a single transparent `canvas`, taking no pointer, sized to the safe rect, its commands drawn from the rect's corner. Commands rebuild only when the draw state actually changed (a dirty flag) — buttons are always drawn while mounted; the stick draws only while a stick contact is live. Appearance: every colour, face, margin and weight the overlay draws with is a value `M.setAppearance` states and `M.appearance()` reports, so a world puts the controls the engine draws in the faces and colours of the interface it typesets itself. A single button states any of the button values for itself on its `Zin.bindings.touchButton` binding, and `M.layout()` reports what each one resolved to. Auto-mount: every `_advance()` checks `Zin.surface.current()` — `"touch"` registers (lazily, once) and shows the screen; anything else hides it. `M._forceMount(true)` bypasses the surface gate for headless testing. Touch routing itself is unconditional — it runs every tick regardless of mount state, so a forced/real touch always drives `Zin.virtual` even before the overlay is visible. Consumers: local Zin = require("modules.zinput") local map = myInputMapRef:activate() -- Add a control while the world runs: it becomes an asset, goes -- live, and is subscribed to, which is what draws its button. local h = Zin.touchControls.addControl({ name = "cast", label = "Cast", kbm = Zin.bindings.key("KeyF"), gamepad = Zin.bindings.padButton("north"), onPressed = function() castSpell() end, }) Zin.touchControls.removeControl(h) -- The same, against a map applied through `Zin.map.activate`. local b = Zin.touchControls.button({ emit = "KeyF", label = "Cast" }) Zin.touchControls.removeButton(b)

copyTable(t: { [string]: any }) → void

Internal: a shallow copy, so a caller holding a returned appearance cannot reach the live one.

argtypedescription
t{ [string]: any }

sortEntries(raw: { ButtonLayoutEntry }) → void

Internal: buttons sharing a `group` stay adjacent in draw order. Each group (an ungrouped button forms its own singleton group) is positioned by its lowest-`(priority, id)` member; members inside a group sort the same way among themselves.

argtypedescription
raw{ ButtonLayoutEntry }

byPriorityThenId(a: ButtonLayoutEntry, b: ButtonLayoutEntry) → boolean

argtypedescription
aButtonLayoutEntry
bButtonLayoutEntry

slotPosition(s: number, rows: number, r: number, screenW: number, screenH: number) → void

Internal: the column-major slot position for 1-based slot `s` of `rows` rows per column, radius `r`, columns growing inward from the bottom-right corner of the budget band.

argtypedescription
snumber
rowsnumber
rnumber
screenWnumber
screenHnumber

resolveButtonStyle(binding: any) → void

Internal: the appearance one button draws with - every value it stated for itself, over the overlay's own for the rest.

argtypedescription
bindingany

placeOf(binding: any) → string

Internal: the place a touchButton binding states, `"column"` when it states none.

argtypedescription
bindingany

layoutCorner(sorted: { ButtonLayoutEntry }, screenW: number) → void

Internal: lay the `"corner"` buttons of `sorted` out in rows along the top edge of the safe area, from its top-right corner leftward, each at its own size. A row ends at the look area's left edge, and a button that would cross it starts the next row below. Returns them positioned, and the y of the lowest row's bottom edge (the safe rect's top when there are none).

argtypedescription
sorted{ ButtonLayoutEntry }
screenWnumber

layoutButtons(all: { ButtonLayoutEntry }, screenW: number, screenH: number) → void

Internal: lay `sorted` touch buttons out in the right-edge budget band — up to two columns growing inward from the bottom-right, capped by how many rows fit between `BUDGET_Y_FRAC` and the bottom inset. Every entry takes the radius its own `size` names; the largest of them is the slot pitch and the row budget, so the set's shape decides where a button sits and its own declaration decides how big it is. More than 4 authored buttons walk each entry one step down its own size (widening the budget). Anything past the two-column budget becomes a `...` fan (the last slot) whose overflow lays out as a rows-of-3 grid sheet stacked directly above that slot. Returns the visible entries (radius/cx/cy filled in) and the fan layout (nil when everything fit).

argtypedescription
all{ ButtonLayoutEntry }
screenWnumber
screenHnumber

ensureLayout(eff: any, screenW: number, screenH: number) → void

Internal: recompute `_layout` from the active effective map, the current input context, and the current screen size. Cheap no-op when none of them changed since the last call. Only actions/axes whose `context` matches the current input context contribute controls — the same activity rule `Zin.actions` applies, so a vehicle-context Brake button neither renders nor claims touches while the default context is on top. Closes the fan sheet: it only stays open across ticks where the layout itself didn't change.

argtypedescription
effany
screenWnumber
screenHnumber

floorsOwn(slot: any) → boolean

argtypedescription
slotany

safeInsets(screenW: number, screenH: number) → void

Internal: how far in from each edge of the overlay the safe area reaches, in the overlay's space (`screenW` x `screenH`). `ui.safeArea()` states it in the space `ui.screenSize()` reports, the picture the overlay's screen lays out in (the scene viewport's: the window, or a Scene panel's picture, which lies inside the window's safe area and has none), so it scales from that size onto the overlay's. The two sizes differ only while a test states a size of its own.

argtypedescription
screenWnumber
screenHnumber

screenSize( ) → void

Internal: the logical screen size the overlay lays out in — the test override while one is set, else `ui.screenSize()`. Zero on either axis means no screen has resolved yet.

refreshLayout( ) → boolean

Internal: bring `_layout` up to date with the live set, the active map, the input context and the screen size, and report whether a screen has resolved. Every path that reads the overlay goes through this first, so what a caller sees answers for the same instant `Zin.scheme.bindings()` does rather than for whichever tick last happened to advance it. Cheap when none of those inputs moved.

pictureSize( ) → void

Internal: the window-pixel extent of the picture the overlay draws over: the UI's logical screen at `ui.pixelRatio()` physical pixels per point. Zero on either axis while no screen has resolved.

logicalScale(screenW: number, screenH: number) → void

Internal: the physical-pixel -> logical-point scale factor for this tick (the overlay's layout size over the picture's window-pixel size), applied once to every touch coordinate `advanceRouting` reads. Falls back to `1, 1` (identity) when the picture has no size yet, so a pre-render context degrades to using touch coordinates unscaled rather than dividing by zero.

argtypedescription
screenWnumber
screenHnumber

viewportOrigin( ) → void

Internal: where the scene viewport the overlay draws over sits in the window, in the window pixels the input layer meets a contact in. The window's corner while no camera has reported a viewport yet.

regionForPoint(x: number, y: number, screenW: number, screenH: number) → void

Internal: classify a point into a region. Returns "stick" | "button" | "fan" | "drag" | nil, and the matched button entry when the kind is "button". Explicit circle hit-tests (visible buttons, the fan, the open sheet's entries, the sheet ahead of what it covers) run FIRST; the stick/drag ZONE checks are the fallback for unclaimed space — a button is a precise target the player aimed at, so it wins wherever it lands, even inside a zone (the open fan sheet grows leftward and can reach the stick zone on a narrow screen). A visible button and the fan itself always hit-test; the sheet's entries only hit-test while it's open.

argtypedescription
xnumber
ynumber
screenWnumber
screenHnumber

stickClaimed( ) → boolean

Internal: whether a contact currently owns the stick.

handleBegan(id: number, lx: number, ly: number) → void

Internal: assign a newly-began contact (already in logical coordinates) to whichever region contains its start point (no-op — leaves the contact unassigned — outside every region). A fan tap is a one-shot toggle (open/close the overflow sheet), not a claimed region: it needs no continuous per-frame tracking, so nothing is recorded in `_assignments` for it.

argtypedescription
idnumber
lxnumber
lynumber

releaseAssignment(a: Assignment) → void

Internal: release a contact's assignment (ended / cancelled / vanished).

argtypedescription
aAssignment

frameNow( ) → number

Internal: the engine frame this tick runs in, or -1 where no engine frame counter is reachable.

advanceRouting( ) → void

Internal: one tick of touch routing — began-phase assignment, per-tick stick/drag updates, and release on ended/cancelled/vanish. A contact that began and lifted inside one frame reaches the routing already ended, so one met for the first time in phase "ended" begins where it landed: on a button it holds the button for the frame it was met in and releases it on the next, so a tap shorter than a frame presses the button, and on the fan it toggles the sheet. It moves no stick and drags no look zone. Independent of mount/render state: a contact on a session whose surface is not touch is routed all the same.

faceOf(family: any) → string

Internal: a family name the canvas selects a face with. An empty name is the renderer's own proportional face.

argtypedescription
familyany

pushButtonCommands(cmds: { any }, entry: ButtonLayoutEntry) → void

Internal: append a button circle and its face at the entry's computed position and radius — shared by the visible column and the fan's overflow sheet. The face is the entry's icon glyph where it declared one, else its label, each set in the family and at the share of the radius the entry's own appearance names, and set smaller where it would span wider than the circle: a label in a longer language stays inside its button.

argtypedescription
cmds{ any }
entryButtonLayoutEntry

buildCommands( ) → void

Internal: paint commands for the current draw state.

buildTree( ) → any

Internal: the screen's root widget tree. The canvas paints and takes no pointer: a press anywhere on it is decided by the widgets beneath, and the controls it draws take their own contacts through the regions `publishClaims` states.

shift(point: any) → any

argtypedescription
pointany

claimRegions( ) → void

Internal: the regions the drawn controls hold, in the window pixels the input layer meets a contact in: every visible button, the fan, and the open sheet's entries. A contact beginning in one is the control's alone and presses no widget beneath it.

add(cx: number, cy: number, radius: number) → void

argtypedescription
cxnumber
cynumber
radiusnumber

zoneRegions( ) → void

Internal: the zones the stick and the look area take contacts in, in the window pixels the input layer meets a contact in: the stick's when the layout has a stick, the look area's when it has a drag. A contact beginning in one is offered to the UI first, so a widget beneath it takes its press, and the zone's once the UI leaves it.

add(lx: number, ly: number, lw: number, lh: number) → void

argtypedescription
lxnumber
lynumber
lwnumber
lhnumber

publishClaims( ) → void

Internal: state the drawn controls' regions and the zones to the input layer when they changed since the last statement.

controlRects( ) → void

Internal: the rects the drawn controls cover, in the logical points of `ui.screenSize()`, the canvas a game's screens lay out on: the bounding square of every visible button, the fan and the open sheet's entries: the drawn controls alone, since a widget laid out over the stick or look zone takes the presses that land on it. Empty while the overlay is off screen.

add(cx: number, cy: number, radius: number) → void

argtypedescription
cxnumber
cynumber
radiusnumber

publishControls( ) → void

Internal: state the rects the drawn controls cover to the UI when they changed since the last statement, so a screen's anchors keep clear of them and `ui.safeArea().controls` lists them.

ensureMounted( ) → void

Internal: register (lazily) or show the overlay screen. No-ops (and retries next tick) until `advanceRouting` has resolved a real `ui.screenSize()` at least once, so the very first registration never paints a canvas sized off the `-1, -1` initial placeholder.

ensureUnmounted( ) → void

Internal: hide the overlay screen (registration is kept for reuse).

_advance( ) → void

Internal: advance the touch-controls overlay one tick — route this tick's raw touches into `Zin.virtual` and recompute layout first, then auto-mount by `Zin.surface.current()` and repaint the overlay if its draw state changed. Wired into `Zin.tick`, before `Zin.emulation._advance()` (the floor consumes the `Zin.virtual` state this routing produces).

examples

Zin.touchControls._advance()

claimed( ) →

The contact ids currently claimed by the stick, a button, or the drag zone.

examples

local ids = Zin.touchControls.claimed()

primaryClaimed( ) → boolean

Whether the touch contact driving the pointer (the one whose `Zin.touch` record reads `pointer = true`) is currently claimed by an on-screen control. The engine projects the contact driving the pointer onto the mouse so pointer UI works from a finger. A contact that begins on a drawn button, the fan or an open sheet entry is that control's alone and is not projected; one that begins on the movement stick or the look area is, until the UI has decided its press, and so for those frames it also reads as a held left mouse button, which fires every control bound to one. Once the UI leaves its press the contact lets the pointer go, and a finger landing on bare scene meanwhile drives it as a press of the player's own. A mouse binding means the player pressed a mouse button, and a finger an on-screen control has claimed is not that. `Zin.bindings` consults this so a thumb on the stick does not fire an unrelated control.

examples

if not Zin.touchControls.primaryClaimed() then ... end

publicEntry(entry: ButtonLayoutEntry) → any

Internal: a layout entry's public snapshot shape (shared by `M.layout()`'s visible `buttons` and its `fan.buttons`).

argtypedescription
entryButtonLayoutEntry

layout( ) → any

The overlay's current control layout — a copy, safe to hold and mutate. `buttons` is the budgeted, VISIBLE stack in draw order, the corner row after the column (each entry `{ id, label, icon, actionName, priority, size, appliedSize, group, place, style, cx, cy, radius }` in `ui.screenSize()` space - `id` is the button's identity in `Zin.virtual` and the name `Zin.test.tapTouchButton` takes, `actionName` the control it works, `label` the words on it in the player's language, `size` is the step the binding declared and `appliedSize` the one `radius` came from, which differ only where a rich scheme's step-down moved a button one size down; `place` is `"column"` for the action column at the bottom-right or `"corner"` for the row in the top-right corner, the place a world's own drawn controls keep clear of; `icon` is the glyph the circle draws in place of its label, and `style` the appearance it resolved to out of its own keys and `M.appearance()`); `fan` is nil unless the button set exceeded the two-column budget, in which case it's `{ open, cx, cy, radius, buttons }` — `open` is whether the overflow sheet is currently expanded, `buttons` the overflowed entries at their sheet positions (tappable only while `open`). `stick` / `drag` name the axis + virtual zone each region feeds, and `pinch` the axis the two-finger recognizer feeds, each nil when the active map defines none in the current context. `safe` is the rect every control keeps inside: the part of the overlay no system bar, display cutout or on-screen keyboard covers (`ui.safeArea()`), in the same space. The reading answers for the same instant `Zin.scheme.bindings()` does: activating or standing down a map, subscribing a control, changing context or resizing the screen is reflected by the next read, in the call that made the change. Empty until a screen size has resolved. Backs custom control-placement UI and headless tests that need a button's (or the fan's) center to aim a simulated touch at.

examples

local jumpBtn = Zin.touchControls.layout().buttons[1]

setAppearance(opts: { [string]: any }?) → void

State how the overlay is drawn. Every value a world passes replaces the engine's for as long as the world runs, so a game that typesets its own interface puts the controls the engine draws in the same faces, colours and margins as the rest of it. The keys, and what each decides: - `inset` / `gap` - the margin the button column keeps from the right and bottom edges of the safe area (`ui.safeArea()`: the screen less its system bars and display cutouts), and the space between two buttons. A game laying its interface out inside a margin of its own states that margin here and the controls keep it too. - `fill` / `stroke` / `strokeWidth` - every button's circle. - `textColor` / `fontFamily` / `fontScale` - the label on it. `fontFamily` takes the list `style.fontFamily` takes and `ui.listFonts()` names; `fontScale` is the share of the button's radius the label is set at. - `iconFont` / `iconScale` - the same two for a button that declared an `icon` glyph. - `sheetFill` / `sheetRounding` - the overflow sheet behind the fan. - `fanFill` / `fanStroke` - the fan's own circle. - `stickStroke` / `stickFill` / `stickWidth` - the movement stick's ring and thumb. A call states only the keys it carries and leaves the rest as they stand, so appearance composes across several calls. Passing nothing puts every value back to the engine's own. A single button states any of the button keys for itself through `Zin.bindings.touchButton`, which wins over what is set here.

argtypedescription
opts{ [string]: any }?A table of appearance keys, or nil to restore the defaults.

examples

Zin.touchControls.setAppearance({ fill = "#10243a", stroke = "#c9a227", textColor = "#f2e6c8", fontFamily = "Inter", inset = 38 })
Zin.touchControls.setAppearance()

appearance( ) →

How the overlay is currently drawn - every appearance key with the value in force, as a copy safe to hold and mutate. The keys are the ones `M.setAppearance` accepts, and each button's own resolved appearance is reported beside it on `M.layout()`.

examples

local inset = Zin.touchControls.appearance().inset

_setViewportOverride(w: number?, h: number?) → void

Test-only: override the logical screen size (`ui.screenSize()` space) the layout budget/fan math uses, without resizing the real window — for headless tests that need to prove budget math at a phone-sized viewport. Pass nil for both to clear the override and fall back to the real `ui.screenSize()`.

argtypedescription
wnumber?Override width, or nil to clear.
hnumber?Override height, or nil to clear.

examples

Zin.touchControls._setViewportOverride(400, 800)

_forceMount(on: boolean) → void

Test-only: force the overlay to mount regardless of `Zin.surface.current()` — for headless tests that want to exercise rendering without a real touch surface. Touch routing itself is always active regardless of this flag.

argtypedescription
onbooleanWhether to force-mount.

examples

Zin.touchControls._forceMount(true)

button(opts: ButtonOpts) → number

Add an overlay button. Two flavors: - `{ action = "jump" }` attaches an extra touchButton binding to an existing action on the active map — a second on-screen instance of a control the map already defines. - `{ emit = "KeyF", label = "Cast" }` registers an overlay-only button: a synthetic `emit:KeyF` action carrying both the kbm key binding and the touchButton, so the emulation floor drives `KeyF` straight from this button through the same binding/emulation path every other control uses. `label`/`zone`/`icon` set the button's presentation, `place` where it sits (`"column"`, the default, or `"corner"`; see `Zin.bindings.touchButton`), and the appearance keys `Zin.bindings.touchButton` takes (`fill`, `stroke`, `strokeWidth`, `textColor`, `fontFamily`, `fontScale`, `iconFont`, `iconScale`) state this one button's look over the overlay's own; when neither label nor zone is given the button falls back to the action name (or the emit key). `label` takes text or an `i18n.text` value; `id` names the button in `Zin.virtual`, and a button whose label is read from a catalog and that states no id takes the action name (or the emit key) as its id. strokeWidth?, textColor?, fontFamily?, fontScale?, iconFont?, iconScale? }` - exactly one of `action`/`emit` is required.

argtypedescription
optsButtonOpts`{ action?, emit?, id?, label?, icon?, zone?, place?, fill?, stroke?,

examples

local h = Zin.touchControls.button({ action = "jump" })
local h = Zin.touchControls.button({ emit = "KeyF", label = "Cast" })

removeButton(handle: number) → boolean

Remove a button previously added via `M.button`.

argtypedescription
handlenumberThe handle returned by `M.button`.

examples

Zin.touchControls.removeButton(h)

controlClass(opts: any, class: string, kind: string) → void

Internal: the class value a caller gave, checked against the model's one hard rule — every control carries all three classes, and a class it refuses says why in the record.

argtypedescription
optsany
classstring
kindstring

addControl(opts: ControlOpts) → number

Add a control while the world is running, and put its button on screen. The control becomes an asset — a one-control `.inputMap` under `/source/runtimeControls/` — which is then activated and subscribed to, which is what makes the overlay draw for it. It carries all three device classes like any other control: give each of `kbm` / `gamepad` a binding, or `false` plus `reasons.<class>` saying why it refuses that device. `touch` defaults to an on-screen button for a `button` control. At least one handler is required. A control nothing listens to draws no button, so an `addControl` with no handler would put nothing on screen at all. The control follows the context that added it: one a component adds is removed when that component instance goes (removed, hot-reloaded, or its entity despawned), one a module body adds at the module's next run. button?, onInput?, onPressed?, onReleased?, onChanged? }`.

argtypedescription
optsControlOpts`{ name, label?, kind?, kbm, gamepad, touch?, reasons?,

examples

local h = Zin.touchControls.addControl({ name = "cast", label = "Cast", kbm = Zin.bindings.key("KeyF"), gamepad = Zin.bindings.padButton("north"), onPressed = function() print("cast") end })

removeControl(handle: number) → boolean

Release a control added by `M.addControl` — drop its subscriptions and release its map, which takes it off the screen and out of the live set. The asset it was written to stays, so the same name can be added again and comes back with the same guid.

argtypedescription
handlenumberThe handle returned by `M.addControl`.

examples

Zin.touchControls.removeControl(h)

controls( ) →

Every control `M.addControl` currently holds, as `{ handle, name, path }` in the order they were added.

examples

for _, c in ipairs(Zin.touchControls.controls()) do print(c.name) end

_reset( ) → void

Test-only: unmount (withdrawing the rects the controls covered from `ui.safeArea().controls`), clear all routing/layout state, drop bespoke buttons, release every runtime control, close the fan, clear the viewport override, and reset the force-mount flag. Registration (`ui.registerScreen`) itself is not undone.

examples

Zin.touchControls._reset()

_onScreen( ) → boolean

Internal: whether the overlay is on screen. An overlay on screen is laid out and drawn from state no device event moves (the screen's size, the language shown, the controls code subscribes to), so the input layer is read as having work while it is (`Zin.atRest`).

examples

if Zin.touchControls._onScreen() then ... end

_settled( ) → boolean

Internal: whether the overlay could change nothing on its next advance -- no live touch assignment, no open fan, mount state matching the surface, and (while mounted) no pending redraw, the layout's inputs unchanged and the faces read in the language now shown. The tick's quiescence gate reads it. A redraw pending on an unmounted overlay is paid when it mounts, so it holds nothing awake until then.

examples

if Zin.touchControls._settled() then ... end
⌬ Types
ButtonOpts = {ControlOpts = {

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.

76+items
·
assettype · born here
❒asset
# Module (asset type) A module is a reusable, stateless (or globally-stateful) Luau library that other code pulls in with `require()`. Modules are the unit of factored-out logic in a world: helpers, math libraries, format parsers, registries, shared algorithms. ## When to use one - You have logic you want to share across multiple components, services, scenes, or tools. - You have a registry, lookup table, or shared cache that callers all read from / write to. - You want a stable API surface (`M.fn`) other code can depend on. If the logic is bound to one entity, use a `.component`. If you want a named UI of fields rather than functions, use a `.preset`. ## Where it lives - Source: `/zero/source/.../<name>.module/` - Identity: the source path with `/` written as `.` and each segment's type suffix dropped — `/zero/source/demo/beats.module` is `demo.beats`, and `/zero/source/kit.package/beats.module` is `kit.beats`, the container's name kept and its `.package` suffix gone. `asset.create` returns this string, `asset.resolve(...).identity` reads it back, and the `require` forms below write it as `<identity>`. - Folder shape: - `init.luau` (or `init.lua`) — module body. **Required.** Returns a table (conventionally named `M`). - `README.md` — instance-level documentation. **Required.** - `.metadata` — agent-editable tags + free-form fields. **Required.** ## How to create one ```luau asset.create("module", "<name>") -- Creates: /zero/source/<name>.module/ -- init.luau (canonical `local M = {} … return M`) -- README.md (instance README template) -- `folder` places it in a subfolder of /source, and that subfolder -- leads the identity: `{ folder = "lib" }` produces `lib.<name>`. -- `into` authors it inside a resolved container (a package, a toolbox), -- whose own identity leads the same way: asset.create("module", "<name>", { folder = "lib" }) asset.create("module", "<name>", { into = asset.resolve("myPkg.package") }) ``` ## How it operates 1. **Registration.** Writing `init.luau` into a `.module/` folder indexes the asset and registers the module path with the resolver. 2. **Loading.** The first `require("<identity>")` runs the file's body and caches the returned table. Subsequent requires from anywhere return the **same table** — this is the shared-state lever for "module-local" registries. The body runs in an environment of the module's own: a name it declares without `local` is readable by the module's own functions and by no other script, so an export reaches its callers through the returned table and nothing else. Requiring a component's folder runs its chunk the same way, once, and its `update`, `start` and `public` stay in that environment; a component runs on an entity through `entity(id).component.add(name)`. 3. **Hot reload.** Editing the file re-runs the module body and folds what it returns into the table already loaded, so that table keeps its identity: a caller that captured it with `require` reads the new source's functions and values through the reference it already holds, and a later `require` returns that same table. A key the new source drops goes away; a key something set at runtime stays. The body's own `local`s start again from their initial values, so state that must outlive an edit lives in `modules.state()` (`guides { path: "core/scripting-and-tasks" }`). 4. **Identity resolution.** A module is reached by its `<identity>`, and where the caller lives decides which spelling of it resolves. For a module in a **world**, from a caller in that same world — another module, a component, a scene entrypoint, or an `execute` chunk: - `require("<identity>")` — the identity on its own, resolved against the caller's own root. It carries every folder segment, so a module created with `{ folder = "demo" }` is `require("demo.beats")`. - `require("@root::<identity>")` — the same root-relative resolution, written out. - `require(".sibling")` — a module in the same folder, by its bare name; `..name` steps up one folder, `...name` two. Logs, stack traces and hot-reload notices name that same module `@local.source.<identity>` — its key under the world source root. The `<identity>` tail of that key is the form above, so a trace reading `@local.source.demo.beats` is `require("demo.beats")`. For a module in a **library** — content under `/zero/source/libs/@<lib>/` — `@<lib>::` addresses that library's root from anywhere: `require("@builtin::modules.transform")`. Mounting a world as a library moves its files under such a root and flips the caller root to `@<lib>::`, which is what keeps the root-relative forms above resolving across the move. ## Discovery - `asset.list("module")` — every registered module. - `asset.inspect("<name>")` — public functions, source path, this type README. - `ls /zero/source/<name>.module` lists the files the folder holds. ## Authoring conventions - Return a single `M` table from `init.luau`. Top-level statements with side effects run on first require — useful for one-time initialization, dangerous if they touch the engine before it's ready. - Write exported functions as `typed function`, not `function`: the argument types are enforced at the call and the checker knows the signature, so a caller's mistake is reported where they made it. - Annotate exported functions with `--!desc` / `--!arg` / `--!return` / `--!example` so the LSP, `tools.list`, and `asset.inspect` surface them. A function with no `--!desc` is reachable only by someone already reading this file. - Declare a VALUE with `Field.<kind>(default, mode, description)`, and a table whose members are reached through a metatable with `--!members <TypeName>` — the latter gives the surface its accepted member set, its type, and its documentation from one table. See `guides { path: "core/authoring" }` for all four rules and `modules/api/engine/entity.module/members.module` for a worked member table. - Keep module state in module-local upvalues or in `modules.state()`. A name the body declares without `local` lives in the module's environment, which every run of the module shares: a function the previous run left in place reads what the reload assigned. Module-locals start again from their initial values with each hot reload; the table `modules.state()` returns is the same table on both sides of every reload. - Prefer focused modules over kitchen-sink modules. If two halves of a module have no shared state, split them. ## Common pitfalls - **Cyclic requires.** A `require` chain that loops will return the partial table (the half built before the cycle was detected). Design for one-way dependencies. - **Engine-time side effects.** Don't `entity.spawn` at module top-level — the engine may not be ready. Expose an `M.init` and call it from a scene entrypoint. - **Hot-reload + module-local cache.** A module that caches expensive computation in upvalues loses that cache on reload — fine for dev, but be aware in performance work. - **`init.lua` vs `init.luau`.** Either works, `.luau` is canonical. - **Writing one while play runs.** A `/source` write made while play is running lands on the play shadow, and a guarded play-exit discards it unless it is kept. One `.module` write shadows `init.luau`, the `README.md` and the `.metadata` together. `vfs.write(path, bytes, { durable = true })` skips the shadow, and `vfs.promotePlayShadow` keeps what is already on it — the `core/vfs` guide has the model and what each route costs. ## Related types - `.component` — for entity-bound state + lifecycle hooks. - `.service` — generates content you don't have yet (a mesh, sound, texture, …) via a metered provider. - `.tool` — for a single agent-callable function with a YAML schema. - `.package` — to group several modules + components + scenes into one shippable folder. ## In the Inspector Exports: what the module exports (name, kind, signature), parsed from its source without running it, with **Check** (the LSP's diagnostics for its entry file) and **Open**.
▲ 0↑ born
▣
module · born here
❒asset
# canvas Immediate-mode 2D-paint widget. The body is a sequence of paint commands (`line`, `bezier`, `polyline`, `rect`, `circle`, `text`) drawn in widget-local coordinates with origin at the top-left and +y going down (egui-standard, opposite of plot). Wires through pointer, drag, double-click, key, and scroll handlers, and forwards `role` / `tag` / `aria*` props for accessibility. ## Exports - `canvas(id: string?, opts: CanvasOpts?) -> WidgetNode` — build a canvas widget node from a list of paint commands plus optional interaction handlers. Types: - `CanvasOpts = { commands?, width?, height?, onClick?, onPointerDown?, onPointerUp?, onPointerMove?, onDrag?, onDoubleClick?, onKey?, onScroll?, role?, tag?, style?, class?, classes? }` ## Usage ```luau local canvas = require("@builtin::modules.zui.widget.canvas") canvas("my-canvas", { commands = { { kind = "line", a = {10,10}, b = {200,150}, color = "#7AA8FF", width = 2 }, { kind = "circle", center = {100,100}, radius = 30, fill = "#FF8855" }, { kind = "text", pos = {10,180}, text = "hello", color = "#fff", fontSize = 14 }, }, onClick = "canvas:click", style = { width = 600, height = 400, background = "#161B22" }, }) ``` ## Notes - Pointer events surface widget-local cursor coords as either a `"x,y"` string (legacy) or a structured Luau table (modern handlers). - `onClick` / `onPointerDown` / `onPointerUp` carry `data.button` (0 = left, 1 = right, 2 = middle) identifying which mouse button triggered the event. - `onKey` fires only while the canvas has keyboard focus; `onScroll` fires while it is hovered. - Any `opts.aria*` key passes through verbatim — no wrapper-side allowlist needed. - Command kinds and per-kind fields are defined in `crates/zero_ui_protocol/src/canvas.rs`.
▲ 0↑ born
▣
module · born here
❒asset
# scheme The live set of activated input maps, and the per-frame dispatch that turns their bindings into the events a controller subscribed to. Backs `Zin.scheme`. ## Nothing is live until something activates a map A controller holds an `inputMap` ref, activates it when it takes control, and releases it when it gives control up. The live binding set is exactly the union of what current holders asked for, so an empty world has an empty input surface and an empty screen — no scheme is active by default, and nothing appears on a phone that no component consumes. For a component that drives the thing it lives on, taking control and being awake are the same moment, so `awake` / `onDestroy` are the hooks. For anything a player enters and leaves — a car, a turret, a menu — they are not: the car is still there after the player gets out, so the map goes live on entry and stands down on exit. ```luau public = { inputMap = Field.assetRef("inputMap", "@builtin::inputMaps.default", NoSync, "The controls this component reads."), speed = Field.number(5, NoSync, "World units per second at full deflection."), jumps = Field.number(0, NoSync, "How many times the jump control was pressed."), } local controls function awake() controls = public.inputMap:activate() controls.move:onInput(function(v, dt, active) if not active then return end local p = public.entity.position local step = public.speed * dt public.entity.position = { p.x + v.x * step, p.y, p.z - v.y * step } end) controls.jump:onPressed(function() public.jumps += 1 end) end function onDestroy() public.inputMap:deactivate(controls) end ``` What `activate` returned is this holder's **claim** on the map. Keep it and hand it back: releasing the claim disconnects the subscriptions made through it, and the map stays live for whoever else holds it. A claim also ends with the context that opened it. A component's claim is released when that component instance goes, whether or not it writes an `onDestroy`: the component is removed from its entity, the entity despawns, or the component hot-reloads (its new life's `awake` activates again). A claim a module body opens ends at the module's next run. `scopes.list()` names each standing claim as a `luau` row under the context it follows, and `scopes.release(tag)` ends it with everything else that context holds. ## Several maps compose by all being live The player's surface is the union of every live map, which is what a game needs: picking up a gun activates a weapon map and Fire appears beside the movement stick; dropping it takes away Fire and nothing else. Two controllers that each activate a map with a movement stick produce two sticks — visible, attributable to the second controller, and the importer's to resolve. Two components activating the *same* map read one set of controls, each through its own claim. A claim's release disconnects what that holder subscribed and leaves the other holders' handlers attached; the map leaves the live set when its last claim goes. `Zin.scheme.live()` reports each live map's `holders` — how many claims are still standing on it — and `heldBy`, which says who each of them is: `kind` (`"component"` or `"execute"`), `entity`, `source` as the `chunk:line` the activation was opened at, and the `label` the caller passed to `activate("weapon-swap")`. ## An activation reads the map's children as they stand now Every `activate` re-reads the map's `<name>.inputBinding/` children, so a control added, edited or removed since the map came up reaches the running set on the next activation. The controls are edited in place, so it reaches the holders already standing on the map too: their handles keep working and every subscription they made carries on across the edit. ## A map can stand another one down Composition cannot say "not while this is happening". A map declares the `group` its controls belong to and the groups it `suppresses` while live: ```luau -- driving.inputMap/init.luau return { group = "vehicle", suppresses = { "player" } } ``` Every live map in a suppressed group reads nothing and draws nothing for as long as the suppressor is live. It is **not** released: it keeps its holders, its handles and every subscription, and resumes untouched when the suppressor goes. So a car stands down walking without ever finding, owning or releasing the walk map — and a menu stands down the whole game with one declaration. A map that declares no `group` belongs to one named after itself, so it collides with nothing and can still be named by something that wants to stand it down. Declaring neither field composes with everything. The drop frame runs on the tick a map stands down, so a stick held at that moment reports its neutral value once and whatever it drove stops rather than sticking. ## Dispatch `_advance(dt)` evaluates every live binding once per tick, across every device class it carries — a tablet with a keyboard attached and a desktop with a pad plugged in both answer to whichever the player actually used, rather than to a nominated primary. | Event | Fires | Cadence | |---|---|---| | `input` | Once while the binding is active with `(value, dt, true)`, and once more on the frame it goes inactive with the neutral value and `false` | Per engine frame | | `pressed` / `released` | A button's edges | Per engine frame | | `changed` | When the value differs from the previous tick | Per tick | `input` firing on the drop frame is what lets one handler both start and stop the motion it drives, without a second subscription to notice the release. A frame carries more than one tick whenever a host calls `Zin.tick` beside the tick the engine already runs, or fast-forwards several ticks to converge smoothing. Evaluation follows the tick, so the smoothing lands and `changed` reports each step of it. `input`, `pressed` and `released` are stamped with the engine frame they were reported for, so the frame carries one of each however many ticks ran in it. Both edge sources hold this frame's edge for as long as the frame lasts: the input snapshot's `pressed` flag, and `Zin.virtual`'s previous-frame button table. That is what a second reporting pass reads as another press. `Zin.scheme.fired`'s `count` is the number of engine frames a control was active since it last cleared, so a button held across two frames reads 2 for one press. The `pressed` / `released` subscriptions are what count edges. A binding that declares a `context` is live only while that context is on top, the same activity rule actions apply. An `axis1` / `axis2` control's own `deadzone`, `curve`, `invert` and `smoothing` are applied here, in that order, to the reading its classes produced — after `as` / `unitsPerSecond` / `scale` have brought every class into the control's unit, so one deadzone written in that unit covers the stick, the mouse and the finger together. A deadzone is per value on an `axis1` and **radial** on an `axis2`. The shaping maths is `Zin.utils`', shared with the axis registry. `smoothing` is the one piece of the four that is stateful: the value is held per control across frames and approaches whatever the devices report next over the declared time constant. A control that leaves its context, whose group stands down, or whose gate closes has a neutral target, so it drains rather than cutting — and reports its drop frame when it arrives. ## Validation happens before anything registers Activation reads every child binding, collects every fault across all of them, and raises once with the lot. A map with three broken bindings names all three rather than one per attempt, and a map that fails validation registers nothing — a half-live map is worse to debug than one that refused to come up. ## Exports - `M.activate(mapRef, label?) -> { [name]: Handle }` — activate a map, return its handles. `label` names this activation in `M.live()`. - `M.deactivate(mapRef) -> boolean` — release a claim on a map. - `M.live() -> { { guid, name, group, suppresses, suppressedBy, holders, heldBy, bindings } }` — every live map in activation order. What tells an author why two sticks are on screen, or why the controls they activated answer to nothing, or who is holding the map standing them down. - `M.bindings() -> { { map, group, name, label, kind, context, suppressedBy, subscribers, record } }` — every live binding in activation order. The touch overlay builds from this, so what is on screen is exactly what some awake component asked for and nothing is standing down. - `M.suppressed() -> { [group]: mapName }` — which groups are standing down and what put each one down. - `M.has(name) -> boolean` — whether a named control is live anywhere. - `M._advance(dt)` — one tick of dispatch; wired into `Zin.tick`. - `M._childBindings(mapRef) -> { ref }` — the map's `.inputBinding` children, in name order. - `M._reset()` — test-only: drop every live map without firing anything. Types: - `Handle = { onInput, onPressed, onReleased, onChanged, label, kind }` — a thin view over the binding asset's own event facade, so a subscription made through a handle is the same one `ref.events.input:connect` would make and ends the same way.
▲ 0↑ born
▣
module · born here
❒asset
# context The input context stack. Pushing a named context ("ui", "menu", "vehicle", ...) stands down everything whose declared context doesn't match the top of the stack; popping restores the previous mode. The bottom is permanently `"default"` so unbalanced pops never leave the stack empty. A control, an action, an axis or an event subscriber can declare one context. `Zin.scheme` honours it on every live binding, so a vehicle-context Brake neither fires nor draws its touch button while the default context is on top. A map standing another map's `group` down is the coarser instrument beside this one: `group` / `suppresses` on an `.inputMap` decides which whole schemes answer, while a context decides which entries within a live scheme do. ## Exports - `M.default() -> string` — the always-on context name (`"default"`). - `M.push(name: string)` — push a context. No-op when `name` is not a non-empty string. - `M.pop() -> string?` — pop the top context; returns `nil` when only `default` remains. - `M.current() -> string` — name at the top of the stack. - `M.contains(name: string) -> boolean` — true if `name` is anywhere in the stack. - `M.stack() -> { string }` — a copy of the live stack, bottom→top. - `M.reset()` — pop everything except `default`. - `M.with<T...>(name: string, fn: () -> T...) -> T...` — run `fn` with `name` pushed, pop guaranteed. ## Usage ```luau local Zin = require("@builtin::modules.zinput") -- menuClose.inputBinding/init.luau declares `context = "ui"`, so it reads -- only while "ui" is on top. Zin.context.push("ui") Zin.context.current() -- "ui" Zin.context.pop() Zin.context.with("ui", function() -- inside this block the "ui" controls are the ones that read end) ``` ## Notes - The stack lives in the module's upvalues, so it persists across Luau script runs that share the require cache. A `restart_instance` resets it (matches the standard caching contract). - Pushing the same context twice requires two pops to fully remove — matches typical UI nesting (a sub-menu pushes "ui" again). - A declared context is compared strictly equal to `current()`; there's no inheritance up the stack.
▲ 0↑ born
▣
module · born here
❒asset
# gestures Touch-gesture recognizers over the touch event stream + contact snapshot; backs `Zin.gestures`. Discrete gestures (tap, double-tap, long-press, swipe) fire subscriptions; continuous gestures (pinch, pan) expose per-tick deltas computed from the two-finger contact state. Advanced by the `Zin.tick` pipeline — dormant until ticked. ## Discrete vs continuous - **Discrete** (tap / double-tap / long-press / swipe) — recognized on a release or hold-duration edge, delivered via `on*` subscriptions on the tick they fire. - **Continuous** (pinch / pan) — recomputed every tick from the two-finger contact positions; read via `pinchDelta()` / `panDelta()`, reset to zero at the start of each tick. The pair is formed from the contacts no on-screen widget is working, the ones `Zin.touchControls` says its stick and buttons hold having been left out, so a thumb on a movement stick is no part of a pinch. ## Config `Zin.gestures.configure` overrides recognition thresholds (unspecified fields keep their current values): | Field | Default | Meaning | |---|---|---| | `tapMaxDuration` | `0.25` s | press→release within this = tap candidate | | `tapMaxMovement` | `16` px | total movement below this = tap candidate | | `doubleTapWindow` | `0.3` s | two taps within this = double-tap | | `longPressDuration` | `0.5` s | held past this (still) = long-press | | `swipeMinDistance` | `60` px | release travel at/above this = swipe candidate | | `swipeMinVelocity` | `800` px/s | release velocity at/above this = swipe | ## Exports - `M.configure(opts: { [string]: number })` — override recognition thresholds. - `M.getConfig() -> GestureConfig` — current thresholds (a copy). - `M.onTap(fn) -> number` — subscribe to taps; `fn(ev)` with `ev = { x, y, id, duration }`. - `M.onDoubleTap(fn) -> number` — subscribe to double-taps; `ev = { x, y, id }`. - `M.onLongPress(fn) -> number` — subscribe to long-presses (fires once per contact); `ev = { x, y, id }`. - `M.onSwipe(fn) -> number` — subscribe to swipes (fires on release); `ev = { direction, dx, dy, velocity, id }`. - `M.off(handle: number) -> boolean` — unsubscribe a handle from any `on*` function. - `M.pinchDelta() -> number` — this tick's two-finger pinch delta in px (positive = spreading). - `M.panDelta() -> (number, number)` — this tick's two-finger pan delta `(dx, dy)` in px. - `M._beginTick()` — internal: clear per-tick continuous deltas; wired by `Zin.tick`. - `M._observeEvent(ev: any)` — internal: builds contact tracks and classifies discrete gestures on release; wired by `Zin.tick`. - `M._advanceTime(dt: number)` — internal: time-based recognition (long-press) + continuous deltas; wired by `Zin.tick`. - `M._setWidgetContacts(ids: { [number]: boolean })` — internal: the contacts an on-screen widget is working; published each tick by `Zin.touchControls`. - `M._pairDown() -> boolean` — internal: whether two contacts no widget is working are down, which is the pair a two-finger gesture reads. - `M._dispatchFires()` — internal: deliver this tick's discrete gesture fires; wired by `Zin.tick`. - `M._reset()` — test-only: clear all tracks, fires, deltas, and subscriptions. Types: - `GestureConfig = { tapMaxDuration, tapMaxMovement, doubleTapWindow, longPressDuration, swipeMinDistance, swipeMinVelocity }` (all `number`) ## Usage ```luau local Gestures = require("@builtin::modules.zinput.gestures") Gestures.onTap(function(ev) print("tap at", ev.x, ev.y) end) Gestures.onSwipe(function(ev) if ev.direction == "left" then nextPage() end end) -- inside a per-frame update: local zoom = Gestures.pinchDelta() local dx, dy = Gestures.panDelta() ``` ## Notes - Pinch and pan deltas are zero unless exactly two contacts are down this tick that no on-screen widget is working. - Long-press fires once per contact — the contact must stay within `tapMaxMovement` for the full `longPressDuration` and is marked so it never also fires a tap on release. - Every qualifying release fires `tap`; the second tap of a double-tap fires `doubleTap` and `tap` on the same tick. - Handler errors during dispatch are caught and logged, not propagated.
▲ 0↑ born
▣
module · born here
❒asset
# surface Active input-surface classification. Answers "what device class is the player using right now" — `"touch"` or `"kbm"` — and notifies on change; backs `Zin.surface`. Virtual touch controls mount whenever the surface is `"touch"`, in edit and play alike. ## The frame rule Resolution runs once per engine frame from the `Zin.tick` pipeline: a per-event observer collects which device classes produced events this frame, and the frame resolver applies one rule — **touch wins a frame that contains any touch event**. The primary touch contact also drives the mouse path (a projected `mouse.down`/`move`/`up` in the same frame), so classifying by the latest single event would flip to `kbm` on every tap; the frame rule keeps projection-generated mouse events from masking the touch that caused them. ## Capability default Before any input arrives, the class defaults to `"touch"` on sessions with a touch device (`touch_capable` — latched by a device's first contact or declared at boot by Android / the web client) and `"kbm"` otherwise, so touch-first devices present touch controls from the first frame. ## Simulated contacts A contact a script simulates (`inputSim`, `Zin.test.touchStart`) presents the session as `"touch"` while it is on the glass. Once the last simulated contact lifts, the class is the one it would be had the contact never been made: what device input last resolved, else the capability default, and `onChange` reports the return. A desktop a test or an agent taps on keeps presenting as keyboard and mouse, and its touch overlay comes down with the contact. A test that checks a whole touch session on a desktop declares one with `input.simulateTouchCapable(true)` (and `false` to take it back); a suite's input baseline puts the declaration back when the suite ends. ## Exports - `M.current() -> string` — the active surface class, `"touch"` or `"kbm"`. - `M.onChange(fn: (string, string?) -> ()) -> number` — subscribe to class flips; `fn(now, prev)` where `prev` is the previously reported class (the first-tick capability default when no event had resolved yet). Returns a handle. - `M.off(handle: number) -> boolean` — unsubscribe an `onChange` handle. - `M._beginFrame()` — internal: clear this frame's per-class flags; wired by `Zin.tick`. - `M._observeEvent(ev: any)` — internal: per-event observer; wired by `Zin.tick`. - `M._resolveFrame()` — internal: resolve this frame's class and fire `onChange` on a flip; wired by `Zin.tick`. - `M._reset()` — test-only: clear resolution state and subscriptions. Types: - `SurfaceClass = "touch" | "kbm"` ## Usage ```luau local Surface = require("@builtin::modules.zinput.surface") if Surface.current() == "touch" then showTouchOverlay() end Surface.onChange(function(now, prev) print("surface flipped to", now) end) ``` ## Notes - `onChange` fires from the `Zin.tick` pipeline on the frame the class flips; without a tick, resolution never advances and `current()` keeps returning the capability default. - The change signal compares against the last reported class, whose initial value is the capability default captured on the first tick of the session — a phone's first contact confirms the default silently, while a desktop touchscreen's first contact reports kbm→touch. - Handler errors during `onChange` dispatch are caught and logged, not propagated.
▲ 0↑ born
▣
module · born here
❒asset
# state Synchronous per-frame input state. Thin wrapper over the internal `__zero_input.snapshot()` FFI; backs `Zin.state`. Pointer-lock mutations live on `Zin.pointer`; the read-side `pointerLocked()` query lives here with the rest of the snapshot accessors. Held-time and synthetic-repeat state is owned by this module and updated via `_observeEvent` from the `Zin.tick` coordinator. ## Exports - `M.get() -> Snapshot` — full per-frame snapshot table; empty when the FFI is unavailable. - `M.keyDown(key: string) -> boolean` — held this frame. - `M.keyPressed(key: string) -> boolean` — edge-pressed this frame. - `M.keyReleased(key: string) -> boolean` — edge-released this frame. - `M.mousePosition() -> (number, number)` — current mouse `(x, y)`. - `M.mouseDelta() -> (number, number)` — `(dx, dy)` since last frame; while the UI is using a person's pointer it carries only script-driven motion (`get().pointer_owner` names whose the pointer is). - `M.scrollDelta() -> number` — wheel delta this frame. - `M.mouseButtonDown(idx: number?) -> boolean` — held; default idx = 0. - `M.mouseButtonPressed(idx: number?) -> boolean` — edge-pressed. - `M.mouseButtonReleased(idx: number?) -> boolean` — edge-released. - `M.pointerLocked() -> boolean` — pointer-lock query (writes are on `Zin.pointer`). - `M.uiWantsPointer() -> boolean` — `true` when the UI layer claims pointer focus. - `M.uiTookPress() -> boolean?`: `true` while a UI widget sensing a click or a drag holds the pointer press in progress; `false` with no press held and for a press on empty space; `nil` from the moment a press arrives until a UI pass has decided it. - `M.setRepeatDefaults(opts: RepeatOpts?)` — set default delay / period for synthetic repeat. - `M.getRepeatDefaults() -> RepeatDefaults` — read the active synthetic-repeat defaults. - `M.keyHeldTime(code: string) -> number?` — seconds since the key was pressed (or nil). - `M.mouseButtonHeldTime(idx: number?) -> number?` — seconds since a mouse button was pressed. - `M.keyRepeatFired(code: string, opts: RepeatOpts?) -> boolean` — should a synthetic key-repeat fire this frame? - `M._observeEvent(ev: any)` — internal: per-event observer, wired from the tick coordinator. - `M._reset()` — test-only: clear held-time and synthetic-repeat state. Types: - `Snapshot = { [string]: any }` - `RepeatOpts = { delay: number?, period: number? }` - `RepeatDefaults = { delay: number, period: number }` ## Usage ```luau local State = require("@builtin::modules.zinput.state") -- Rebind-capture-style probe: how long has a key been held, and is a -- synthetic repeat due this frame? local heldFor = State.keyHeldTime("Space") if heldFor and State.keyRepeatFired("Space", { delay = 0.4, period = 0.08 }) then -- charge-attack tick, key-repeat menu navigation, etc. end ``` ## Notes - Mouse-button indices are 0-based and follow `InputResource.mouse_buttons[]` (0=left, 1=right, 2=middle). Winit's `0=L, 1=M, 2=R` is converted in Rust before reaching Luau. - `mousePosition` / `mouseDelta` return two numbers, not a table. - Held-time / repeat state is updated by the `Zin.tick` coordinator via `_observeEvent` — without a tick, those queries return `nil` / `false`. - `keyRepeatFired` advances state on every call — call once per frame per consumer. - All entry points are no-ops or return zero values when `__zero_input` is missing (off-host execution). - Gameplay subscribes to controls through an activated `.inputMap`; this module is the raw snapshot layer those bindings evaluate against, used directly by rebind capture, the emulation floor, and dev tooling. Polling it from a world makes that world keyboard-only and draws the `engine-raw-key-poll` diagnostic at author time.
▲ 0↑ born
▣
module · born here
❒asset
# map A record-shaped map: `Zin.actions` / `Zin.axes` entries organized per device class (`kbm` | `gamepad` | `touch`) with single-parent `extends`, materialized into an EFFECTIVE map and applied as one binding set at a time. Backs `Zin.map`. An `.inputMap` asset with `.inputBinding` children is the map, and `Zin.scheme` is the live set: several maps are live at once and compose, each declaring the `group` its controls belong to and the groups it `suppresses` while live. `Zin.map.bake(name)` writes the map active here out as an `.inputMap` asset, with synthesis made explicit and editable. `man topics/input` covers the control model. Resolution order per action/axis and device class: 1. the map's own class bindings 2. the `extends` parent's (recursively) 3. synthesis from the `kbm` shape (touch class only) A vector `kbm` binding synthesizes a `touchStick`; a boolean `kbm` binding synthesizes a `touchButton`; a vector-shaped `mouseDelta` synthesizes a `touchDrag`; `scroll` synthesizes a `touchPinch`; an `axis`-kind `kbm` binding and a single-axis `mouseDelta` are left unsynthesized (ambiguous which touch shape to guess). A synthesized `touchButton` carries `priority = 100` — an authored `B.touchButton`'s default priority (50) always outranks synthesis on the touch-controls overlay, so a hand-tuned scheme's own layout hints win over whatever filled a gap automatically. A profile record (actions with `bindings`, axes with `binding`) is accepted anywhere a map record is — its bindings are treated as the `kbm` class. ## Activation and the `<axis>@<class>` convention `activate` flattens every class's bindings into each action/axis's single bindings list and applies it through `Zin.profile`, so any device fires the action. For axes — which evaluate exactly one binding — the primary slot is the first of `kbm` / `touch` / `gamepad` present; any OTHER class's binding registers as a class-suffixed sibling axis (`look` + `look@touch`). A consumer that wants both device values reads both names; a kbm-only world's primary axis (`Zin.axes.value("move")`) behaves identically whether or not a touch class exists. `Zin.profile.ensureActive("default")` delegates to `Zin.map.ensureActive()` when the resolved scheme is the builtin default, so it carries every device class rather than kbm alone. `Zin.map.ensureActive()` / `Zin.map.activate` win regardless of call order (`activate` re-registers the flattened profile under the same name and forces a reactivate). ## Exports - `M.materialize(record: any) -> effective map` — resolve `extends` + synthesize, without activating. - `M.activate(record: any) -> effective map` — materialize + apply as the live binding set (registers/activates a `Zin.profile`). - `M.effective() -> effective map?` — the active map's materialized form. - `M.activeName() -> string?` — the active map's name. - `M.bindingsFor(eff, name, class) -> bindings?` — one action/axis's bindings for one device class. - `M.ensureActive() -> effective map` — keep the current map, else activate `@builtin::inputMaps.default`. - `M.bake(name: string) -> AssetRef` — write the active effective map as a new `.inputMap` instance (`asset.create("inputMap", name, { record = ... })`). - `M.addTouchButton(actionName, buttonOpts, emitKey?) -> binding` — add a touchButton binding to an action's touch class on the live effective map (creating the action if absent) and re-activate. Used by `Zin.touchControls.button`. - `M.removeTouchButton(actionName, binding) -> boolean` — remove a binding added via `addTouchButton` and re-activate; drops the action entry once every class is empty. - `M._reset()` — test-only: clear active-map state. ## Usage ```luau local Zin = require("@builtin::modules.zinput") Zin.map.ensureActive() local eff = Zin.map.effective() print(eff.actions.jump.classes.touch ~= nil) -- synthesized or explicit -- Write the active scheme out as a control-asset map: Zin.map.bake("my_scheme") ```
▲ 0↑ born
▣
module · born here
❒asset
# virtual Per-tick virtual-control values. On-screen controls (and tests) write stick vectors, button states, and drag deltas here; the `touchStick` / `touchButton` / `touchDrag` / `touchPinch` binding kinds in `Zin.bindings` read them. Backs `Zin.virtual`. Three families, each keyed by the control's binding identity: - **Sticks** — zone string (`"left"`, `"right"`, ...). A vector clamped to `[-1, 1]` per component, persisting until set again or reset. - **Buttons** — id string: a `touchButton`'s `id` (stamped with the control's name when its map activates), else its `label`, else its `zone`. A held boolean; `buttonPressed` / `buttonReleased` derive edges from the previous frame boundary. - **Drags** — zone string. A delta vector that accumulates within a tick (`addDrag` sums repeated calls) and clears at the next frame boundary — the same per-frame-delta semantics as `Zin.state.mouseDelta()`. ## Edge-at-frame-boundary semantics `_beginFrame()` shifts `_buttons` into `_buttonsPrev` and clears drag deltas. It runs once per engine frame from the `Zin.tick` coordinator's gated begin block, before any binding evals happen. On-screen overlay code (script phase) calls `setButton` earlier in the same frame it wants the press recognized; `buttonPressed` reads true starting the frame `_beginFrame` next observes the transition — matching how a real key's press edge surfaces on the frame after the OS event, not the same frame the write happened. ## Exports - `M.setStick(zone: string, x: number, y: number)` — set a stick's vector (clamped). - `M.stick(zone: string) -> (number, number)` — read a stick's `(x, y)`; `(0, 0)` when unset. - `M.setButton(id: string, held: boolean)` — set a button's held state. - `M.button(id: string) -> boolean` — held state. - `M.buttonPressed(id: string) -> boolean` — press edge this frame. - `M.buttonReleased(id: string) -> boolean` — release edge this frame. - `M.addDrag(zone: string, dx: number, dy: number)` — accumulate a drag delta. - `M.drag(zone: string) -> (number, number)` — read a zone's accumulated `(dx, dy)` this frame. - `M._beginFrame()` — internal: frame-boundary edge shift + drag clear, called by `Zin.tick`. - `M._reset()` — test-only: clear all virtual state. ## Usage ```luau local Virtual = require("@builtin::modules.zinput.virtual") Virtual.setStick("left", 0.4, -0.9) local x, y = Virtual.stick("left") Virtual.setButton("Jump", true) if Virtual.buttonPressed("Jump") then -- fires once, on the frame after the set end ```
▲ 0↑ born
▣
module · born here
❒asset
# quiesce The dirty signal `Zin.tick`'s quiescence gate reads. A mutation of the mapping layer's structure outside the tick itself — a map activation, a context change, a virtual-control write, a forced surface class, a new axis over an already-held key — calls `mark()`, and the tick runs a full pass while a mark is pending. A tick with no pending mark and no live input events skips its pass. `mark()` raises the signal, `pending()` answers whether a full pass is owed, and the generation pair (`generation()` / `ack(g)`) keeps a mark raised DURING a full pass pending for the next one, so a mutation racing a tick is never lost. Internal to the zinput package: the mapping-layer modules mark it, the tick drains it.
▲ 0↑ born
▣
module · born here
❒asset
# touch Per-finger touch contacts. Thin wrapper over the `touches` array of the internal `__zero_input.snapshot()` FFI plus pre-baked `touch.*` event listeners; backs `Zin.touch`. ## Exports - `M.slots() -> { TouchPoint }` — all active contacts this frame, in begin order. - `M.count() -> number` — number of active contacts this frame. - `M.byId(id: number) -> TouchPoint?` — look up an active contact by finger id. - `M.primary() -> TouchPoint?` — the primary contact (slot 0), if a finger is down. - `M.capable() -> boolean` — whether the session has (or has declared) a touch source. - `M.onBegan(fn, opts?) -> handle` — subscribe to `touch.down` events. - `M.onMoved(fn, opts?) -> handle` — subscribe to `touch.move` events. - `M.onEnded(fn, opts?) -> handle` — subscribe to `touch.up` events. - `M.onCancelled(fn, opts?) -> handle` — subscribe to `touch.cancel` events. - `M.off(handle)` — unsubscribe a handle returned by any `on*` function. Types: - `TouchPoint = { id: number, slot: number, x: number, y: number, dx: number, dy: number, pressure: number, phase: string, pointer: boolean, owner: string?, widget: boolean }` ## Contact record fields | Field | Meaning | |---|---| | `id` | The platform's stable finger id for the contact. | | `slot` | Lowest index free when the contact began; 0 = primary. | | `x`, `y` | Screen position. | | `dx`, `dy` | This frame's accumulated delta. | | `pressure` | Normalized 0..1 (1 when the platform reports none). | | `phase` | `"began"` \| `"moved"` \| `"stationary"` \| `"ended"` \| `"cancelled"` (ended/cancelled contacts survive exactly one frame). | | `pointer` | Whether the contact drives the UI's pointer (and the mouse path), so a widget under it can take its press. One contact at a time does: the one that began while no other contact drove it, outside every region an on-screen control holds (`input.setTouchClaims`), and that is no simulated contact for the game alone. A contact a control takes lets it go, so the next finger to land drives it. | | `owner` | The on-screen controls holding the contact, by the owner name they state their regions under, or nil while none does. A contact beginning on a control's region is held from the start; one beginning on a control's zone (a movement stick's or a look area's) is held once the UI leaves its press, or at once while another contact drives the pointer, and is never held when a widget beneath it takes the press. So a thumb on the stick is held by the controls while a second finger presses a HUD button. | ## Usage ```luau local Touch = require("@builtin::modules.zinput.touch") for _, t in ipairs(Touch.slots()) do print(t.slot, t.x, t.y) end local h = Touch.onBegan(function(ev, gpe) print(ev.id, ev.x, ev.y) end) ``` ## Notes - `onBegan` / `onMoved` / `onEnded` / `onCancelled` are pre-baked kind filters over `Zin.events.on` — handlers dispatch from the `Zin.tick` pipeline and receive `(ev, gpe)` where `gpe` is the UI-focus flag at fire time. Return `"sink"` to stop lower-priority handlers from seeing the same event. - All entry points return empty / falsy values when `__zero_input` is missing (off-host execution).
▲ 0↑ born
▣
module · born here
❒asset
# bindings Binding primitives and evaluators. A binding names which physical input satisfies a control on one device class — the value a `.inputBinding` record's `kbm` / `gamepad` / `touch` field holds. A binding is a plain descriptor table (e.g. `{ kind = "key", code = "KeyW" }`); the evaluators (`evalHeld`, `evalPressed`, `evalReleased`, `evalAxis`, `evalVector`) dispatch on `kind` and read `Zin.state` / `Zin.virtual` to produce the live signal. `Zin.scheme` runs them once per tick for every live binding, and they are public so chords, axes and library authors can evaluate a binding without reimplementing the dispatch. ```luau -- boost.inputBinding/init.luau local B = require("@builtin::modules.zinput.bindings") return { label = "Boost", kind = "button", kbm = { B.key("ShiftLeft") }, gamepad = { B.padButton("left_shoulder") }, touch = { B.touchButton({ zone = "right-lower" }) }, } ``` ## Two frames, and which binding speaks which - **Stick bindings** (`vector`, `touchStick`, `padStick`) report the direction the player *means* — forward is `+y`. A `move` control carrying a keyboard class and a stick class drives both devices the same way. - **Delta bindings** (`mouseDelta`, `touchDrag`, `scroll`) report movement that happened — down is `+y`, because that is what the pointer did. They also differ in magnitude: a stick is a position bounded at 1.0, a delta is however far the device moved this frame. A control carrying both — look, zoom — declares `as = "delta"` on its held class with the `unitsPerSecond` a full deflection is worth, and `scale` on a delta class that counts in its own units (a pinch in pixels beside a wheel in notches). `Zin.scheme` applies both, so one sensitivity covers every device. ## Exports Keyboard and mouse constructors: - `M.key(code: string) -> Binding` - `M.mouse(button: string) -> Binding` — `"left"` / `"right"` / `"middle"`. - `M.modKey(spec: string) -> Binding` — `"Ctrl+S"`, `"Shift+Alt+P"`, `"Escape"`. - `M.axis(plus: Binding, minus: Binding, opts: StickOpts?) -> Binding` - `M.vector(right, left, up, down: Binding) -> Binding` - `M.wasd() -> Binding` - `M.arrowKeys() -> Binding` - `M.mouseDelta(axis: string?) -> Binding` — this frame's mouse delta. - `M.scroll(axis: string?) -> Binding` — scrollwheel delta. - `M.pointerLocked() -> Binding` — boolean, true while locked. Touch constructors (fed by `Zin.virtual`, which the on-screen controls write): - `M.touchStick(opts: { zone, axis? }) -> Binding` — vector. - `M.touchButton(opts: { zone?, label?, icon?, priority?, size?, group? }) -> Binding` — boolean. - `M.touchDrag(opts: { zone, axis? }) -> Binding` — per-frame delta vector. - `M.touchPinch(opts: StickOpts?) -> Binding` — scalar pinch delta. Gamepad constructors (addressed by canonical position, or by the device's own 0-based element index for a wheel, pedals, a flight stick or any element past the canonical layout; `slot` names one pad by number or a device by a piece of its name, omitting it means any connected pad; `rest` / `full` calibrate an axis so `rest` reads 0 and `full` reads 1): - `M.padButton(button: string | number, slot: (number | string)?) -> Binding` - `M.padAxis(axis: string | number, opts: PadAxisOpts?) -> Binding` - `M.padStick(stick: string, opts: StickOpts?) -> Binding` - `M.padTrigger(trigger: string, slot: number?) -> Binding` Predicates: - `M.isBoolean(b) -> boolean` - `M.isAxis(b) -> boolean` - `M.isVector(b) -> boolean` Evaluators: - `M.evalHeld(b) -> boolean` - `M.evalPressed(b) -> boolean` - `M.evalReleased(b) -> boolean` - `M.evalAxis(b) -> number` - `M.evalVector(b) -> Vec2` Pretty-printers: - `M.format(b: any) -> string` — single binding ("Space", "Ctrl+S", "WASD"). - `M.formatAll(bindings: any?, sep: string?) -> string` — joined summary; non-table arg returns `"<no bindings>"`. Types: - `Binding = { [string]: any }` — descriptor table with `kind` plus type-specific fields. - `Vec2 = { x: number, y: number }` - `StickOpts = { slot: number?, as: string?, unitsPerSecond: number?, scale: number? }` ## Notes - Bindings are pure data tables — they serialize cleanly, compare with `Json.encode`, and have no metatables. - `modKey` normalises modifier order in `format()` so a key written as `Shift+Ctrl+KeyS` displays the same as `Ctrl+Shift+KeyS`. The internal `mods = { ctrl, shift, alt }` flags are the canonical representation. - Mouse-delta, scroll, drag and pinch values are raw physical deltas, not clamped to `[-1, 1]`. `as = "delta"` + `unitsPerSecond` on the stick class beside them is what puts every class in one unit. - `as = "delta"` needs `unitsPerSecond` and has no default: the number that makes a pad feel right is the point of declaring the conversion, and a default would be right for one control and quietly wrong for the next. - Reading a member this module does not have raises immediately, naming the nearest members and the full list — a wrong guess at a constructor surfaces at the call rather than as `attempt to call a nil value` later. - `format()` always returns a string, never throws — returns `"<invalid>"` for malformed input.
▲ 0↑ born
·
assettype · born here
❒asset
# assetType (asset type) An asset type says what a kind of asset is: the files an asset of the kind is made of, the code that gives it behaviour, the interface a person uses to work with it, and how it is found, pictured and checked. A `<typename>.assetType/` folder declares a type called `<typename>`, and every `<name>.<typename>/` folder is an asset of it. `assetType` is itself a type, so a type is an asset like any other: it is created, versioned, installed and contributed the same way. ## Making a type `asset.create("assetType", "<typename>")` scaffolds a type. The type registers the moment its folder is written, anywhere under `/zero/source/`, and from then on `<name>.<typename>/` folders are its assets. An asset of a type that is not registered yet is not an asset, so make the type first. A type folder is a root: `~.x` in any file inside it names the type's own `x`, wherever the type is installed. Keep the type's whole implementation inside its folder and reach it that way. What a type folder must hold is set by this type's own `type.yaml`, the same way every type's `type.yaml` sets what its assets hold. `asset.validate` on a type reports anything missing, and the scaffold produces a folder that passes. ## What sets your type's schema (`type.yaml`) `type.yaml` is the structural contract every asset of the type is checked against. The keys below are the ones the engine reads; a key not listed here is ignored. | Key | What it controls | |---|---| | `suffix` | The folder suffix of the type's assets. Defaults to `.<typename>`. | | `primary` | The file or files that are the asset's content: what the asset resolves to when it is used. | | `entry_files`, `primary_aliases` | Further files that load as the asset or share its identity. | | `is_container` | Whether the suffix stays in the identities of what the asset holds. | | `is_opaque_walker` | Whether a walk of the tree stops at the asset and registers only its primary. | | `plural_dir`, `classify_exts` | Loose files in a folder of this name, or with these extensions, are assets of the type. | | `is_text_default` | Whether the asset's files are text unless stated otherwise. | | `broadcasts_subassets` | Whether assets nested inside an asset of the type are found by their own short name. | | `root` | `true` makes every asset of the type a root, so `~.x` inside one names that asset's own `x`. | | `contract_ref: { field, category }` | A key of the primary file that names another asset the asset is built on. | | `files: { required, optional }` | The files an asset holds (below). | | `allow_unlisted` | `false` reports every file the type does not declare. | | `aliases_from: [{ file, key }]` | Further names an asset answers to, read from its own files. | | `settings:` | Typed per-asset settings (below). | | `inspector:` | The interface people use for the type and its assets (below). | | `preview:` | How an asset is pictured (below). | | `references:` | Names of other assets the type's files carry (below). | | `indexing:` | What search reads for each asset (below). | | `describe:` | How a missing description is generated (below). | ### The files an asset holds Each entry under `files.required` or `files.optional` is `{ path, kind: file | folder, one_of_group?, content? }`. `*` in a path matches within one segment. Entries that share a `one_of_group` are satisfied by any one of them. `content` lists checks on the file's bytes: | Check | Passes when | |---|---| | `non_empty` | the file has content | | `json_field { key, type?, non_empty?, accept? }` | the JSON holds the key (a dotted path) with that shape | | `yaml_field { key, type?, non_empty?, accept? }` | the same for YAML | | `described { keys?, headings?, message? }` | the file says what the asset is (see "Ask your assets to say what they are") | Each check takes a `message`, which is what the author is told when it fails. ### Settings `settings: { values, schema: { type | instance, export? } }` gives every asset typed settings. `values` names the file an asset's values live in; `schema.type` declares one schema for the whole type, and `schema.instance` names a file each asset declares its own in. `asset.create` writes the resolved values, and a write to the values file reaches `onChange` with what changed. ## The human side (`inspector.luau`) A type is used by people through its Inspector, and without one the type is usable only from code. The Inspector is the type's interface for a person: for a procedural graph it is the graph editor, for a kit it is the tracking view of what the kit holds and what is still missing. Writing it is part of writing the type. `inspector: { type, instance? }` in `type.yaml` names the files. `type` is the interface for the type itself and for its assets; `instance` names a file an asset may ship to add its own. Each returns: ```luau return { sections = { { id = "graph", title = "Graph", build = function(ctx) ... end } }, replace = { contents = { ... } }, -- replace a default section by id order = { "graph", "contents" }, -- section order } ``` `build(ctx)` receives the asset and builds the section. A section's `title`, and the text its rows carry, is a string or an `i18n.text` value read from a catalog (`i18n.text("inspectors.mesh.title")`), which follows the editor's language. `asset.create("assetType", ...)` scaffolds a working `inspector.luau` to start from. `asset.validate` on a type that names no inspector, or names one that does not load, reports it. ## Say what your type is for (`about.yaml`) Every type carries an `about.yaml` that says what the type is for, in three plain-language texts: ```yaml intent: "Sets the typeface of the text in your game: UI, labels, signs and 3D lettering." function: "A font, from a TTF, OTF or WOFF file, made available to all of Zero's text, including 3D text." usage: "You choose it by name for your UI or your text, and the text appears in that typeface." ``` - **`intent`** is what the type is for in someone's game, in the words a game maker uses. Up to 800 bytes. - **`function`** is how it works today: what an asset of it is made of and what the engine does with it. Up to 1500 bytes. - **`usage`** is what a person or an agent does with one. Up to 1200 bytes. Write about the type as a whole, not one asset of it, and say what it does now. Agents read these texts to learn when to reach for the type and how; people searching find the type by them. The scaffold starts each text with `[[describe]]` and a note on what to write; a text that still starts that way counts as not written. `services describe` can write them. They show up in `asset.inspect` as `detail.about`, in `assetTypeRef:getAbout()`, at the end of the type's `types/<typename>` guide, and at the top of the type's Inspector. ## Ask your assets to say what they are A type can require each asset to carry a description: a file, written by the author or generated, saying what the asset is and what it is for. Declare it with a `described` check: ```yaml files: required: - path: "README.md" kind: "file" content: - { check: "described", message: "Say what this widget is for and where it goes." } ``` A file that is missing, empty or still has a line starting with `[[describe]]` fails the check, and so does a YAML file whose named `keys` are missing or over their `max_bytes`, or a Markdown file missing a named heading. `asset.validate` names the asset, and a push that carries it is refused with `message`. `services describe` finds such assets and writes their descriptions. `describe:` steers what is generated: ```yaml describe: guidance: "Say what the widget shows, what input it reacts to, and where it fits in a UI." examples: - "<identity of an asset of this type whose description reads well>" ``` An example is an asset of your type whose description is a true, written one, never a placeholder and never the asset being described; with none, leave `examples` empty. A type whose assets the model cannot perceive (a sound, a motion) says so in `guidance`, and the description is drawn only from what the asset's own files state. Start the file unwritten in your `template/`: a heading and one line starting with `[[describe]]`, never example content, which every new asset would carry verbatim. A type whose assets say what they are through their own content (a mesh, a texture) declares no check. ## The type's code (`behavior.luau`) `behavior.luau` returns one table. These are the keys the engine reads from it; anything else on the table is the type's own. ### What the type's assets can do | Key | Shape | What the engine does with it | |---|---|---| | `ref` | `{ [name] = function(self, ...) }` | Every function becomes a method on every asset of the type: `ref:name(...)`. | | `modules` | `{ [name] = require(".x") }` | Code the type's assets reach with `asset.containing(__FILE__).modules.<name>`. | | `events` | an events schema | Events an asset fires. Readers subscribe through `ref.events.<name>:connect(...)`; the type fires them. | | `refShapes` | `{ [method] = function(self) -> (typeExpr, source?) }` | The result type of a `ref` method for one particular asset (below). | | `namePattern` | a Lua pattern | The names `asset.create` accepts for the type's assets. Default `^[A-Za-z][A-Za-z0-9_]*$`. | | `derive` | `{ output, module, compute, fingerprint, matches?, required?, timeout? }` | A file computed from the asset when it is committed; a `required` one holds the commit until it lands. | Some `ref` names mean the same for every type, and the engine calls them: - **`instantiate(self, target?, opts?) -> (root, idMap)`**: puts the asset in a scene. Defining it is what makes the type scene-instantiable. Its return is a contract (below). - **`inspect(self) -> detail`**: what `asset.inspect` reports for the asset beyond the common record (below). - **`preview(self, opts)`**: renders the asset's picture; it wins over the type's `preview:` recipe. - **`previewMaterial(self) -> { material }`**: the material a `surface` preview paints. - **`saveDefinition(self)`**: writes the asset's in-memory edits back to its files in edit mode. Some names are answered for every asset before the type is asked, so a `ref` entry of the same name is never reached: `getSource`, `getBytes`, `getText`, `exists`, `deps`, `canInstantiate`, `canPreview`, `preview` (which calls yours when you define one), `meta`, `runtime`, `events`, `typeRef`, `modules`, and the residency flags `has_backing_asset`, `has_runtime_changes`, `cpu_resident`, `gpu_resident`. ### When the engine calls the type | Hook | Signature | When it runs | |---|---|---| | `onCreate` | `(name, opts) -> { [path] = contents }` | On `asset.create`. Returns the files of the new asset, laid over the type's `template/`. Annotate `opts`: its type is the schema `asset.create` checks the caller's arguments against. A `""` key writes a single loose file. | | `onReplace` | `(dest, files) -> files` | On an `asset.create` over an asset already at `dest`, after `onCreate`, so what the author added can be carried into the replacement. | | `onRegister` | `(self)` | Once per asset, when it first registers: when the world loads, on a live `asset.create`, and when an asset arrives later (installed, pulled, synced). This is what makes an asset take effect the moment it is written. | | `onChange` | `(ref, change)` | On every write to a file inside an asset of the type. `change` is `{ path, asset, type, kind, origin }`, plus `settings` and `settingsChanged` for a write to the settings values file; `kind` is `edited` or `seeded`, `origin` is `local` or `remote`. Filter on `change.path`. Writes to one asset arrive in order, each after the hook for the one before has finished, and the hook may wait on what it reads. A write the hook makes inside its own asset arrives later like any other, so keep the hook convergent. | | `onDependencyChange` | `(ref, change)` | When a module the asset's code requires is re-run, or a name the asset carries starts resolving. `change.kind` is `dependency`. | | `onDelete` | `(ref)` | When an asset of the type leaves the world: deleted, or the world it is in is swapped away. | | `validate` | `(ref) -> { { code, message, severity?, path? } }` | On `asset.validate`, after the `type.yaml` checks, for the type's own rules. `severity` defaults to `error`. Runs on every push, so a type's rules hold at publish. A hook that fails reports `validate.hook_failed`. | ### Settings hooks | Hook | When it runs | |---|---| | `settingsDefaults(name, opts, asked) -> table` | Once per `asset.create`, for values the schema's defaults do not give. | | `settingsCorrections(values, name, opts) -> (corrections?, reasons?)` | On every settings write. A correction to a field the writer named refuses the write, giving the reason. | | `settingsDerivedDefaults(values, explicit, changed)` | On a settings write, for fields derived from others. | | `normalizeSettings(values, stored?)` | On every read and write, to map an earlier spelling of a field to the current one. | | `settingsHealed(values, stored)` | On a read, to repair stored values. | | `settingsSchemaProblem(schema, ref) -> string?` | When an asset's own schema is read; a returned string refuses the schema. | `creationInputs` (`{ [opt] = true | selectorOpt }`) names `asset.create` options that are inputs to the type rather than settings. ### Reloading An edit to `behavior.luau` reaches existing assets with no restart. ## How an asset is pictured (`preview:`) | `kind` | The picture is | The type provides | |---|---|---| | `instantiate` | the asset placed in the preview studio through its `instantiate` | `ref.instantiate` | | `image` | a file the asset holds, fitted to the frame | `source: { files }`, the candidate files in order | | `surface` | the asset painted on a mesh | `mesh`, and `ref.previewMaterial` | | `custom` | whatever `ref.preview` returns | `ref.preview` | ```yaml preview: kind: surface mesh: sphere ``` `angle: [yaw, pitch]` turns the camera. The studio owns the light, the backdrop and the framing, so an asset pictures the same in every world. A type with no `preview:` that defines `instantiate` still answers `ref:preview()`. A picture is rendered when something asks to view it (the editor showing the asset, `ref:preview()`), when previews are generated on request (`assets.generatePreviews`), and when the asset is staged. An edit alone renders nothing. The picture records what it was made from, so a stale one is told from a current one. ## The names your type's assets hold (`references:`) Where your type's own format or API carries the name of another asset, declare it here: ```yaml references: keys: # a top-level key of the type's files that holds a name, or a table of them - { key: "shader", type: "shader" } args: # an argument of a call, counting from 1 - { call: "g:node", position: 2, type: "procNode" } fields: # a field of the options table a call takes - { call: "fx.beam", field: "material", type: "material" } ``` `type` is the category the name resolves in. `asset.declareReferenceKey`, `asset.declareReferenceArg` and `asset.declareReferenceField` declare the same from a script. ## What search reads (`indexing:`) `indexing:` is how assets are found. Search reaches an asset only through what its type's `indexing:` names, and adds nothing of its own. That includes you: an asset indexed badly is one you cannot find later, when you are making something else and need it. A type whose assets are never looked for says `indexing: none`. ```yaml indexing: data: # text, read from the asset's files - role: identity extractor: verbatim source: { file: "README.md" } - role: interface extractor: symbols source: { files: ["init.luau"] } - role: implementation extractor: verbatim source: { files: ["init.luau"] } content: # the picture - role: identity modality: image source: { file: "preview.png" } facets: # what a query filters and re-ranks by file: ".metadata" rigged: { type: bool, from: { components: { contains: SkinnedModel } } } roughness: { type: number, filter: range, from: { file: "mat.yaml", field: "floats.roughness" } } ``` **Roles.** Each `data` and `content` entry has a `role`, and a query matches in two slots: - **`identity`**: what an asset is. For anything you look at, the picture; for anything else, the text that says what it is. - **`capability`**: what it does and how it is made. `interface` (the signatures or shape a caller uses) and `implementation` (the body) both count as capability, and a type with code usually declares both. Ask what a person would recognise an asset of the type by, and what it does, and point each role at the file that says it. For text, that is the asset's description: the file your template starts with a `[[describe]]` block, which the author writes or `services describe` fills in (see "Ask your assets to say what they are"). **`data`.** `extractor: verbatim` embeds a file's text as it is; `symbols` embeds the declared signatures of code. `source` is `{ file }` or `{ files: [...] }`. Never index a file name (`source: { field: name }`): one or two words carry nothing to match. **`content`.** `modality: image` embeds the picture itself, so a text query matches what the asset looks like. A type whose assets are looked at makes the picture its identity. **`facets`.** What a query narrows and re-ranks the matches by. `file` is embedded whole, so keys nobody declared in it are still found. Each further key is computed for every asset and states a value for every one, including `false`: a file can imply "not rigged" but never say it, and a query separates rigged from unrigged only because the unrigged ones say `rigged: false`. A key is `{ type: bool | number | enum, filter?: range, from }`, where `from` is `{ file, field }` (a field of one of the asset's files, dotted for nesting), `{ metadata: key }`, or `{ components: { contains | any_outside } }` (what the asset's entities carry). ## What blocks a push A push checks every asset it carries against its type. These refuse it: - a required file that is missing, a `content` check that fails, a `described` file not written yet; - an error from the type's `validate`. Unlisted files and warnings do not. A `described` file blocks only a push that changes the asset. When a push is refused, the message names each asset and what it lacks. `world.publishBlockers()` and `zm status` read the same list without pushing. ## Typing a result from the asset (`refShapes`) A `ref` method whose result depends on the asset (one entry per child folder, per row of a config, per control a map declares) can only be annotated as `{ [string]: Thing }`, which accepts any key. `refShapes` states the result for each asset instead: a function returning a Luau type expression for that asset, and the module whose types the expression uses. Read the asset; never run it. ```lua -- inputMap.assetType/behavior.luau M.refShapes = { activate = function(self): (string, string) local names = {} for _, control in ipairs(M.ref.controls(self)) do table.insert(names, control.name .. ": Handle") end if #names == 0 then return "", "" end return "{ " .. table.concat(names, ", ") .. " }", "@builtin::modules.zinput.scheme" end, } ``` With it, `map.jump:onPressed(fn)` is checked and `map.noexisting` is reported. A per-asset type applies where the call site names which asset: a component field whose default names it, or an annotation `AssetRef<"inputMap", "<identity>">`. `asset.resolve(name, category)` carries only the category, and a name computed at runtime carries nothing, so calls on those keep the declared return. The type belongs to the call's result: index it there, or bind what you need from it there, and the names stay checked. `require("@builtin::assetTypes.assetType.shared.refShapes").published()` shows what was published: `categories` (each type's method surface) and `returns` (per-asset results by identity, then method). An identity missing from `returns` was never published. Results are recomputed when an asset is written; at most 64 assets of one type are read. ## Putting an asset in a scene (`ref.instantiate`) A caller writes one piece of code against every instantiable type, so what `instantiate` returns is fixed: ```lua local Instantiable = require("@builtin::assetTypes.assetType.shared.instantiable") M.ref = { instantiate = function(self, target, opts) local root = Instantiable.root(self, target, opts) -- compose the asset under `root`, now return Instantiable.result(self, root, idMap) end, } ``` **In.** `target` is the entity the asset lands under, or onto for a hierarchy type; with none, the type spawns a new root. `position`, `rotation` (three numbers in degrees, or a quaternion), `scale`, `name` and `temporary` mean the same for every type: `Instantiable.root` applies them to a root you make, `Instantiable.place` to one you adopt. Document any options of your own in the hook's `--!arg` docs. **Out.** `(root, idMap)`. `root` is the composed root, live when you return: build synchronously, never defer to a component's `awake`. `idMap` maps each original id to the spawned one, so a component that composes the asset again on every load can pass it back in and keep references into the composition. Every call goes through `Instantiable.result`, which refuses a root that is not live and turns a missing `idMap` into `{}`. ## Inspecting an asset (`ref.inspect`) `asset.inspect(ref)` builds a record every asset shares (`identity`, `name`, `guid`, `source`, `typeName`, `typeDefinitionPath`, `scope`, `origin`, `description`, `tags`), then calls `ref.inspect(self)` for the type's own `detail`: ```lua M.ref = { inspect = function(self) -- read the asset's own files, never runtime state: inspect works on an asset -- that has not been compiled, uploaded or registered return { --[[ what makes this asset what it is ]] } end, } ``` Without it, the record is the shared part alone, and an agent inspecting the asset learns nothing of what it is. A hook that raises leaves `detail` empty and sets `record.warning`. ## Discovery - `asset.list("assetType")`: every registered type. - `asset.inspect("<typename>")`: the type, its README and its `about.yaml` texts. - `asset.resolve("<typename>", "assetType")`: the type itself.
▲ 0↑ born
▣
module · born here
❒asset
# widget Widget namespace — re-exports every widget under `zui.widget.<name>`. Library users can either pull the whole namespace (`local W = require("modules.zui.widget")`, then `W.button(...)`) or grab a single widget directly (`local btn = require("modules.zui.widget.button")`). Each widget lives in its own `.module/` folder so authors adding a new widget edit exactly one file. The shared primitive every widget builds on is `zui.widget.node` — pulled into a user-defined widget the same way it's pulled in here. ## Exports This module is a namespace — every field is an assignment from the matching sibling module. No typed functions live here directly; the typed surface lives on each sibling. - `M.node` — core widget-table constructor (`modules.zui.widget.node`). - Content widgets: `label`, `button`, `icon`, `iconBtn`, `iconButton`, `chip`, `badge`, `card`, `colorSwatch`, `dialogueBox`, `kbd`, `input`, `codeEditor`, `slider`, `dragValue`, `checkbox`, `toggle`, `dropdown`, `datePicker`, `radioGroup`, `selectableList`, `image`, `viewport`, `progressBar`, `richText`. - DAW widgets: `fader`, `knob`, `meter`. - Game-HUD widgets: `healthBar`, `hotbar`, `minimap`. - Layout containers: `hbox`, `vbox`, `grid`, `split`, `sides`, `panel`, `section`, `scroll`, `collapsible`, `window`, `modal`, `popup`, `contextMenu`, `scene`, `area`, `anchor`, `topPanel`, `bottomPanel`, `leftPanel`, `rightPanel`, `centralPanel`. - Leafs: `spacer`, `flex`, `sep`. - Plot / Graph: `plot`, `graph`. - Drag-and-drop list: `dndList`. - Canvas: `canvas`. - Composite widgets: `tabs`, `tree`, `filterRow`, `statRow`, `statusLabel`. - Sub-namespaces: `lsp`, `fs`. ## Usage ```luau local W = require("@builtin::modules.zui.widget") return W.vbox{ W.label("Name:"), W.input(""), W.hbox{ W.button("Save", { onClick = "save" }), W.button("Cancel") }, } -- Or pull single widgets directly: local btn = require("@builtin::modules.zui.widget.button") return btn("Save", { onClick = "save" }) ``` ## Notes - The exposed `M.node` is the canonical primitive for user-defined widgets — `require("modules.zui.widget.node")` returns the same value. - Sub-namespaces (`lsp`, `fs`) collect tightly-coupled widget sets that only make sense together — isolating them keeps the top-level surface clean. - Plot and Graph are pure-Luau builders over canvas; no `egui_plot` dependency. - DndList composes per-row canvases + a transparent overlay canvas for drag-source detection and hover insertion indicators. - All re-exports are static — adding a new widget means adding a new `M.<name> = require(...)` line here (and creating the sibling module).
▲ 0↑ born
▣
module · born here
❒asset
# zinput zinput is the engine's Luau-side input framework and the **only** public Luau input API. It sits on top of the internal `__zero_input.*` FFI (snapshot, events, frameId, pointer-lock, simulate\*) and builds the control model above it in pure Luau: control assets grouped into maps, the live set of activated maps and its per-frame dispatch, per-device-class binding evaluation, the on-screen touch overlay, gesture recognisers, and the tick coordinator that advances all of it. The top-level module re-exports every submodule under a single table and owns the tick coordinator (`Zin.tick`) plus the unified handle namespace for `Zin.disconnect`. ## The control model A control is a `<name>.inputBinding/` folder inside a `<name>.inputMap/` folder. It carries a `label`, a `kind` (`button` / `axis1` / `axis2`), and a binding for each of the three device classes — `kbm`, `gamepad`, `touch`. A class set to `false` is a deliberate refusal. Nothing is live until something activates a map. A world activates the map it needs and subscribes to the controls it uses: ```luau public = { inputMap = Field.assetRef("inputMap", "@builtin::inputMaps.default", NoSync, "The controls this component reads."), speed = Field.number(5, NoSync, "World units per second at full deflection."), jumps = Field.number(0, NoSync, "How many times the jump control was pressed."), } local controls function awake() controls = public.inputMap:activate() controls.move:onInput(function(v, dt, active) if not active then return end local p = public.entity.position local step = public.speed * dt public.entity.position = { p.x + v.x * step, p.y, p.z - v.y * step } end) controls.jump:onPressed(function() public.jumps += 1 end) end function onDestroy() public.inputMap:deactivate(controls) end ``` What `activate` returned is this holder's claim on the map, and handing it back to `deactivate` disconnects the subscriptions made through it while the map stays live for whoever else holds it. Every activation reads the map's binding children again, so a control edited since it came up reaches the running set and the holders already standing on it. Several maps are live at once and compose: the player's surface is the union of them, so picking up a gun adds Fire beside the movement stick and dropping it takes away Fire alone. A map declares the `group` its controls belong to and the groups it `suppresses` while live, which is how a car stands walking down without owning the walk map. `Zin.scheme` holds the live set and runs the dispatch. `man topics/input` is the full walkthrough. ## Exports Subsystems (re-exported from the corresponding submodule): - `M.scheme` — the live set of activated maps and their per-frame dispatch. - `M.bindings` — binding constructors, evaluators, and the legend formatter. - `M.state` — per-frame snapshot reads plus held-time and synthetic repeat. - `M.events` — frame-event readers and `on`/`off` edge subscriptions. - `M.input` — `onBegan` / `onEnded` / `onChanged` / `onTextInput` listeners and `lastInputType()`. - `M.context` — the input context stack. - `M.chords` — sequence and simultaneous recognisers. - `M.gestures` — tap / double-tap / long-press / swipe / pinch / pan recognisers. - `M.touch` — per-finger contacts and `touch.*` listeners. - `M.surface` — touch-vs-kbm device-class classification. - `M.gamepad`, connected pads, family, button legends, each device's elements (`device`), the haptic outputs it offers (`capabilities`), and rumble. - `M.virtual` — the per-tick virtual-control store on-screen controls write. - `M.touchControls` — the on-screen touch overlay (stick, drag-look zone, buttons) and the API that adds a control while a world runs. - `M.emulation` — the map-driven key-emulation floor. - `M.pointer` — pointer lock: named holders ask for it (`lock` / `unlock`), `holders` names them, `requested` / `locked` / `status` read what the engine made of the ask from the input snapshot, leaving the input observation as it stands. - `M.back`: Back, claims a world holds while Back means something to it, and `press` to issue one. The engine routes each press to the topmost dismissible overlay, else the most recent claim, else the platform's own default (an Android app moves to the background). - `M.test` — synchronous test-input helpers. - `M.controllers` — `free` / `orbit` / `fps` controller factories. - `M.profile` — binding profiles, saved as JSON and loadable from `@builtin::profiles.<name>`. - `M.rebind` — interactive binding-capture sessions. - `M.conflicts` — the binding-collision reverse index. - `M.autoTick` — the opt-in per-frame tick worker. - `M.utils` — pure helpers. - `M.actions` / `M.axes` / `M.map` — the name-registered action, axis and map registry. A control asset replaced them; each carries its own `--!deprecated` message naming the replacement. Tick coordinator: - `M.tick(dt: number?)` — advance every stateful subsystem. - `M.lastTickAt() -> number` / `M.lastTickFrameId() -> number` — test/debug accessors. - `M._resetTickGuard()` / `M._resetLiveArmed()` — test-only. Handles: - `M.disconnect(handle: number) -> boolean` — accepts any Zin handle (input listener OR action handler) and routes to the right `disconnect`. Constants: - `M.VERSION` — the library version string. - `M.SPEC` — the VFS path of the architecture spec. - `M.ROADMAP` — the VFS path of the roadmap document. ## Raw state `Zin.state` and `Zin.events` are the snapshot and event layer that bindings evaluate against — the layer the emulation floor, rebind capture, and dev tooling operate on directly. Gameplay code subscribes to controls; polling `Zin.state.keyDown` from a world makes that world keyboard-only and draws the `engine-raw-key-poll` diagnostic at author time. ## Notes - `Zin.tick(dt)` is the single hub that advances every stateful subsystem each frame. Stateless features (state / events / utils / bindings / context) work without ticking; the live binding dispatch, axes, chords, subscriptions, held-time, repeat, and rebind are dormant until something ticks. - The first real input read arms the input system on its own: it starts `Zin.autoTick`, so dispatch, the touch overlay and the emulation floor advance with no host component and no explicit tick call. A host script component can still call `Zin.tick(dt)` from its `update(dt)` hook, and `Zin.autoTick.start()` remains available directly; both stay idempotent alongside the self-arming path. `Zin.test` engagement suppresses the arming so suites keep explicit control over tick cadence. - Same-frame re-tick dedup: `__zero_input.events()` is non-draining, so running the observe-and-dispatch pipeline twice in one engine frame would double-fire subscribers. The frame-id guard in `M.tick` and the autoTick worker keeps this from happening. - The handle namespace is unified: every handle from `Zin.input.on*` and `Zin.actions.bind` is drawn from a single counter, and `Zin.disconnect` routes any of them to the correct `disconnect`. `Zin.input.disconnect` and `Zin.actions.disconnect` are also wired to the unified dispatcher. - Library users can either grab the whole table (`require("@builtin::modules.zinput")`) or pull one submodule (`require("@builtin::modules.zinput.state")`). - `__zero_input` is an internal namespace — reachable from Luau but hidden from `/docs/api/`; production game code goes through Zin.
▲ 0↑ born
▣
module · born here
❒asset
# luau_introspect (module) Parses Luau/asset source TEXT into structured declarations. Pure string/pattern parsing (`string.find` / `string.match` / `string.gmatch`) over the literal source — no compiling, no VM spawn, no runtime state, no engine FFI. Given source text, it extracts what is written in the file. This is the shared parser every per-assetType `M.ref.inspect` hook uses to turn a component/module/tool's own source into the structured record `asset.inspect` returns. ## Exports - `docstrings(src) -> DocMap` — scans `--!desc` / `--!arg` / `--!return` / `--!example` comment runs and binds each run to the name of the declaration on the next non-comment line (the identifier after `function`, `public:`, `local function`, or `M.`). - `publicFields(src) -> { FieldEntry }` — parses `public = { name = Field.<kind>(default, mode), ... }` table-literal entries and module-scope `public.<name> = Field.<kind>(...)` assignments. - `events(src) -> { EventEntry }` — parses `events = { name = Event(payloadSchema?, syncMode?), ... }` table-literal entries. - `methods(src) -> { MethodEntry }` — parses `function public:<name>(...)` / `typed function public:<name>(...)` declarations (params + optional return type). - `lifecycleHooks(src, catalog) -> { string }` — top-level `function <name>(` declarations whose name is in the caller-supplied `catalog` array. - `moduleExports(src) -> { ExportEntry }` — parses `M.<name> = function` assignments, `function M.<name>(...)` declarations, and a trailing `return { foo = foo, ... }` export table. - `forSource(src, computeFn) -> any` — memoises `computeFn(src)` keyed on `src` itself in a module-local table. The same source text returns the cached result without re-running `computeFn`; different source text recomputes. Keyed on the source content (not an asset checksum) because composite/container assets (component folders, scene folders, etc.) all hash to the empty-string checksum — a checksum-keyed cache collapses every such asset's detail onto whichever one was inspected first. ## Usage ```luau local Introspect = require("modules.luau_introspect") local src = self:getInitScript() local detail = Introspect.forSource(src, function(s) return { fields = Introspect.publicFields(s), events = Introspect.events(s), methods = Introspect.methods(s), hooks = Introspect.lifecycleHooks(s, lifecycleCatalog), } end) ``` ## Notes - Every function is a pure string→table transform: same source text in, same structured table out, every time. No reads of live component state, no entity/world queries. - Structural scanning runs over a comment- and string-aware **mask** of the source (a same-length copy where comment bodies and string-literal contents are blanked to spaces, delimiters and newlines preserved). Pattern matches and brace/paren balancing run on the mask — so a brace, `Field.`, `Event(`, or a whole entry that appears inside a comment or a string literal never registers — while captured values are sliced from the original source at the same (aligned) indices. This makes the parser robust to apostrophes in comments, commented-out entries, string defaults containing `}` / `Field.` / `Event(`, and `[[ ]]` long strings. - `default` / `category` are raw trimmed source-text slices (with any trailing comment stripped), not evaluated values. - For a **ref constructor** (`Field.assetRef` / `dataRef` / `resource` / `componentRef`) the FIRST positional argument is the category / contract / componentType selector, captured under `category`; the SECOND argument is captured under `default`. - For every **other** Field kind the first argument is the `default` and `category` is nil. - A trailing `Sync` / `NoSync` identifier is captured as `sync`, tolerating a trailing comma or a trailing comment after the last argument. - Field/Event entries whose key is a computed or indirect expression (`[expr] = Field.number(...)`) are omitted — only literal identifier keys are recognised. - `methods` captures a `...` variadic parameter (as `name = "..."`), with its `: <type>` annotation when present. - A `--!desc` written above a field/event declaration (`<name> = Field.<kind>(...)` / `<name> = Event(...)`) or a `public.<name> =` assignment binds to that name in `docstrings`, and is folded into the corresponding `publicFields` / `events` entry's `desc`. - `lifecycleHooks` never hardcodes the lifecycle-callback catalog; the caller passes the list of names to match against. - `forSource`'s memo is bounded (oldest-key eviction) so a long session touching many distinct asset versions can't grow it without limit.
▲ 0↑ born
▣
module · born here
❒asset
# assetType.shared.ref Builds the metatable every `AssetRef` (the `{ __ref, type, name, guid, identity, path }` envelope returned by `asset.resolve` / `asset.ref`) carries. Replaces the per-call C metatable that used to live in `crates/zero_scripting/src/ffi/bindings/asset.rs::attach_asset_ref_metatable`. ## Public API ```lua local assetRef = require("@builtin::assetTypes.assetType.shared.ref") -- Called by the Rust factory (push_asset_ref_handle) via -- _G.__build_asset_ref_proxy after the envelope fields are set. assetRef.build(envelope) -- attaches AssetRefMT, returns the table ``` The module exposes no invalidation surface — discovery is registry-driven and hot-reload is transparent (see "Discovery and hot-reload" below). ## Method dispatch order `ref.foo` is resolved in this order: 1. **Default methods** — `getSource` / `getBytes` / `getText` / `exists` / `inspect` and the lazy `meta` property. Per-type definitions cannot override these (engine contract from gh#1889). 2. **Per-type `ref` table** — discovered through `asset.resolve(<typename>, "assetType")` + `require(<identity>.behavior)`. The lookup resolves to whichever `<typename>.assetType/` folder is currently registered for the typename (built-in, user, or library-vendored) and pulls its `ref` methods. 3. **Nil** — unknown key, same shape as the original C metatable. ## Adding methods for a new asset type Drop a `behavior.luau` into the type folder: ``` src/lua/lib/assetTypes/<typename>.assetType/ ├── type.yaml -- structural spec (existing) ├── behavior.luau -- ref + global behaviour (new) └── template/ -- placeholder body (existing) ``` `behavior.luau` returns: ```lua return { ref = { --!desc Per-instance method on every `<typename>` AssetRef. myMethod = function(self, ...) ... end, }, global = { -- Reserved for the asset.<typename>.* surface — not consumed -- yet; included so the contract from gh#1889 lands cleanly. }, } ``` Within `ref` methods, `self` is the AssetRef envelope: `self.path`, `self.identity`, `self.guid`, `self.type`, `self.name` are available. Engine-required fields (`guid`, `path`, `identity`, `type`) must not be redefined. ## Discovery and hot-reload Type discovery uses the asset registry, so it doesn't matter where a `<typename>.assetType/` folder lives — engine built-ins under `@builtin::assetTypes.<X>`, user types dropped under `/zero/source/<X>.assetType/`, or types vendored inside an imported library all resolve identically. The dispatcher walks `asset.resolve(<typename>, "assetType")` → canonical identity → `require <identity>.behavior` on every miss; the asset registry is the cache for the resolve half and Luau's `_LOADED` is the cache for the require half. Hot-reload is transparent. When a `<typename>.assetType/behavior.luau` is rewritten through VFS, the engine's `invalidate_require_cache_for_state` re-runs the module and mutates the cached `_LOADED[<identity>.behavior]` table in place. Dispatch reads `mod.ref` on every access (rather than caching a sub-pointer), so existing AssetRefs see the new methods on the very next access — no Rust-side hook into this module is needed, and no invalidation API is exposed for callers to call. The same registry-driven path also handles type **registration** correctness: dropping a new `<typename>.assetType/behavior.luau` updates the asset registry, the next `asset.resolve(<typename>, "assetType")` returns the new ref, and AssetRefs of that type immediately gain the new methods. ## Why Luau, not Rust The asset surface needed per-category behaviour (`material:getProperties()`, `bundle:instantiate(entityId)`, `tool:run(args)`) and the old shape couldn't grow without an FFI change per method. Owning the proxy in Luau means: - Type-specific methods ship as content (the `<typename>.assetType/` folder), not engine code. - Adding a new asset type drops in a new folder; no Rust rebuild. - Methods can call any other Luau global (`vfs`, `asset`, `Material`, `entity`, etc.) directly, instead of going through narrow FFI primitives. ## Consumers - `crates/zero_scripting/src/ffi/bindings/asset.rs::attach_asset_ref_metatable` — the Rust factory that pushes envelopes invokes `_G.__build_asset_ref_proxy` once per push. - Every Luau call site of `asset.resolve` / `asset.ref` / `entity(id).component.X.material` / any binding declared `AssetRef<...>` — they all receive envelopes built through this module.
▲ 0↑ born
▣
module · born here
❒asset
# yaml.module YAML decode + encode for authored engine content. Pure Luau, no engine dependencies — a general parsing library, not data-system plumbing. ```luau local Yaml = require("@builtin::modules.yaml") local doc = Yaml.decode(vfs.read(path)) vfs.write(path, Yaml.encode(doc)) ``` ## Supported subset - Block mappings (`key: value`) and block sequences (`- item`), nested to any depth. - Compact sequence-of-mapping entries (`- path: x` / ` kind: y`). - Flow collections — `{ a: 1, b: 2 }` and `[1, 2, 3]` — single line. - Plain scalars with type inference: `~` / `null` → nil, `true` / `false` → boolean, numeric literals → number, everything else → string. - Single- and double-quoted strings (`''` escapes a literal quote inside a single-quoted string; `\n` `\t` `\r` `\\` `\"` inside a double-quoted one). A quote opens a quoted scalar where a scalar begins — after `key:`, after a `- ` entry marker, or inside a flow collection — so a plain scalar carries an apostrophe as data (`note: the world's rules`). Quoted keys are read in flow mappings. - `#` comments — honored outside quotes, so a `#` inside a quoted string is kept as data. - Literal (`|`) and folded (`>`) block scalars, with a chomping indicator (`-` strips the final newline, `+` keeps every trailing blank line, none keeps one newline) and an indentation indicator (`1`-`9`: the content's indent past the parent's), in either order (`|-`, `>+`, `|2`, `>1-`). A block scalar's content is literal text: quotes (balanced or not), `#`, `key: value` and `---` inside it are data. - An optional leading `---` document marker. ## Loud-error contract Constructs outside the subset above raise instead of misparsing: anchors/aliases (`&`, `*`), tags (`!`), directives (`%`), multi-document streams (a second `---`), a block-scalar header it cannot read (`|x`, `|-+`, `|0`), tab indentation, and inconsistent indentation (both block structure and block-scalar bodies). Every error carries the offending line number (`yaml: line N: ...`), so a bad config points straight at the line to fix. Tab indentation is rejected everywhere — including block-scalar body lines whose leading whitespace contains a tab. A tab after the first non-space character of a line is content and passes through. ## API - `Yaml.decode(text: string): any` — decode a YAML document into a Luau value (table, scalar, or nil for an empty document). Raises on malformed input or an unsupported construct. - `Yaml.decodeWithComments(text: string): (any, boolean)` — decode as `decode` does, and report whether the text carries a comment by the decoder's own rule: a `#` at a line's start or after whitespace, outside a quoted scalar and outside a block scalar. Re-encoding the value drops such comments, so an editor that writes a document back reads this first. - `Yaml.encode(value: table): string` — encode a Luau table as YAML (block style, two-space indent, alphabetically sorted keys). Raises on values YAML can't represent (functions, userdata, non-string mapping keys). A top-level empty table encodes to an empty document, which decodes back to `nil` (the YAML empty-document ambiguity).
▲ 0↑ born
▣
module · born here
❒asset
# json JSON encode/decode library for Luau. Encodes Lua values to JSON strings and decodes JSON strings back to Lua values. Used for communication with the Rust side of the engine, the VFS read/write bridge, and any wire-format that needs JSON. Pure Luau, no engine dependencies. Compact and pretty-printed encoders, plus a hand-rolled decoder that streams the input by position so it works under WASM as well as native. ## Exports - `Json.encode(value: any, indent?: string, currentIndent?: string) -> string` — compact encode. Functions / unknown types and NaN/Inf encode as `null`. - `Json.encodePretty(value: any, indentStr?: string) -> string` — pretty-printed encode with sorted object keys (diff-friendly). - `Json.encodeArgs(...: any) -> string` — encode varargs as a JSON array. - `Json.decode(str: string) -> any` — decode a JSON string. Returns the decoded value, or `nil` + error message on failure. ## Usage ```luau local Json = require("@builtin::modules.json") local widget = { type = "button", text = "Click Me" } local compact = Json.encode(widget) -- '{"text":"Click Me","type":"button"}' local pretty = Json.encodePretty(widget, " ") local decoded = Json.decode(compact) local v, err = Json.decode("oops") -- v = nil, err = error message ``` ## Notes - Object keys are sorted alphabetically in both encoders for consistent output across runs. - Numeric keys on objects are stringified at encode time (JSON has no numeric keys). Pure-integer key sets get detected as arrays via `isArray` and encoded with brackets. - NaN, +Inf, -Inf encode as `null` — JSON has no representation. Round trips through `decode` recover `null` (Lua `nil`), so they don't preserve. - Unicode `\uXXXX` escapes decode to UTF-8 by hand to stay WASM-safe. Only the BMP is covered; supplementary planes via surrogate pairs are not. - Functions encode as `null`. - Decode is character-streamed — no regex, no `string.match` patterns on the whole input — so the line-and-column information needs to be reconstructed from the position offset.
▲ 0↑ born
▣
module · born here
❒asset
# assetType runtime The machinery that reads a `<typename>.assetType/behavior.luau` and turns its declarations into live behaviour. A `behavior.luau` is a table of declarations — `ref` methods, `modules` shared code, an `events` schema, a `namePattern`, `refShapes`, and the `onCreate` / `onRegister` / `onChange` / `onDelete` / `validate` / `settingsDefaults` / `settingsCorrections` hooks. None of it runs itself. This is the code that runs it, and it lives here because reading a type's declarations is the **assetType type's own behaviour** — the same way `material.assetType` owns what a `.material` does. ## Sub-modules | Module | Reads | Responsibility | |---|---|---| | `ref.module` | `ref`, `modules` | Builds every `AssetRef` envelope, attaches the shared metatable, and dispatches per-type methods and shared modules onto it. Also owns edit-mode write-behind persistence. | | `create.module` | `onCreate`, `namePattern`, `validate` | Backs `asset.create`: resolves the type, checks the name against its pattern, runs `onCreate` (or clones `template/`), and writes the instance. `validate.module` beside it checks a creation `opts` table against the type's `createSchema`. Before running `onCreate`, resolves the type's settings chain (below) and hands the result to the hook as `opts.settings`. | | `settings.module` | `settings`, `settingsDefaults`, `settingsCorrections` | A type's declared settings schema and where its values live (`type.yaml`'s `settings:` block). `Settings.resolveForCreate` layers the schema's own defaults, the type's own `settingsDefaults(name, opts, asked)` hook (a DEFAULT the schema can't express — a name-derived convention, a fact read off a payload the caller handed it, a value following a field `asked` shows a higher layer naming; any later layer overrides it), the Preset Manager, an importer's settings, the caller's `settings` table, then the type's own `settingsCorrections(values, name, opts)` hook (a CROSS-FIELD CONSTRAINT the schema can't express, applied last over the fully merged values). A correction over a default/preset/importer value lands silently; a correction that would override what the caller's own `settings` table explicitly asked for refuses the creation instead, naming the field and why. Neither hook is ever handed a table to mutate; each returns what it wants changed (`settingsCorrections` may also return a `{ [field]: reason }` table for that refusal message). `Settings.cloneValues` deep-copies a values table — `create.module` hands `onCreate` a copy, never the table it stamps. `Settings.valuesOf` / `writeValues` read and write an asset's own values file. | | `typeYaml.module` | `type.yaml` | The folder a type lives in and its parsed `type.yaml`, decoded once per content version of the file. `settings.module` and `inspector.module` read their blocks through it. `about` / `aboutAt` read a type's `about.yaml` (`intent`, `function`, `usage`), leaving out any key that is empty or still starts with `[[describe]]`; `aboutRows` and `aboutMarkdown` lay the texts out for the Inspector and the `types/<name>` guide. | | `inspector.module` | `type.yaml`'s `inspector:` block | Which inspector a type declares for its assets (`inspector: { type: ... }` or `{ instance: ... }`), and the declaration that file returns — the sections it adds, the generic ones it replaces, and their order — or the problem that kept it from loading. | | `onRegister.module` | `onRegister` | Fires an instance's once-only registration hook — on arrival, on world load, and for `@builtin` library instances. | | `changeDispatch.module` | `onChange`, `onDelete`, `refShapes` | Routes a VFS source write or a folder delete to the enclosing typed asset's type hooks. | | `refShapes.module` | `refShapes`, `ref` | Publishes what every `AssetRef<category>` answers to, so a member read on an asset-typed value is checked against that category's real surface. | | `events.module` | `events` | The per-asset event runtime behind `ref.events`. | | `instantiable.module` | `ref.instantiate` | The instantiation contract an asset type opts into: `root` stands the root entity, `place` applies the base placement opts to one the type adopted, and `result` shapes the `(root, idMap)` every `instantiate` returns. Also registers the `sceneInstantiable` field-constraint validator. | | `declaration.module` | `type.yaml` | The type's decoded declaration, read once and held until a write inside an `.assetType` folder; what every question about a type as a whole reads. | | `previewRecipe.module` | `type.yaml` `preview:` | How an instance's `preview.png` is produced: which of the four recipes (`instantiate`, `image`, `surface`, `custom`) the type declares, and what that recipe needs. | ## Reaching it ```luau local rt = require("@builtin::assetTypes.assetType.shared") rt.ref.loadTypeBehavior("material") ``` Fields resolve lazily. The prelude requires the sub-modules directly, in dependency order (`ref`, then `changeDispatch`, `onRegister.install()`, `refShapes.install()`) — a table that required all six on load would take that ordering away from it.
▲ 0↑ born
backing path · modules/zinput.module/touchControls.module

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.