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

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 eval…

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

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.

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

Interface

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

conforms to

zero/source-extract/v2

ZinputBindings Module Binding primitives. A binding names which physical input satisfies a control on one device class — the value a `.inputBinding` record's `kbm` / `gamepad` / `touch` field holds. Backs `Zin.bindings`. Bindings are *data*, not objects. Each constructor returns a plain table with a `kind` field and type-specific fields. `Zin.scheme` interprets them by dispatching on `kind` and reading the underlying state via `Zin.state`. Plain tables let bindings be inspected, serialized, compared, and composed without metatable surprises. Keyboard and mouse: { kind = "key", code = "KeyW" } { kind = "mouse", button = "left"|"right"|"middle" } { kind = "modKey", code = "KeyS", mods = { ctrl, shift, alt } } { kind = "axis", plus = <binding>, minus = <binding> } { kind = "vector", right, left, up, down = <binding>, ... } { kind = "mouseDelta", axis = nil|"x"|"y" } -- vector (nil) / scalar { kind = "scroll", axis = nil|"x"|"y" } -- vector (nil) / scalar { kind = "pointerLocked" } -- boolean (held = locked) Touch — fed by `Zin.virtual` (on-screen controls write it): { kind = "touchStick", zone = "left" } -- vector { kind = "touchButton", id?, zone?, label?, icon?, priority?, size?, group?, place?, fill?, stroke?, strokeWidth?, textColor?, fontFamily?, fontScale?, iconFont?, iconScale? } -- boolean { kind = "touchDrag", zone = "right" } -- vector { kind = "touchPinch" } -- scalar Gamepad — addressed by canonical position, so one binding evaluates against any pad on any platform, or by the device's own element index, so a wheel's pedals, a flight stick's throttle and a button past the canonical seventeen bind too. `slot` names one pad by number or a device by a piece of its name; omitting it means any connected pad: { kind = "padButton", button = "south" | <index>, slot? } -- boolean { kind = "padAxis", axis = "left_stick_x" | <index>, slot?, rest?, full?, as?, unitsPerSecond? } -- scalar { kind = "padStick", stick = "left"|"right", slot?, as?, unitsPerSecond? } -- vector Two frames, and which binding speaks which: * STICK bindings (`vector`, `touchStick`, `padStick`) report a direction the player means — forward is +y. A `move` axis 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. The two frames 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). The scheme applies both, so one sensitivity covers every device. `as = "delta"` moves a stick into the delta frame as well as the delta units: it says this stick drives a control measured in movement, and movement is what the mouse and the dragging finger beside it report. A `look` carrying a mouse and a right stick then turns the same way from both. Return shapes: key, mouse, modKey → boolean (held/pressed/released) axis → number in [-1, 1] vector → { x, y } numbers in [-1, 1] Evaluators (eval*): Each binding kind has a public evaluator that resolves the descriptor against the current frame's snapshot. They are the dispatch `Zin.scheme` runs each tick, and are public so chords, axes, and library authors can evaluate a binding without reimplementing it.

normalizeStickOpts(who: string, opts: StickOpts?) → StickOpts

argtypedescription
whostring
optsStickOpts?

key(code: string) → Binding

Bind to a single key. Code is a web-style identifier (e.g. "KeyW", "Space", "ShiftLeft", "ArrowUp") — same vocabulary as `Zin.state.keyDown(code)`.

argtypedescription
codestringThe key code identifier.

examples

local b = Zin.bindings.key("Space")

mouse(button: string) → Binding

Bind to a single mouse button by name ("left", "right", or "middle").

argtypedescription
buttonstringThe mouse-button name.

examples

local b = Zin.bindings.mouse("right")

modKey(spec: string) → Binding

Parse a modifier-decorated key spec like "Ctrl+S", "Shift+Alt+P", or just "Escape". Recognized modifier tokens (case-insensitive): "Ctrl", "Control", "Shift", "Alt". Anything else is treated as the base key code. The last segment is the base key.

argtypedescription
specstringThe modifier-decorated key spec.

examples

local b = Zin.bindings.modKey("Ctrl+S")

axis(plus: Binding, minus: Binding, opts: StickOpts?) → Binding

Bind to a 1-D axis composed of two opposing bindings. Each arm contributes how far it is pushed, 0..1, so a key gives 1 while held and a trigger gives its travel — which is what separates easing a car forward from flooring it. Value = plus travel - minus travel.

argtypedescription
plusBindingThe binding whose travel contributes positively.
minusBindingThe binding whose travel contributes negatively.
optsStickOpts?

examples

local b = Zin.bindings.axis(B.key("KeyD"), B.key("KeyA"))

vector(right: Binding, left: Binding, up: Binding, down: Binding) → Binding

Bind to a 2-D vector. Each arm is a binding that contributes to one axis when held. The returned vector is `{ x = right - left, y = up - down }`.

argtypedescription
rightBindingThe binding that drives `+x`.
leftBindingThe binding that drives `-x`.
upBindingThe binding that drives `+y`.
downBindingThe binding that drives `-y`.

examples

local b = Zin.bindings.vector(B.key("KeyD"), B.key("KeyA"), B.key("KeyW"), B.key("KeyS"))

wasd( ) → Binding

Convenience: WASD as a vector binding. Identical to `vector(key("KeyD"), key("KeyA"), key("KeyW"), key("KeyS"))`.

examples

local move = Zin.bindings.wasd()

arrowKeys( ) → Binding

Convenience: arrow keys as a vector binding. Identical to `vector(key("ArrowRight"), key("ArrowLeft"), key("ArrowUp"), key("ArrowDown"))`.

examples

local move = Zin.bindings.arrowKeys()

mouseDelta(axis: string?) → Binding

Bind to the mouse delta this frame. - `axis = nil` → vector binding returning `{ x = dx, y = dy }` - `axis = "x"` → scalar binding returning `dx` - `axis = "y"` → scalar binding returning `dy` Values are not normalised to `[-1, 1]` — mouse delta is a physical pixel count. A control carrying this beside a stick declares `as = "delta"` with `unitsPerSecond` on the stick class, so both classes reach the consumer measured in these pixels.

argtypedescription
axisstring?Optional. `"x"` / `"y"` for a scalar binding; omit for a vector.

examples

local look = Zin.bindings.mouseDelta()
local lookX = Zin.bindings.mouseDelta("x")

scroll(axis: string?) → Binding

Bind to the scrollwheel delta this frame. - `axis = nil` → vector binding returning `{ x = 0, y = scroll_delta }` - `axis = "y"` → scalar binding returning the wheel delta - `axis = "x"` → scalar binding returning `0` (no horizontal-scroll surface today; reserved for future hardware support)

argtypedescription
axisstring?Optional. `"x"` / `"y"` for a scalar binding; omit for a vector.

examples

local zoom = Zin.bindings.scroll("y")

pointerLocked( ) → Binding

Bind to pointer-lock state. `evalHeld` is true while the pointer is locked. `evalPressed` / `evalReleased` always return false (use `Zin.events.on` for edge events).

examples

local locked = Zin.bindings.pointerLocked()

isLabel(label: any) → boolean

Whether `label` is something a control can be labelled with: a non-empty string or an `i18n.text` value.

argtypedescription
labelanyAny value.

examples

Zin.bindings.isLabel(i18n.text("controls.control.jump"))  -- true

labelText(label: any) → string

The words `label` reads as now: a string as written, an `i18n.text` value in the player's language at this moment, `""` for anything else. Every listing that hands a label to a caller (a scheme row, the touch layout, `inputMap:controls()`) gives it this way.

argtypedescription
labelanyA string or an `i18n.text` value.

examples

print(Zin.bindings.labelText(record.label))

labelSource(label: any) → string

The Luau source that evaluates to `label` where it is written into a `.inputBinding`: `"Horn"` for a string, `i18n.text("controls.control.jump")` for an `i18n.text` value, so a control written by a tool reads in the player's language the way the one it was written from did.

argtypedescription
labelanyA string or an `i18n.text` value.

examples

Zin.bindings.labelSource(i18n.text("controls.control.jump"))  -- 'i18n.text("controls.control.jump")'

controlLabel(name: string) → any

The catalog label of a control named `name`, when a catalog the caller reads holds `controls.control.<name>`: an `i18n.text` value, else nil. The built-in library's catalog names the engine's own controls (`jump`, `sprint`, `crouch`, ...), and a world's `locales/<tag>/controls.json` can name its own, so a control that came without a label (a touch button synthesized from a keyboard binding, a map baked from a registry) still reads in the player's language.

argtypedescription
namestringThe control's name.

examples

local label = Zin.bindings.controlLabel("jump") or "Jump"

touchStick(opts: { zone: string, axis: string? }) → Binding

Virtual-stick binding: a vector fed by the on-screen stick in `opts.zone` (components -1..1). Evaluates {x=0,y=0} while no control writes the zone.

argtypedescription
opts{ zone: string, axis: string? }{ zone: string } — the stick's zone id (e.g. "left").

examples

B.touchStick({ zone = "left" })

appearanceKeys( ) → string

Internal: the appearance vocabulary as an error can print it.

touchButton(opts: TouchButtonOpts) → Binding

Virtual-button binding: a boolean fed by the on-screen button whose identity in `Zin.virtual` is `opts.id`. A button of a `button` control in an activated `.inputMap` takes the control's name as its id when it states none; otherwise the id falls back to a string `opts.label`, then to the catalog key of an `i18n.text` label, then to `opts.zone` (`Zin.bindings.touchButtonId`). Code that presses, tests or gates on a button (`Zin.virtual.button`, `Zin.arming.gate { virtualButtons }`, `Zin.test.tapTouchButton`) names it by that id. `priority` (lower renders first/more prominent on the touch overlay; defaults to 50 when omitted), `size` (`"small"|"medium"|"large"`, defaults to `"medium"` - this button's own circle radius, whatever else the overlay is drawing), `group` (buttons sharing a group render adjacently) and `place` shape the overlay's layout - see `Zin.touchControls`. `place` is `"column"` (the default: the action column growing inward from the bottom-right corner, where a game's actions go) or `"corner"` (the top-right corner of the safe area, rows along the top edge over the look area, for a control that works the app around the game rather than the game, such as the app menu's pause action). A corner button keeps its place whatever the column holds, so the controls a game draws in the column's place stay clear of it. `label` is what the circle reads: text, or an `i18n.text` value that reads in the player's language (`Zin.bindings.labelText`). A control in an `.inputMap` shows its own `label` on its buttons. `icon` is a glyph drawn in its place - `modules.icons` names the phosphor set the default `iconFont` selects, and any string the face holds a glyph for draws. `fill`, `stroke`, `strokeWidth`, `textColor`, `fontFamily`, `fontScale`, `iconFont` and `iconScale` state THIS button's appearance over whatever `Zin.touchControls.setAppearance` set for the overlay. A colour takes the CSS forms the canvas accepts; a family takes the list `style.fontFamily` takes (`ui.listFonts()` names them); a scale is the share of the button's radius the glyph is set at.

argtypedescription
optsTouchButtonOpts{ id: string?, zone: string?, label: (string | i18n.text)?, icon: string?, priority: number?, size: string?, group: string?, place: string?, fill: string?, stroke: string?, strokeWidth: number?, textColor: string?, fontFamily: string?, fontScale: number?, iconFont: string?, iconScale: number? } - at least one of id, zone or label.

examples

B.touchButton({ zone = "right-lower", label = "Jump", priority = 10 })
B.touchButton({ id = "up", zone = "right-lower", label = i18n.text("controls.button.up") })
B.touchButton({ zone = "right-lower", label = "Fire", icon = Icon.Bomb, fill = "#7d1d1d", stroke = "#e8b33a" })
B.touchButton({ id = "pause", label = "Pause", place = "corner", size = "small" })

touchDrag(opts: { zone: string, axis: string? }) → Binding

Touch-drag binding: a per-frame delta vector fed by drags in `opts.zone` (mouseDelta semantics — px this frame).

argtypedescription
opts{ zone: string, axis: string? }{ zone: string } — the drag zone id (e.g. "right").

examples

B.touchDrag({ zone = "right" })

touchPinch(opts: StickOpts?) → Binding

Pinch binding: a scalar axis fed by the two-finger pinch delta (px this tick; positive = spreading).

argtypedescription
optsStickOpts?

examples

B.touchPinch()

sortedKeys(t: { [string]: boolean }) → string

Internal: the sorted vocabulary, for an error that names what IS accepted instead of only what was not.

argtypedescription
t{ [string]: boolean }

checkPadSelector(who: string, slot: any) → void

Internal: check a pad selector: a slot number, or a piece of a device's name or id.

argtypedescription
whostring
slotany

isElementIndex(n: any) → boolean

Internal: whether `n` is a device element index (a whole number from 0).

argtypedescription
nany

padButton(button: string | number, slot: (number | string) →

Gamepad button binding, addressed by canonical position rather than by any vendor's letter — `south` is the lower face button on every pad, whatever it is printed with, or by the device's own button index (0-based, `Zin.gamepad.device(slot).buttons`), which binds every button a wheel, a shifter, a flight stick or a button board reports. With no `slot`, ANY connected pad drives it, which is what a single-player scheme wants; name a slot for local multiplayer, or a piece of a device's name to bind that device whatever slot it took. right_shoulder, left_trigger, right_trigger, left_stick, right_stick, select, start, guide, dpad_up, dpad_down, dpad_left, dpad_right; or a 0-based device button index.

argtypedescription
buttonstring | numberCanonical name: south, east, west, north, left_shoulder,
slot(number | stringPad slot, a device name to match, or nil for any pad.

examples

B.padButton("south")
B.padButton(12, "shifter")

padAxis(axis: string | number, opts: PadAxisOpts?) → Binding

Gamepad axis binding, one axis as a scalar: a canonical axis, or the device's own axis by its 0-based index (`Zin.gamepad.device(slot) .axes`), a wheel, a pedal, a throttle, a rudder. Canonical stick axes run -1..1 in the frame the binding declares — forward positive by default, matching the touch stick and `B.wasd()`, and screen-down positive under `as = "delta"`, matching the mouse and the dragging finger it is measured against. Trigger axes run 0..1. A device axis reads -1..1 across its native range. `rest` and `full` calibrate the reading: the binding reports `(reading - rest) / (full - rest)`, clamped to -1..1, so `rest` reads 0 and `full` reads 1. A pedal that reads -1 released and 1 floored binds with `{ rest = -1 }` and reports 0..1; one wired the other way with `{ rest = 1, full = -1 }`; a wheel whose centre sits off zero with `{ rest = 0.02 }`. With no connected device reporting the axis the binding reads 0, so a pedal map stays quiet until the pedals are plugged in. One axis carrying a throttle and a brake splits with `B.axis(B.padAxis(i), B.padAxis(i, { full = -1 }))`, each arm counting its own side. right_stick_y, left_trigger, right_trigger; or a 0-based device axis index. `full` (calibration, each -1..1; `rest` 0 and `full` 1 when omitted), and `as` / `unitsPerSecond` / `scale` as for any stick binding.

argtypedescription
axisstring | numberCanonical name: left_stick_x, left_stick_y, right_stick_x,
optsPadAxisOpts?`slot` (a pad slot, or a piece of a device's name), `rest` /

examples

B.padAxis("right_stick_x")
B.padAxis(2, { slot = "pedals", rest = -1 })

padStick(stick: string, opts: StickOpts?, slot: ?) → Binding

Gamepad stick binding: the 2-D vector of one thumbstick. The vector shape a movement or look axis wants, without naming its two components separately.

argtypedescription
stickstring"left" or "right".
optsStickOpts?
slot?Pad slot, or nil for any pad.

examples

B.padStick("left")

padTrigger(trigger: string, slot: number?) → Binding

Gamepad trigger binding: one trigger's analog travel, 0..1. The same trigger also latches a digital `padButton` at half throw, so a scheme binds whichever of the two it means.

argtypedescription
triggerstring"left" or "right".
slotnumber?Pad slot, or nil for any pad.

examples

B.padTrigger("right")

touchButtonId(b: any) → string

A touch button's identity in `Zin.virtual`: its `id`, else a string `label`, else the catalog key of an `i18n.text` label, else its `zone`. A button of a `button` control takes the control's name as its `id` when its map activates, so two controls whose buttons share a zone stay distinct. A label read from a catalog names the button by its key, which is the same in every language, and two buttons in one zone whose labels read from different messages stay two buttons.

argtypedescription
banyA `touchButton` binding.

examples

Zin.virtual.button(Zin.bindings.touchButtonId(binding))

isBoolean(binding: ?) → boolean

True for binding descriptors that resolve to a boolean (key, mouse, modKey, pointerLocked, touchButton).

argtypedescription
binding?The binding to test.

examples

assert(Zin.bindings.isBoolean(Zin.bindings.key("Space")))

isAxis(binding: ?) → boolean

True for the binding descriptors `evalAxis` resolves to a scalar: `axis`, `touchPinch` and `padAxis`, plus a `mouseDelta`, `scroll`, `touchDrag` or `touchStick` naming one axis of its two-axis surface.

argtypedescription
binding?The binding to test.

examples

assert(Zin.bindings.isAxis(Zin.bindings.mouseDelta("x")))

surfacesOf(binding: ?) →

Which device surface a binding reads from: `pointer` (mouse, wheel or finger), `keyboard` (keys and composed text), or `gamepad`. A composite binding (`axis`, `vector`) answers with the surfaces of every binding it combines.

argtypedescription
binding?The binding to classify.

examples

local s = Zin.bindings.surfacesOf(Zin.bindings.wasd())

visit(b: ?) → void

argtypedescription
b?

readsMouse(b: any) → boolean

argtypedescription
bany

_pointerTakenBy( ) → string

Internal: who a person's pointer belongs to this frame, when it is not the scene's — `"ui"` while the UI is using it (a widget that answers for the pointer stands under it or holds the press, or a shown screen holds the pointer), `"undecided"` while a finger's press waits for the UI to say whose it is — and `nil` while the scene reads it.

examples

local owner = Zin.bindings._pointerTakenBy()

_keyboardTakenBy( ) → string

Internal: whose a person's keyboard is this frame, when the UI takes any of it — `"ui"` while a widget taking every key holds focus (a text field with the caret, a terminal, a widget with its own `onKey`), `"shared"` while a focused widget takes some keys (Space and Enter for a button, the stepping keys as well for a slider) and the scene reads the rest — and `nil` while the scene reads every key.

examples

local owner = Zin.bindings._keyboardTakenBy()

collectKeys(b: any, out: { string }) → void

argtypedescription
bany
out{ string }

_keysTakenByUi(bindings: { any }) →

Internal: the keys these bindings read that the UI takes from a person's keyboard this frame: every key they read while a widget taking every key holds focus, the ones the focused widget takes while the keyboard is shared, none while the scene reads every key. A key the UI takes reaches the bindings with nothing until the widget lets go.

argtypedescription
bindings{ any }The binding descriptors to test.

examples

local taken = Zin.bindings._keysTakenByUi({ Zin.bindings.key("Space") })

collectPad(b: any, out: { string }) → void

Internal: the canonical pad controls a binding reads, by the names a pad's `ui_buttons` lists them under.

argtypedescription
bany
out{ string }

_padTakenByUi(bindings: { any }) →

Internal: the pad controls these bindings read that a game menu on screen takes this frame, on any connected pad: the d-pad, `south` and `east` while the menu moves and presses with them, and the left stick while a menu is up. A control the menu takes reaches the bindings released and centred until the menu lets go.

argtypedescription
bindings{ any }The binding descriptors to test.

examples

local taken = Zin.bindings._padTakenByUi({ Zin.bindings.padButton("south") })

_readMouse(bindings: { any }) → boolean

Internal: whether any of these bindings reads a person's mouse — a button, its motion or its wheel — directly or through an `axis` / `vector` arm.

argtypedescription
bindings{ any }The binding descriptors to test.

examples

if Zin.bindings._readMouse({ Zin.bindings.mouseDelta() }) then ... end

isVector(binding: ?) → boolean

True for the binding descriptors that resolve to a 2-D vector: `vector` and `padStick`, plus a `mouseDelta`, `scroll`, `touchDrag` or `touchStick` reporting its whole surface. Naming one axis of those four makes the binding a scalar, which `isAxis` answers for, so no binding answers both.

argtypedescription
binding?The binding to test.

examples

assert(Zin.bindings.isVector(Zin.bindings.wasd()))

primaryContactClaimed( ) → boolean

A finger the on-screen controls have claimed reads as a held left mouse button until the UI has decided its press, because the engine projects the contact driving the pointer onto the mouse where the contact arrives. A `mouse` binding means the player pressed a mouse button. A thumb on the stick is not that, so a claimed contact driving the pointer suppresses every mouse binding for as long as it is claimed; otherwise one touch on the stick moves AND fires whatever the world bound to left-click. Required lazily: touchControls requires this module.

mouseDeltaNow( ) → void

The same projection moves the mouse, not just its buttons: a finger dragging the look zone also reads as mouse movement. Both classes then report the drag, and the control is credited to whichever the reader checks first — so a phone's look drag shows up as keyboard-and-mouse. A claimed contact is the overlay's, so the mouse it projects is not a mouse the player moved. The emulation floor synthesizes a mouse delta ON PURPOSE, for controls the scheme does not cover, and writes it to the same place. That one is a delta a reader should see; the platform's projection is not. The floor reports what it emitted, so the two are told apart rather than dropped together.

stickFrameY(binding: any, raw: number) → number

A stick's y in the frame its binding declares. The platform reports a stick screen-down positive. A stick left in its own frame reports the direction the player means, so forward is positive and one `move` axis drives a keyboard and a stick the same way. A stick declared `as = "delta"` drives a control measured in movement instead, beside a mouse and a dragging finger, so it keeps the screen-down sign those report.

argtypedescription
bindingany
rawnumber

armTravel(arm: any, surface: string?) → number

Resolve a binding descriptor against the current frame's input state. Available to library authors who want to evaluate user-supplied bindings without reaching into the dispatch logic themselves. How far one arm of an `axis` binding is pushed, 0..1. A key is pushed or it is not. A trigger is pushed by an amount, and that amount is the difference between easing a car forward and flooring it, so an arm that reports a magnitude contributes the magnitude. An arm that is itself signed contributes only the half that pushes this arm's way — the other half is what the opposing arm is for.

argtypedescription
armany
surfacestring?

modsMatch(mods: ?, surface: string?) → boolean

Internal: are the current modifier flags consistent with the binding's spec?

argtypedescription
mods?
surfacestring?

evalHeld(b: ?, surface: string?) → boolean

Is this binding currently delivering a held signal? key/mouse/modKey/pointerLocked → boolean held. axis/vector/mouseDelta/scroll → magnitude non-zero. `"editor"`. An input map declared for the editor surface evaluates with `"editor"`.

argtypedescription
b?The binding to evaluate.
surfacestring?Whose keys a key binding reads: `"scene"` (the default) or

examples

if Zin.bindings.evalHeld(b) then ... end

evalPressed(b: ?, surface: string?) → boolean

Did this binding's press edge fire this frame? Boolean bindings only. Axis/vector return false (use evalAxis/evalVector with a held-time threshold for edge tracking). `"editor"`. An input map declared for the editor surface evaluates with `"editor"`.

argtypedescription
b?The binding to evaluate.
surfacestring?Whose keys a key binding reads: `"scene"` (the default) or

examples

if Zin.bindings.evalPressed(b) then print("jump") end

evalReleased(b: ?, surface: string?) → boolean

Did this binding's release edge fire this frame? `"editor"`. An input map declared for the editor surface evaluates with `"editor"`.

argtypedescription
b?The binding to evaluate.
surfacestring?Whose keys a key binding reads: `"scene"` (the default) or

examples

if Zin.bindings.evalReleased(b) then ... end

evalAxis(b: ?, surface: string?) → number

Resolve a 1-D axis binding to a scalar. For `axis` bindings the result is in `[-1, 1]`. For `mouseDelta` / `scroll` bindings the result is a raw physical delta (pixels, wheel clicks) and may exceed that range — shape it with `Zin.axes`. `"editor"`. An input map declared for the editor surface evaluates with `"editor"`.

argtypedescription
b?The binding to evaluate.
surfacestring?Whose keys a key binding reads: `"scene"` (the default) or

examples

local x = Zin.bindings.evalAxis(Zin.bindings.mouseDelta("x"))

formatKeyCode(code: any) → string

A key code as a legend writes it: "KeyW" as "W", "Digit7" as "7", a key with a name (Space, Escape, ArrowUp, ShiftLeft, ...) in the player's language, and anything else (F1, Numpad4, ...) as the code.

argtypedescription
codeany

marker(key: string) → string

A marker legend: the catalog's words between angle brackets.

argtypedescription
keystring

isVectorShape(b: any, right: string, left: string, up: string, down: string) → boolean

Internal: does a vector binding match a fixed WASD/Arrow shape?

argtypedescription
bany
rightstring
leftstring
upstring
downstring

format(b: any) → string

Render a single binding descriptor as a user-readable string, in the player's language: the words come from the `controls` catalog, and in English they read `Space`, `Left Ctrl`, `Ctrl+S`, `Right mouse button`, `Mouse movement`, `Mouse wheel`, `E / Q`, `WASD`, `Pad-A`. A pad binding is named for the pad the person holds (`Zin.gamepad.label`): on a headset's hand controllers it reads as the controls printed on them, `X`, `Right grip`, `Left thumbstick`, `Right thumbstick up/down`. The rebinding UI shows it verbatim. Returns `"<invalid>"` for malformed input (does not throw).

argtypedescription
banyThe binding to format.

examples

local s = Zin.bindings.format(B.modKey("Ctrl+S"))  -- "Ctrl+S"

formatAll(bindings: any?, sep: string?) → string

Render an array of bindings joined by `sep` (default `", "`). Returns `"<no bindings>"` if the argument isn't a table, `"<empty>"` for an empty array, each in the player's language. What a summary row listing one control's bindings for a device class shows.

argtypedescription
bindingsany?The bindings to format.
sepstring?Optional join separator (default `", "`).

examples

Zin.bindings.formatAll({ B.key("Space"), B.modKey("Ctrl+S") })

evalVector(b: ?, surface: string?) → Vec2

Resolve a 2-D vector binding to `{ x, y }`. For `vector` bindings the result is in `[-1, 1]`. For `mouseDelta` / `scroll` bindings (with no `axis` set) the result is the raw frame delta — `mouseDelta` = `{ x = dx, y = dy }`, `scroll` = `{ x = 0, y = wheel_delta }` (x reserved for future h-scroll). `"editor"`. An input map declared for the editor surface evaluates with `"editor"`.

argtypedescription
b?The binding to evaluate.
surfacestring?Whose keys a key binding reads: `"scene"` (the default) or

examples

local mv = Zin.bindings.evalVector(Zin.bindings.wasd())

headsetLook(binding: any, v: Vec2, dt: number, signal: any?) →

What a stick binding reads in a headset, when the look action is the control it drives: the frame units of the binding's control and nothing on the vertical axis. Applies to a right-stick `padStick` declared `as = "delta"` while an XR session holds input focus. Under snap turning the horizontal axis is the steps flicked this frame, each worth the signal's `snapDegrees`; under smooth turning it is the stick's deflection integrated as the binding states.

argtypedescription
bindinganyThe binding being read.
vVec2The binding's reading in its own frame, from `evalVector`.
dtnumberSeconds the frame covers.
signalany?What the headset reports: `{ turnMode, turnSteps, snapDegrees }`, or nil outside a session.

examples

local x, y = Zin.bindings.headsetLook(b, v, dt, { turnMode = "snap", turnSteps = 1, snapDegrees = 45 })

availableMembers( ) → void

Reading a member this surface does not have raises here, naming what it does have. Without it a wrong guess at a binding constructor -- `mouseButton` for `mouse` -- surfaces later as `attempt to call a nil value` at whatever line consumed the binding, with nothing pointing at the real name.

nearestMembers(wanted: string) → void

A guess is usually a longer or shorter spelling of the real thing, so offer any member whose name contains the guess or is contained by it.

argtypedescription
wantedstring

__index(_: ?, key: any) → void

argtypedescription
_?
keyany
⌬ Types
Binding = { [string]: any }Vec2 = { x: number, y: number }StickOpts = {PadAxisOpts = {TouchButtonOpts = {

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.

49+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
# 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
# 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
# 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
# utils Pure helpers for the `Zin` input library. Mouse-button name↔index conversion, key-code normalization, held-modifier matching against a frame snapshot, and the shaping a reading passes through on its way to a consumer. No FFI; safe to call from any context. Stateless. ## Exports - `M.buttonName(idx: number) -> string?` — convert a 0-based mouse button index to its name. - `M.buttonIndex(name: string) -> number?` — convert a mouse button name to its 0-based index. - `M.normalizeKey(code: string) -> string` — canonicalize a key code: a single ASCII letter becomes its `Key<L>` code, a single digit its `Digit<N>` code; multi-character codes pass through. - `M.matchModifiers(snapshot: Snapshot, mods: Modifiers) -> boolean` — test whether the snapshot's held keys match the requested modifier set. - `M.applyCurve(curve, x: number) -> number` — apply a response curve to a reading. - `M.applyDeadzoneScalar(x: number, deadzone: number?) -> number` — 0 below the threshold, the reading at or above it. - `M.applyDeadzoneVector(v: Vector2, deadzone: number?) -> Vector2` — the same, measured **radially** on the magnitude of the pair. - `M.shapeScalar(x: number, deadzone: number?, curve, invert: boolean?) -> number` — deadzone, then curve, then inversion. - `M.shapeVector(v: Vector2, deadzone: number?, curve, invert: boolean?) -> Vector2` — the same for a pair. - `M.smoothToward(current: number, target: number, dt: number, tau: number) -> number` — one step of an exponential approach with time constant `tau`. A `curve` is `"linear"`, `"quadratic"`, `"cubic"`, a function of the reading, or `nil` for linear. Types: - `Snapshot = { [string]: any }` — the raw frame-snapshot table returned by `Zin.state.get()`. - `Modifiers = { ctrl: boolean?, shift: boolean?, alt: boolean? }` — modifier subset to require in `matchModifiers`. - `Vector2 = { x: number, y: number }` — a two-component reading. ## Shaping The order is deadzone, curve, invert, then the approach toward the shaped target. A scalar takes its deadzone per value; a pair takes it radially, so a diagonal is not clipped into a cross by two independent thresholds. `"quadratic"` squares while keeping the sign, so a half-pushed stick reads a quarter in the direction it was pushed. A curve function that raises, or answers with anything other than a number, leaves the reading as it was. This is the one implementation of that shaping: `Zin.axes` reads it for a registered axis and `Zin.scheme` for an `axis1` / `axis2` control, so an axis and a control declaring the same numbers read the same. ## Usage ```luau local Utils = require("@builtin::modules.zinput.utils") local name = Utils.buttonName(0) -- "left" local idx = Utils.buttonIndex("right") -- 1 local key = Utils.normalizeKey("w") -- "KeyW" local hit = Utils.matchModifiers(snap, { ctrl = true, shift = false }) ``` ## Notes - Pure functions — no state, no side effects. - Mouse-button indexing is 0-based and matches `Zin.state.mouseButtonDown(idx)` (0=left, 1=right, 2=middle). - `matchModifiers` ignores fields set to `nil` in `mods` — only `true`/`false` are constraints. - `normalizeKey` rejects any other single character: no bound key code is one character long, so `"?"` raises rather than resolving to a phantom key nothing consumes.
▲ 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
# 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/bindings.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.