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

scheme

The live set of activated input maps, and the per-frame dispatch that turns their bindings into the events a controller subscribed to. Backs `Zin.scheme`.

by◐lumi·posted 3mo ago
What it does

scheme

The live set of activated input maps, and the per-frame dispatch that turns their bindings into the events a controller subscribed to. Backs Zin.scheme.

Nothing is live until something activates a map

A controller holds an inputMap ref, activates it when it takes control, and releases it when it gives control up. The live binding set is exactly the union of what current holders asked for, so an empty world has an empty input surface and an empty screen — no scheme is active by default, and nothing appears on a phone that no component consumes.

For a component that drives the thing it lives on, taking control and being awake are the same moment, so awake / onDestroy are the hooks. For anything a player enters and leaves — a car, a turret, a menu — they are not: the car is still there after the player gets out, so the map goes live on entry and stands down on exit.

public = {
    inputMap = Field.assetRef("inputMap", "@builtin::inputMaps.default", NoSync, "The controls this component reads."),
    speed = Field.number(5, NoSync, "World units per second at full deflection."),
    jumps = Field.number(0, NoSync, "How many times the jump control was pressed."),
}

local controls

function awake()
    controls = public.inputMap:activate()

    controls.move:onInput(function(v, dt, active)
        if not active then return end
        local p = public.entity.position
        local step = public.speed * dt
        public.entity.position = { p.x + v.x * step, p.y, p.z - v.y * step }
    end)

    controls.jump:onPressed(function() public.jumps += 1 end)
end

function onDestroy()
    public.inputMap:deactivate(controls)
end

What activate returned is this holder's claim on the map. Keep it and hand it back: releasing the claim disconnects the subscriptions made through it, and the map stays live for whoever else holds it.

A claim also ends with the context that opened it. A component's claim is released when that component instance goes, whether or not it writes an onDestroy: the component is removed from its entity, the entity despawns, or the component hot-reloads (its new life's awake activates again). A claim a module body opens ends at the module's next run. scopes.list() names each standing claim as a luau row under the context it follows, and scopes.release(tag) ends it with everything else that context holds.

Several maps compose by all being live

The player's surface is the union of every live map, which is what a game needs: picking up a gun activates a weapon map and Fire appears beside the movement stick; dropping it takes away Fire and nothing else. Two controllers that each activate a map with a movement stick produce two sticks — visible, attributable to the second controller, and the importer's to resolve.

Two components activating the same map read one set of controls, each through its own claim. A claim's release disconnects what that holder subscribed and leaves the other holders' handlers attached; the map leaves the live set when its last claim goes. Zin.scheme.live() reports each live map's holders — how many claims are still standing on it — and heldBy, which says who each of them is: kind ("component" or "execute"), entity, source as the chunk:line the activation was opened at, and the label the caller passed to activate("weapon-swap").

An activation reads the map's children as they stand now

Every activate re-reads the map's <name>.inputBinding/ children, so a control added, edited or removed since the map came up reaches the running set on the next activation. The controls are edited in place, so it reaches the holders already standing on the map too: their handles keep working and every subscription they made carries on across the edit.

A map can stand another one down

Composition cannot say "not while this is happening". A map declares the group its controls belong to and the groups it suppresses while live:

-- driving.inputMap/init.luau
return { group = "vehicle", suppresses = { "player" } }

Every live map in a suppressed group reads nothing and draws nothing for as long as the suppressor is live. It is not released: it keeps its holders, its handles and every subscription, and resumes untouched when the suppressor goes. So a car stands down walking without ever finding, owning or releasing the walk map — and a menu stands down the whole game with one declaration.

A map that declares no group belongs to one named after itself, so it collides with nothing and can still be named by something that wants to stand it down. Declaring neither field composes with everything.

The drop frame runs on the tick a map stands down, so a stick held at that moment reports its neutral value once and whatever it drove stops rather than sticking.

Dispatch

_advance(dt) evaluates every live binding once per tick, across every device class it carries — a tablet with a keyboard attached and a desktop with a pad plugged in both answer to whichever the player actually used, rather than to a nominated primary.

EventFiresCadence
inputOnce while the binding is active with (value, dt, true), and once more on the frame it goes inactive with the neutral value and falsePer engine frame
pressed / releasedA button's edgesPer engine frame
changedWhen the value differs from the previous tickPer tick

input firing on the drop frame is what lets one handler both start and stop the motion it drives, without a second subscription to notice the release.

A frame carries more than one tick whenever a host calls Zin.tick beside the tick the engine already runs, or fast-forwards several ticks to converge smoothing. Evaluation follows the tick, so the smoothing lands and changed reports each step of it. input, pressed and released are stamped with the engine frame they were reported for, so the frame carries one of each however many ticks ran in it. Both edge sources hold this frame's edge for as long as the frame lasts: the input snapshot's pressed flag, and Zin.virtual's previous-frame button table. That is what a second reporting pass reads as another press.

Zin.scheme.fired's count is the number of engine frames a control was active since it last cleared, so a button held across two frames reads 2 for one press. The pressed / released subscriptions are what count edges.

A binding that declares a context is live only while that context is on top, the same activity rule actions apply.

An axis1 / axis2 control's own deadzone, curve, invert and smoothing are applied here, in that order, to the reading its classes produced — after as / unitsPerSecond / scale have brought every class into the control's unit, so one deadzone written in that unit covers the stick, the mouse and the finger together. A deadzone is per value on an axis1 and radial on an axis2. The shaping maths is Zin.utils', shared with the axis registry.

smoothing is the one piece of the four that is stateful: the value is held per control across frames and approaches whatever the devices report next over the declared time constant. A control that leaves its context, whose group stands down, or whose gate closes has a neutral target, so it drains rather than cutting — and reports its drop frame when it arrives.

Validation happens before anything registers

Activation reads every child binding, collects every fault across all of them, and raises once with the lot. A map with three broken bindings names all three rather than one per attempt, and a map that fails validation registers nothing — a half-live map is worse to debug than one that refused to come up.

Exports

  • M.activate(mapRef, label?) -> { [name]: Handle } — activate a map, return its handles. label names this activation in M.live().
  • M.deactivate(mapRef) -> boolean — release a claim on a map.
  • M.live() -> { { guid, name, group, suppresses, suppressedBy, holders, heldBy, bindings } } — every live map in activation order. What tells an author why two sticks are on screen, or why the controls they activated answer to nothing, or who is holding the map standing them down.
  • M.bindings() -> { { map, group, name, label, kind, context, suppressedBy, subscribers, record } } — every live binding in activation order. The touch overlay builds from this, so what is on screen is exactly what some awake component asked for and nothing is standing down.
  • M.suppressed() -> { [group]: mapName } — which groups are standing down and what put each one down.
  • M.has(name) -> boolean — whether a named control is live anywhere.
  • M._advance(dt) — one tick of dispatch; wired into Zin.tick.
  • M._childBindings(mapRef) -> { ref } — the map's .inputBinding children, in name order.
  • M._reset() — test-only: drop every live map without firing anything.

Types:

  • Handle = { onInput, onPressed, onReleased, onChanged, label, kind } — a thin view over the binding asset's own event facade, so a subscription made through a handle is the same one ref.events.input:connect would make and ends the same way.

Interface

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

conforms to

zero/source-extract/v2

ZinputScheme Module The live set of activated input maps, and the per-frame dispatch that turns their bindings into the events a controller subscribed to. Backs `Zin.scheme`. Nothing is live until something activates a map. A controller holds an `inputMap` ref, activates it in `awake()`, and releases it when it goes away; the live binding set is exactly the union of what currently-awake components asked for. An empty world has an empty input surface and an empty screen. Several maps can be live at once, and they COMPOSE: the live surface is the union of what every holder asked for. That is the shape a game needs — picking up a gun adds a Fire button beside the movement stick rather than replacing the scheme, and dropping it takes only Fire away. Composition alone cannot say "not while this is happening". Sitting in a car, the on-foot jump has to stand down; with a menu open, nothing in the game may answer at all. `group` and `suppresses` are that direction: a map names the group its controls belong to, and the groups it stands down while it is live. A suppressed map keeps its holders, its handles and its subscriptions — it stops reading devices and its buttons leave the screen — so whoever activated it is untouched and it resumes the moment the suppressor releases. A car can therefore stand down walking without owning the walk map, and the car is still there after the player gets out. Declaring neither field composes with everything, which is what a map that is the only thing a world runs should do.

generation( ) → number

A counter that changes whenever the live set of maps changes. Cache a view of the live bindings against it rather than rebuilding one every frame.

examples

if gen ~= Zin.scheme.generation() then print("the input scheme changed") end

frameIdNow( ) → number

The engine frame the tick is running in, or -1 where no engine frame counter is reachable.

subscribersOf(state: any) → number

How many subscribers one control's own asset holds.

argtypedescription
stateany

recordFired(entry: any, name: string, state: any, class: string) → void

Record that a binding fired, tagged with the device class that drove it, so a test can tell "the action ran" from "the action ran from the device I was testing". The record belongs to the map's own declaration of the control rather than to the name, so a name two live maps both declare keeps one record each and the count of one never lands on the other. `subscribers` and `delivered` come from the same fact `recordOutcome` writes into the tick's record, so "it fired" and "something received it" are one answer: `subscribers` is what the control had on its most recent firing frame, and `delivered` says some firing frame reached one.

argtypedescription
entryany
namestring
stateany
classstring

neutralFor(kind: string) → any

The neutral value each kind reports on the frame it goes inactive.

argtypedescription
kindstring

isActive(kind: string, value: any) → boolean

Whether a value is anything other than its kind's neutral: a held button, an axis off centre. What makes a control report itself active, and what the drop frame is measured against.

argtypedescription
kindstring
valueany

valueChanged(kind: string, a: any, b: any) → boolean

Whether two binding values differ. Vectors compare componentwise; the rest compare directly.

argtypedescription
kindstring
aany
bany

classBindings(record: any, class: string) → void

Read one device class's bindings off a record. A button carries an array; an axis carries one binding. `false` means the class is suppressed on purpose.

argtypedescription
recordany
classstring

inFrameUnits(binding: any, v: number, dt: number) → number

Bring one class's reading into the unit the control is measured in. `as = "delta"` marks a binding that reports a HELD position — a stick — driving a control measured in movement. Integrating over the frame turns the position into the distance it stands for. `scale` marks a binding that already reports movement but counts it in its own units — a pinch in pixels next to a wheel in notches — and is a plain multiplier, because there is nothing to integrate. Together they let a stick, a mouse, a wheel and a finger all reach the consumer in one unit, so one sensitivity covers every device.

argtypedescription
bindingany
vnumber
dtnumber

shaped(record: any, kind: string, value: any) → any

Condition the reading an axis control's classes produced, the way the control's own record asks for: `deadzone` (radial over the pair for an axis2), then `curve`, then `invert`. The maths is `Zin.utils`', shared with the axis registry, so a control and an axis declaring the same numbers read the same. Shaping lands on the COMBINED reading rather than per class, after `as` / `unitsPerSecond` / `scale` have brought every class into the control's own unit — which is the unit a deadzone is written in. A control declaring none of the three is handed straight back.

argtypedescription
recordany
kindstring
valueany

readClasses(record: any, dt: number, surface: string?) → any

Read every device class a binding record carries, in the unit the control is measured in, WITHOUT the control's own shaping. Returns the combined reading; `shaped` turns it into what the control reports. Every class is consulted rather than a "primary" one, because a session can carry more than one at a time — a tablet with a keyboard attached, a desktop with a pad plugged in — and the control should answer to whichever the player actually used.

argtypedescription
recordany
dtnumber
surfacestring?

gateAllows(record: any) → void

Whether a control's own gate lets it read at all this frame, and what happened if it did not. Mouse-look is the reason gates exist: a mouse always has a delta, so without a gate the camera turns whenever the cursor crosses the window. The gate says "the player is steering" — pointer locked, a finger dragging, a stick pushed, or the right button arming on the terms the scheme states — and everything else is cursor movement that happens to be over the viewport. `Zin.arming` writes that predicate, which is why every shipped look control declares it in one line rather than in a copy of the test. Returns `true` when the control may read, and otherwise `false` plus the reason: the gate answered no, or the gate itself raised.

argtypedescription
recordany

approach(current: number, target: number, dt: number, tau: number) → number

Internal: one component's approach, come to rest once it is within `SETTLE` of where it is heading.

argtypedescription
currentnumber
targetnumber
dtnumber
taunumber

smoothed(state: any, record: any, target: any, dt: number) → any

Carry a control's reading toward the value its devices produced, over the time constant it declares. The state is per control and lives across frames, so a stick released mid-turn coasts to a stop rather than snapping to centre — and a control out of context, standing down, or refused by its gate drains toward neutral the same way, which is what makes a context switch a hand-off rather than a cut. A control declaring no `smoothing` is handed its target unchanged.

argtypedescription
stateany
recordany
targetany
dtnumber

declarationOf(mapRef: any, mapName: string) → void

Read a map's own declaration: the group its controls belong to, the groups it stands down while live, whether it takes the cursor, and the surface whose keys its controls read. A map that declares no group belongs to a group named after itself, so it collides with nothing and is still nameable by something that wants to stand it down. A map that declares no surface is the scene's.

argtypedescription
mapRefany
mapNamestring

suppressedGroupsOf( ) → void

A map that declares `pointerLock` takes the cursor for as long as it is live, its group is not suppressed, and the world is running. A mouse-look control reads a locked pointer as steering, so the map that declares the control is the one that arms it: every holder of that scheme steers on plain mouse movement, whichever component activated it and whether that component is one of the engine's rigs or a world's own. A scheme two components share asks for the cursor once and gives it back when the last of them goes, because the ask is derived from the live set rather than counted. While the world is not running the cursor belongs to the author, so the ask follows the mode as well as the live set. A suppressed map stands down its pointer lock with its bindings: a menu map that suppresses the player's group frees the cursor the player's map took, and the cursor is taken again when the menu map goes. Suppression is derived from the live set, so the live-set changes that restate the ask are the moments it can move. The ask is held under the holder name `Zin.scheme`, its reason naming the maps it is held for, so `Zin.pointer.holders()` answers who has the cursor. The two halves of the ask are decided differently. The ASK is RESTATED every time the live set or the mode moves, rather than skipped because the scheme believes it already made it: the request lives in the engine, anything may hand the cursor back — a world calling `Zin.pointer.unlock()`, the pointer tool — and a scheme that remembered making the ask would then have the cursor to nobody and never ask again. Restating is a queued command that says the same thing twice, which costs a scheme change. The RELEASE is decided against `standing.pointerTaken`, which records that a scheme took the cursor at all: the last holder going down hands back what the scheme took, and leaves alone a cursor a world asked for on its own account. Which groups the live set stands down, each with the map that put it down: the first live map, in activation order, that suppresses it.

syncPointerLock( ) → void

suppressed( ) →

Which groups are currently standing down, and the map that put each one down: `{ [group] = mapName }`. The answer to "the button is gone and the control is live" — a control in a suppressed group reads nothing and draws nothing until whatever suppressed it releases.

examples

local down = Zin.scheme.suppressed()

drivenButton(v: any) → boolean

argtypedescription
vany

withDriven(kind: string, device: any, v: any) → any

Merge a driven value into a device reading of `kind`: a button is held if either holds it; an axis takes whichever reading is further from rest, per component.

argtypedescription
kindstring
deviceany
vany

checkDriven(name: string, kind: string, value: any) → string

The value a control of `kind` takes when driven with `value`, or an error message naming what `kind` takes.

argtypedescription
namestring
kindstring
valueany

anyEdge(record: any, which: string, surface: string?) → boolean

Did any of a button's class bindings fire its press / release edge?

argtypedescription
recordany
whichstring
surfacestring?

anyHeld(record: any, surface: string?) → boolean

Is any of a control's bindings held right now, on any device class?

argtypedescription
recordany
surfacestring?

buildHandle(bindingRef: any, record: any, claim: any) → Handle

Build the handle a controller subscribes through — a thin view over the binding asset's own event facade, so a subscription made here is the one `ref.events.input:connect` would make and ends the same way. An event carries ONE payload table, the shape the asset-event machinery validates and replicates. A handler wants the parts rather than the envelope, so the handle unpacks on the way out: a movement handler reads `(value, dt, active)` while a raw `ref.events` subscriber still sees the table every other asset event carries. The handle belongs to ONE claim — one `activate` call — and hands that claim every connection made through it. Releasing the claim disconnects exactly those and leaves every other holder's subscriptions attached.

argtypedescription
bindingRefany
recordany
claimany

open( ) → void

Subscribing through a claim that was already released would attach a handler nothing can take down again, so the claim is checked BEFORE the connection is made rather than after it exists.

held(conn: any) → any

Record the connection against the claim on the way back to the caller, who still receives it and can disconnect it itself.

argtypedescription
connany

onInput(_: ?, fn: ?) → void

argtypedescription
_?
fn?

onPressed(_: ?, fn: ?) → void

argtypedescription
_?
fn?

onReleased(_: ?, fn: ?) → void

argtypedescription
_?
fn?

onChanged(_: ?, fn: ?) → void

argtypedescription
_?
fn?

callerInstance( ) → string

The script instance whose code is running, when a component script is on the call stack. A claim records it, and a release that names no claim answers to it first: a component that takes the map in `awake` gives up what IT took in `onDestroy`, whichever other holders came and went in between.

callerEntity( ) → string

The entity that component script sits on. A claim reports it beside the instance id: an entity is a place in the scene an author can go and look at, where an instance id names one component's lifetime.

callerSource( ) → string

Where the code that opened a claim stands, as `chunk:line`. The first frame above this module and the ref's forwarder is the activation itself, which is the line to open to find out why a map is up.

describeHolder(claim: any) → string

One holder, in a sentence. A control that goes silent under a suppression names the map standing it down, and a live map is only ever the shape of somebody's activation -- this says whose, and where.

argtypedescription
claimany

closeClaim(claim: any) → void

Disconnect everything one claim subscribed and close it. What a holder connected through its own handles goes down here; a connection the holder already disconnected itself is left alone.

argtypedescription
claimany

retire(entry: any) → void

Take a map whose last holder went out of the live set, with the event runtimes of its controls.

argtypedescription
entryany

releaseClaim(claim: any) → boolean

Release one standing claim, and the map with it when it was the last. Answers whether the claim was standing.

argtypedescription
claimany

newClaim(entry: any, label: string?) → any

Open a claim on a live map: one holder's own handle table, and the list of connections made through it. `activate` hands the handles back, and they are the identity `deactivate` releases by — a map several holders share hands out one claim per holder, each releasable on its own. A claim follows the context that opened it, the way every resource registered from Luau does: a component's claim ends with that component instance (removed, hot-reloaded, or its entity despawned), a module's with the module's next run, and an `execute`'s is listed under it in `scopes.list()` until released. Its entity's destruction releases it too.

argtypedescription
entryany
labelstring?

deriveStates(mapRef: any, mapName: string) → void

Read the map's binding children off the VFS and turn them into the per-control dispatch state the tick reads. Every fault across every child is collected before anything is registered: a half-live map is worse to debug than one that refused to come up, and a map with three broken bindings names all three rather than one per attempt.

argtypedescription
mapRefany
mapNamestring

sameRecord(a: any, b: any) → boolean

Whether two binding records say the same thing, walked to the leaves. A record is what the tick reads to resolve a control, so any difference in it is a different control. A `gate` is a function, and reading a child hands back a closure of its own every time, so two of them are equal here whenever both are functions: identity answers which read produced it, not what the author wrote. The fresh record is taken either way, so the gate the child holds now is the gate the tick calls.

argtypedescription
aany
bany

reconcile(entry: any, fresh: { [string]: any }) → boolean

Bring a live map's controls up to what its binding children now say. The states are edited IN PLACE, so every claim standing on the map follows the edit: a subscription is attached to the binding asset's own events, which the child keeps across the edit, and a holder that has been listening for an hour goes on listening. A control that appeared is added to every open claim's handles; one that went takes its handles with it; one whose record changed answers to what the record now says.

argtypedescription
entryany
fresh{ [string]: any }

activate(mapRef: any, label: string?) →

Activate an inputMap asset: load every `<name>.inputBinding/` child it contains, validate them, add them to the live binding set, and keyed by the binding's name. Every fault across every child is reported in one error, so a map with three broken bindings names all three rather than one per attempt. Activating a map already live adds a holder rather than registering the map twice, so two components sharing one map read one set of controls. Each holder gets its OWN handles: every subscription made through them belongs to that activation, and passing them back to `deactivate` releases exactly those. Every activation reads the map's children again, so a binding added, edited or removed since the map came up reaches the running set here — and reaches the holders already standing on it, whose handles and subscriptions carry on across the edit. `label` names this activation in `Zin.scheme.live()`, beside where it was opened. A probe that takes a map to look at it says so, and the agent whose controls the map suppresses can read who is holding it.

argtypedescription
mapRefanyThe inputMap asset ref.
labelstring?What to call this activation. Optional.

examples

local map = public.inputMap:activate(); map.jump:onPressed(fn)

deactivate(mapRef: any, claim: any?) → boolean

Release one holder's claim on a map, disconnecting every subscription that claim made. The other holders keep theirs, and the map stays live while any of them remains; the last one out also takes the map's controls out of the live set. A claim is the handle table `activate` returned. Hand it back and that activation is what goes. Name none and the caller's own most recent claim goes — a component releases what IT activated, whatever else has taken the map since. A component holding none of them releases nothing; an `execute` holding none of them releases the map's most recent claim. An asset ref is shared by every holder of the same map, so the handles are what say which of them is releasing.

argtypedescription
mapRefanyThe inputMap asset ref.
claimany?The handles this holder's `activate` returned. Optional.

examples

public.inputMap:deactivate(controls)

markBaseline( ) → number

Record the claims standing on every live map right now, as the mark `Zin.scheme.resetToBaseline` takes back to. A caller running work in an engine it shares, such as a sweep of test suites, marks before the work and resets after it.

examples

local mark = Zin.scheme.markBaseline()

resetToBaseline(mark: number) → number

Release every `execute` claim opened since `mark`. A component's claim answers to the component: it goes when the component releases it or when that component instance ends (removed, hot-reloaded, or its entity despawned), whichever comes first.

argtypedescription
marknumberWhat `Zin.scheme.markBaseline` returned.

examples

Zin.scheme.resetToBaseline(mark)

live( ) →

Every live map, in activation order: `{ guid, name, group, suppresses, suppressedBy, pointerLock, surface, holders, heldBy, bindings }` where `bindings` names the controls it contributes, `holders` counts the activations still standing on it, `suppressedBy` names the map standing this one down, if any, `pointerLock` says whether it takes the cursor while the world runs, and `surface` is whose keys its controls read: `"scene"`, the keys pressed while the scene was the active input context, or `"editor"`. What a debug surface lists, and what tells an author why two sticks are on screen — or why the controls they activated answer to nothing. `heldBy` is one record per activation still standing: `{ kind, entity, instance, source, label, holder, subscriptions }`. `kind` is `"component"` for an activation a component script made and `"execute"` for one made from a bare call, `source` is the `chunk:line` it was opened at, and `holder` says the same thing in a sentence. A map that suppresses a group is somebody's activation, and this is whose — the reading an agent whose controls went silent takes to find the activation standing them down.

examples

for _, m in ipairs(Zin.scheme.live()) do print(m.name) end

bindings( ) →

Every live binding, in activation order, as `{ map, group, name, label, kind, context, suppressedBy, subscribers }`. `name` is the control's identity; `label` the words a player reads for it, in their language now. The touch overlay builds its buttons from this, so what is on screen is exactly what some awake component asked for and nothing is standing down.

examples

for _, b in ipairs(Zin.scheme.bindings()) do print(b.label) end

subscriberCount(name: string) → number

How many subscribers a named control currently holds, summed over every live map that declares it. A control can be live, valid and firing with nobody listening. Drawing a button for one offers a player something that cannot do anything — which is the shape of every on-screen control that has ever been reported as doing nothing.

argtypedescription
namestringThe binding name.

examples

if Zin.scheme.subscriberCount("jump") == 0 then ... end

subscriberEpoch( ) → number

Total subscribers across every live control. Which controls are HEARD changes without the live set changing at all — a component activates a map and subscribes a moment later, or drops its last listener while staying awake. A consumer that caches a view of the live set by `generation` alone never sees either, so this is the second half of that cache key.

examples

if gen ~= Zin.scheme.generation() or subs ~= Zin.scheme.subscriberEpoch() then print("the input scheme changed") end

has(name: string) → boolean

Whether a named control is live in any activated map.

argtypedescription
namestringThe binding name.

examples

if Zin.scheme.has("jump") then ... end

_advance(dt: number) → void

One tick of binding dispatch: evaluate every live binding and fire what changed. Wired into `Zin.tick`. `input` fires every frame a binding is active, and once more on the frame it goes inactive carrying the neutral value and `active = false` — so one handler both starts and stops the motion it drives. A button already held when its map comes up reads held from the first tick, so `input` reports it active. Its press came before the control did, so neither the press nor the release of that hold fires `pressed` or `released`; the next press is the control's own. Evaluation is per tick, so smoothing keeps converging when a host runs several ticks inside one engine frame, and `changed` reports each step of it. `input`, `pressed` and `released` are per engine frame: one active call and one of each edge, whatever the tick cadence above it.

argtypedescription
dtnumberSeconds since the previous tick.

examples

Zin.scheme._advance(1 / 60)

scanSettled( ) → boolean

Whether every live control sits at rest, read over every live control.

_settled( ) → boolean

Internal: whether every live control sits at rest -- nothing active, nothing waiting for its holder to release, every smoothed reading at neutral. The tick's quiescence gate reads it: the scan runs again after an evaluation or a change to the live set, and every call between those answers from the last one.

examples

if Zin.scheme._settled() then ... end

_childBindings(mapRef: any) →

Internal: the `<name>.inputBinding/` children of a map asset, as resolved refs in name order.

argtypedescription
mapRefanyThe inputMap asset ref.

examples

local kids = Zin.scheme._childBindings(mapRef)

fired(peek: boolean?) →

Every control that fired since this last cleared, with how many engine frames it was active for, which device classes drove it, and what received it. Reading CLEARS the record unless `peek` is true, so two calls around an action answer "did that input reach the game" without a previous test's results bleeding in. One row per LIVE MAP that fired the control, so a name two maps both declare reports each of them under its own map with its own count. delivered }`, sorted by name and then by map. `map` is the map's name and `guid` is that map's own guid, which is what tells two live maps sharing a name apart. `count` is the number of engine frames the control was active, so a button held across two frames reads 2 for one press. The `pressed` / `released` subscriptions are what count edges. `subscribers` is how many the control had on its most recent firing frame and `delivered` says one of those frames reached a subscriber, so a press that landed reads apart from one that reached nothing.

argtypedescription
peekboolean?Read without clearing.

examples

local fired = Zin.scheme.fired()

lastFrame( ) →

What every live control did on the most recent tick: its value, whether it was active, whether that reached a subscriber, how many subscribers it has, and the tick's own answers about context, suppression and its gate. Rebuilt whole each tick and read without consuming, so any number of observers in the same frame all see the same answers. The window is ONE tick — the most recent one — rather than a sum since anything last read. delivered, subscribers, suppressedBy, inContext, heldOnArrival, gateReason, gateError }`, in evaluation order.

examples

for _, c in ipairs(Zin.scheme.lastFrame()) do print(c.name, c.active) end

recording( ) → boolean

Whether the tick is keeping a per-control record of what it did. `Zin.tick` turns it on while something is observing the input layer and off again when nothing is.

examples

if Zin.scheme.recording() then ... end

setRecording(on: boolean?) → void

Keep — or stop keeping — a per-control record of what each tick did. A tick that is not recording still dispatches and still reports its cost; it only stops writing down each control's outcome, which `Zin.observe` can resolve again from live state.

argtypedescription
onboolean?Record (the default) or stop recording.

examples

Zin.scheme.setRecording(true)

advanceCost( ) → any

What the most recent tick of binding dispatch cost, and how much it covered: `{ frameId, maps, controls, ms }`. `ms` is ONE tick's own milliseconds — the same number `profiler.stats("*zin.scheme.advance*")` reports as `script.zin.scheme.advance`, where it also carries the average and the peak across every tick since the engine started.

examples

local cost = Zin.scheme.advanceCost()

entriesFor(name: string) →

Every live map that declares a named control, with the map's own record and the control's dispatch state. The lookup behind per-control questions: a name can be declared by more than one live map, and this answers with all of them in activation order.

argtypedescription
namestringThe control name.

examples

local entries = Zin.scheme.entriesFor("look")

declaredClasses(record: any) →

Which device classes a control declares bindings for, in the order the tick consults them. A control with no binding for the class a player is driving reads nothing from that class no matter what they do.

argtypedescription
recordanyThe binding record.

examples

local classes = Zin.scheme.declaredClasses(record)

classBindings(record: any, class: string) →

Every binding a control declares for one device class, as the tick reads them.

argtypedescription
recordanyThe binding record.
classstringOne of `kbm` / `gamepad` / `touch`.

examples

local kbm = Zin.scheme.classBindings(record, "kbm")

liveControlsNamed(name: string) → void

Every live control named `name`, with the kind it reads.

argtypedescription
namestring

liveControlNames( ) → void

drive(name: string, value: any) → void

Drive a live control directly with the value the game should read — the gameplay intent a game is authored in, rather than the key a map happens to bind. `true` holds a button (`false` lets it go), a number drives a 1-D axis, `{ x, y }` a 2-D one. The value joins the control's device classes like another device: shaping and smoothing apply, press and release edges fire, and a context or suppression that stands the control down stands it down too. It reaches every live map declaring a control of that name, and stays until `Zin.scheme.undrive` lets it go. It touches no device, so a person at the window — a focused panel, the pointer — neither reaches it nor is reached by it. Raises for a name no live map declares, listing the live controls, and for a value the control's kind cannot take. for a 2-D axis.

argtypedescription
namestringThe control's name, as `Zin.scheme.bindings()` lists it.
valueany`true`/`false` for a button, a number for a 1-D axis, `{ x, y }`

examples

Zin.scheme.drive("move", { 0, 1 })  -- walk forward
Zin.scheme.drive("jump", true); Zin.scheme.undrive("jump")

undrive(name: string?) → void

Let go of a driven control — or of every driven control when no name is given. The control reads its devices alone again; a driven button fires its release edge on the next evaluation.

argtypedescription
namestring?The control to let go; nil for all of them.

examples

Zin.scheme.undrive("move")
Zin.scheme.undrive()

drivenControls( ) →

The controls being driven now, each with its driven value.

examples

for name, v in Zin.scheme.drivenControls() do print(name, v) end

advances( ) → number

How many evaluations of the live controls have run since the module loaded. A caller that drove a control waits for it to advance to know an evaluation has read the driven value.

examples

local before = Zin.scheme.advances()

_readClasses(record: any, dt: number, surface: string?) → any

Internal: read every device class a control's record carries, in the control's own unit, WITHOUT its gate and without its deadzone / curve / invert shaping. What the devices produced before the control decided what to do with it.

argtypedescription
recordanyThe binding record.
dtnumberSeconds since the previous tick.
surfacestring?Whose keys to read: `"scene"` (the default) or `"editor"`.

examples

local raw = Zin.scheme._readClasses(record, 1 / 60)

_gateAllows(record: any) →

Internal: run a control's own gate. Returns whether it allows the control to read, and when it does not, which of `gateRefused` / `gateErrored` happened and the error text if one was raised.

argtypedescription
recordanyThe binding record.

examples

local ok, why = Zin.scheme._gateAllows(record)

neutralFor(kind: string) → any

The neutral value for a control kind: `false` for a button, `0` for an `axis1`, `{ x = 0, y = 0 }` for an `axis2`. What a control reports when it is not delivering.

argtypedescription
kindstringThe control kind.

examples

local rest = Zin.scheme.neutralFor("axis2")

valueIsActive(kind: string, value: any) → boolean

Whether a value of the given kind is anything other than that kind's neutral — a held button, an axis off centre.

argtypedescription
kindstringThe control kind.
valueanyThe value to test.

examples

if Zin.scheme.valueIsActive("axis1", v) then ... end

liveCount( ) → number

How many maps are live right now.

examples

if Zin.scheme.liveCount() == 0 then ... end

drivingClass(record: any, surface: string?) → string

Which device class is currently satisfying a binding, or nil when nothing is. Used to tag what `fired` reports.

argtypedescription
recordanyThe binding record.
surfacestring?Whose keys to read: `"scene"` (the default) or `"editor"`.

examples

local class = Zin.scheme.drivingClass(record)

_reset( ) → void

Test-only: drop every live map without firing anything.

examples

Zin.scheme._reset()
⌬ Types
Handle = {

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.

73+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
# entity_signals Per-entity destroy signals, surfaced on the entity proxy as `entity(id).onDestroying` and `entity(id).onDestroyed`, plus the dispatch the despawn pipeline calls to fire them. ```lua local boss = entity.find("Boss") boss.onDestroying:Connect(function() -- runs BEFORE teardown — final state is still readable saveBossStats(boss.component.get("Combatant").public) end) boss.onDestroyed:Connect(function() log.info("boss fully cleaned up") end) entity.despawn(boss.id) -- onDestroying fires, then teardown, then onDestroyed ``` ## Order `onDestroying` and `onDestroyed` are `Signal`s (see `signal.module`), created on first access. The despawn pipeline drives the order. For a cascade rooted at one `entity.despawn(root)` call: 1. `onDestroying` fires across the whole subtree, root first — before any component teardown, so handlers read final state. 2. components tear down (`onDestroy(self)` per component), leaves first. 3. `onDestroyed` fires per entity as it is removed, leaves first. `onDestroying` handlers must not yield, and the entity is frozen against reparenting / re-mutation during the destroying window. An entity nobody observes costs nothing and fires nothing. ## Entity-keyed tables A module that keeps per-entity state for something to read every frame (a registry a render feature walks, a set of marked entities) declares its table with `entityKeyed`. When an entity is despawned, by `entity.despawn`, a parent's cascade, a scene rebuild or reload, or a mode flip, its id leaves every such table, so the reader only ever meets entities in the world and its cost follows them. ```lua local EntitySignals = require("@builtin::modules.entity_signals") local marked = EntitySignals.entityKeyed({}) function M.mark(id: string) marked[id] = true end ``` The table is one of the engine's own records: a module-state restore leaves it as it stands, so an id that left it stays out.
▲ 0↑ born
▣
module · born here
❒asset
# asset_events Per-asset runtime for declared asset events. An assetType's `behavior.luau` declares an `events` schema the same way a component declares one; this module turns that schema into the live objects an asset's ref fires and listens on. ## Three faces, one Signal — keyed by the asset The construction is `component_events`': one `Signal` per declared event, reachable through a private fire-capable table, an owner-side emitter the type's own behavior fires with, and a subscribe-only facade every other holder of the ref sees. The facade exposes `connect` / `once` / `wait` and has no `fire` at any key, so firing authority stays with the type. What differs is the owner. A component event belongs to one instance on one entity; an asset event belongs to the **asset**, so the runtime is keyed by the asset's stable guid. Every resolver of that guid subscribes to the same Signals, and a ref that is reclaimed and re-resolved re-attaches to the subscriptions already there — the same reason `asset_ref`'s `runtime` table is guid-keyed rather than stored on the envelope. Both tables reject an undeclared event name: the private table's metatable raises on a bad key and the facade raises on a bad key, so a typo surfaces at the subscribe call instead of returning nil. ## Declaring events on a type ```lua -- <name>.assetType/behavior.luau local M = {} M.events = { changed = { payload = { value = Field.number(0, NoSync) } }, } M.ref = { poke = function(self) local emitter = require("@builtin::assetTypes.assetType.shared.events").emitter(self.guid) if emitter ~= nil then emitter.changed:fire({ value = 1 }) end end, } return M ``` ```lua -- any holder of the ref local ref = asset.resolve("@builtin::…") ref.events.changed:connect(function(p) print(p.value) end) ``` ## Exports - `M.forAsset(guid, eventSchema)` — the runtime for one guid, built on first use and reused after. A later call with a different schema reconciles: surviving events keep their Signal and their subscribers, new events get a fresh one, removed events are disconnected and dropped. - `M.facade(guid)` — the subscribe-only view, or nil before a runtime exists. - `M.emitter(guid)` — the owner-side `:fire` view, or nil before a runtime exists. - `M.has(guid)` — whether a guid holds a live runtime. - `M.teardown(guid)` — drop one asset's runtime, disconnecting subscribers. - `M.teardownAll()` — drop every runtime. Called on an engine mode flip so a play-mode subscription does not survive into edit. - `M.liveGuids()` — every guid holding a runtime, sorted. ## Notes - Subscriptions made through the facade are ordinary `signal.module` connections and disconnect the same way any other does. - The runtimes table is held strongly, and its lifetime is bounded by the mode flip that clears it.
▲ 0↑ born
▣
module · born here
❒asset
# context The input context stack. Pushing a named context ("ui", "menu", "vehicle", ...) stands down everything whose declared context doesn't match the top of the stack; popping restores the previous mode. The bottom is permanently `"default"` so unbalanced pops never leave the stack empty. A control, an action, an axis or an event subscriber can declare one context. `Zin.scheme` honours it on every live binding, so a vehicle-context Brake neither fires nor draws its touch button while the default context is on top. A map standing another map's `group` down is the coarser instrument beside this one: `group` / `suppresses` on an `.inputMap` decides which whole schemes answer, while a context decides which entries within a live scheme do. ## Exports - `M.default() -> string` — the always-on context name (`"default"`). - `M.push(name: string)` — push a context. No-op when `name` is not a non-empty string. - `M.pop() -> string?` — pop the top context; returns `nil` when only `default` remains. - `M.current() -> string` — name at the top of the stack. - `M.contains(name: string) -> boolean` — true if `name` is anywhere in the stack. - `M.stack() -> { string }` — a copy of the live stack, bottom→top. - `M.reset()` — pop everything except `default`. - `M.with<T...>(name: string, fn: () -> T...) -> T...` — run `fn` with `name` pushed, pop guaranteed. ## Usage ```luau local Zin = require("@builtin::modules.zinput") -- menuClose.inputBinding/init.luau declares `context = "ui"`, so it reads -- only while "ui" is on top. Zin.context.push("ui") Zin.context.current() -- "ui" Zin.context.pop() Zin.context.with("ui", function() -- inside this block the "ui" controls are the ones that read end) ``` ## Notes - The stack lives in the module's upvalues, so it persists across Luau script runs that share the require cache. A `restart_instance` resets it (matches the standard caching contract). - Pushing the same context twice requires two pops to fully remove — matches typical UI nesting (a sub-menu pushes "ui" again). - A declared context is compared strictly equal to `current()`; there's no inheritance up the stack.
▲ 0↑ born
▣
module · born here
❒asset
# surface Active input-surface classification. Answers "what device class is the player using right now" — `"touch"` or `"kbm"` — and notifies on change; backs `Zin.surface`. Virtual touch controls mount whenever the surface is `"touch"`, in edit and play alike. ## The frame rule Resolution runs once per engine frame from the `Zin.tick` pipeline: a per-event observer collects which device classes produced events this frame, and the frame resolver applies one rule — **touch wins a frame that contains any touch event**. The primary touch contact also drives the mouse path (a projected `mouse.down`/`move`/`up` in the same frame), so classifying by the latest single event would flip to `kbm` on every tap; the frame rule keeps projection-generated mouse events from masking the touch that caused them. ## Capability default Before any input arrives, the class defaults to `"touch"` on sessions with a touch device (`touch_capable` — latched by a device's first contact or declared at boot by Android / the web client) and `"kbm"` otherwise, so touch-first devices present touch controls from the first frame. ## Simulated contacts A contact a script simulates (`inputSim`, `Zin.test.touchStart`) presents the session as `"touch"` while it is on the glass. Once the last simulated contact lifts, the class is the one it would be had the contact never been made: what device input last resolved, else the capability default, and `onChange` reports the return. A desktop a test or an agent taps on keeps presenting as keyboard and mouse, and its touch overlay comes down with the contact. A test that checks a whole touch session on a desktop declares one with `input.simulateTouchCapable(true)` (and `false` to take it back); a suite's input baseline puts the declaration back when the suite ends. ## Exports - `M.current() -> string` — the active surface class, `"touch"` or `"kbm"`. - `M.onChange(fn: (string, string?) -> ()) -> number` — subscribe to class flips; `fn(now, prev)` where `prev` is the previously reported class (the first-tick capability default when no event had resolved yet). Returns a handle. - `M.off(handle: number) -> boolean` — unsubscribe an `onChange` handle. - `M._beginFrame()` — internal: clear this frame's per-class flags; wired by `Zin.tick`. - `M._observeEvent(ev: any)` — internal: per-event observer; wired by `Zin.tick`. - `M._resolveFrame()` — internal: resolve this frame's class and fire `onChange` on a flip; wired by `Zin.tick`. - `M._reset()` — test-only: clear resolution state and subscriptions. Types: - `SurfaceClass = "touch" | "kbm"` ## Usage ```luau local Surface = require("@builtin::modules.zinput.surface") if Surface.current() == "touch" then showTouchOverlay() end Surface.onChange(function(now, prev) print("surface flipped to", now) end) ``` ## Notes - `onChange` fires from the `Zin.tick` pipeline on the frame the class flips; without a tick, resolution never advances and `current()` keeps returning the capability default. - The change signal compares against the last reported class, whose initial value is the capability default captured on the first tick of the session — a phone's first contact confirms the default silently, while a desktop touchscreen's first contact reports kbm→touch. - Handler errors during `onChange` dispatch are caught and logged, not propagated.
▲ 0↑ born
▣
module · born here
❒asset
# engine_records The engine's own records: the tables a subsystem keeps as its account of what stands in the running engine, and the classes whose every instance is one. The input maps activated, a signal's handlers and connections, the entity and asset event registries and the renderer's registry of live features are records; each follows whoever holds the thing it records. `declare(t)` makes a table a record, `declareClass(mt)` makes every table carrying that metatable one, and `holds(v)` answers whether a value is a record. `engine.snapshotModuleState` carries a record by reference without walking it, and `engine.restoreModuleState` leaves it as it stands, so what went away since a reading stays away and what arrived stays in place. A leaf with no requires, so a module that loads before the `engine` global exists declares its records as it loads.
▲ 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
# pointer Pointer lock: who asks for it, and what the engine made of the ask. Wraps the internal `__zero_input.requestPointerLock` / `releasePointerLock` primitives and backs `Zin.pointer`. The ask is held by named holders, and the engine's request stands while any holder does. The scheme holds it as `Zin.scheme` for the live, unsuppressed maps that declare `pointerLock`; a `Zin.controllers` free or fps controller holds it for itself; an ask that names no holder is held as `Zin.pointer.lock`. ## Exports - `M.lock(holder?, reason?)` — ask for pointer lock (cursor grab + hide) under `holder`. Asking again under the same name restates the request and replaces the reason. - `M.unlock(holder?)` — withdraw `holder`'s ask; the cursor is released once no holder is left. With no holder, every ask goes and the cursor is released. - `M.holders() -> { { holder, reason } }` — who is asking, in the order they first asked. - `M.holds(holder) -> boolean` — whether `holder` is asking. - `M.requested() -> boolean` — whether the engine's request stands (`Zin.state.pointerLockRequested()`). - `M.locked() -> boolean` — whether the surface granted it (`Zin.state.pointerLocked()`). - `M.status() -> { requested, locked, suppressed, armed, holders, why }` — all of it in one read; `suppressed` is the cursor belonging to the person (gameplay paused, or the editor sharing the window with no scene picture on it), `armed` a click having armed the capture, and `why` a sentence saying which answers. Each read leaves the input observation as it stands. ## Usage ```luau local Pointer = require("@builtin::modules.zinput.pointer") Pointer.lock("myGame.aim", "the aiming camera steers with the mouse") print(Pointer.status().why) Pointer.unlock("myGame.aim") ``` ## Notes - The request records intent; the cursor is captured once the surface is active. Native: the window is focused and clicked. WASM: the next user gesture (browser policy). Escape or focus loss releases the capture and the next click takes it again. - `requested()`, `locked()` and the engine's half of `status()` read the input snapshot the engine publishes once a frame, so an ask reads there from the frame after it; `holders()` answers at once. - A request written around `Zin.pointer` (a simulated device event, a device reading put back) is the engine's alone: `requested()` can stand with `holders()` empty, and `status().why` says so.
▲ 0↑ born
▣
module · born here
❒asset
# quiesce The dirty signal `Zin.tick`'s quiescence gate reads. A mutation of the mapping layer's structure outside the tick itself — a map activation, a context change, a virtual-control write, a forced surface class, a new axis over an already-held key — calls `mark()`, and the tick runs a full pass while a mark is pending. A tick with no pending mark and no live input events skips its pass. `mark()` raises the signal, `pending()` answers whether a full pass is owed, and the generation pair (`generation()` / `ack(g)`) keeps a mark raised DURING a full pass pending for the next one, so a mutation racing a tick is never lost. Internal to the zinput package: the mapping-layer modules mark it, the tick drains it.
▲ 0↑ born
▣
module · born here
❒asset
# signal Event primitive. A producer holds a `Signal`; consumers attach handlers with `:Connect` and the producer invokes them with `:Fire(...)`. ```lua local Signal = require("@builtin::modules.signal") local hit = Signal.new() local conn = hit:Connect(function(dmg) print("hit for", dmg) end) hit:Fire(10) -- runs every handler with (10) conn:Disconnect() -- detach this handler ``` ## API - `Signal.new() -> Signal` - `signal:Connect(fn) -> Connection` — attach a handler; runs on each `:Fire` in attachment order. - `signal:Once(fn) -> Connection` — fire at most once, then self-disconnect. - `signal:Wait() -> ...` — yield the calling coroutine until the next `:Fire`, returning its arguments. Call from inside a coroutine (e.g. a `task.spawn` body). - `signal:Fire(...)` — invoke every handler with the arguments. A handler that raises is caught and logged; the rest still run. - `signal:DisconnectAll()` — detach every handler. - `connection:Disconnect()` — detach one handler (idempotent). - `connection.Connected` — boolean, false once disconnected. Handlers run synchronously and must not yield. The connection list is snapshotted before a fire, so a handler may disconnect itself or others mid-fire without skipping a handler. ## Auto-cleanup A connection made while a script component is on the call stack is tagged with that component instance and its entity, and it ends with whichever goes first: - Removing the component from its entity (`component.remove`), or hot-reloading it, disconnects every connection the instance made. - Destroying the entity disconnects every connection it sourced, after the entity's `onDestroyed` fires, so a component's handler on its own entity's `onDestroyed` still runs after the component's `onDestroy` (driven by the entity-destroy dispatch in `entity_signals.module`). A component never has to track and tear down its own connections.
▲ 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
▣
module · born here
❒asset
# bindings Binding primitives and evaluators. A binding names which physical input satisfies a control on one device class — the value a `.inputBinding` record's `kbm` / `gamepad` / `touch` field holds. A binding is a plain descriptor table (e.g. `{ kind = "key", code = "KeyW" }`); the evaluators (`evalHeld`, `evalPressed`, `evalReleased`, `evalAxis`, `evalVector`) dispatch on `kind` and read `Zin.state` / `Zin.virtual` to produce the live signal. `Zin.scheme` runs them once per tick for every live binding, and they are public so chords, axes and library authors can evaluate a binding without reimplementing the dispatch. ```luau -- boost.inputBinding/init.luau local B = require("@builtin::modules.zinput.bindings") return { label = "Boost", kind = "button", kbm = { B.key("ShiftLeft") }, gamepad = { B.padButton("left_shoulder") }, touch = { B.touchButton({ zone = "right-lower" }) }, } ``` ## Two frames, and which binding speaks which - **Stick bindings** (`vector`, `touchStick`, `padStick`) report the direction the player *means* — forward is `+y`. A `move` control carrying a keyboard class and a stick class drives both devices the same way. - **Delta bindings** (`mouseDelta`, `touchDrag`, `scroll`) report movement that happened — down is `+y`, because that is what the pointer did. They also differ in magnitude: a stick is a position bounded at 1.0, a delta is however far the device moved this frame. A control carrying both — look, zoom — declares `as = "delta"` on its held class with the `unitsPerSecond` a full deflection is worth, and `scale` on a delta class that counts in its own units (a pinch in pixels beside a wheel in notches). `Zin.scheme` applies both, so one sensitivity covers every device. ## Exports Keyboard and mouse constructors: - `M.key(code: string) -> Binding` - `M.mouse(button: string) -> Binding` — `"left"` / `"right"` / `"middle"`. - `M.modKey(spec: string) -> Binding` — `"Ctrl+S"`, `"Shift+Alt+P"`, `"Escape"`. - `M.axis(plus: Binding, minus: Binding, opts: StickOpts?) -> Binding` - `M.vector(right, left, up, down: Binding) -> Binding` - `M.wasd() -> Binding` - `M.arrowKeys() -> Binding` - `M.mouseDelta(axis: string?) -> Binding` — this frame's mouse delta. - `M.scroll(axis: string?) -> Binding` — scrollwheel delta. - `M.pointerLocked() -> Binding` — boolean, true while locked. Touch constructors (fed by `Zin.virtual`, which the on-screen controls write): - `M.touchStick(opts: { zone, axis? }) -> Binding` — vector. - `M.touchButton(opts: { zone?, label?, icon?, priority?, size?, group? }) -> Binding` — boolean. - `M.touchDrag(opts: { zone, axis? }) -> Binding` — per-frame delta vector. - `M.touchPinch(opts: StickOpts?) -> Binding` — scalar pinch delta. Gamepad constructors (addressed by canonical position, or by the device's own 0-based element index for a wheel, pedals, a flight stick or any element past the canonical layout; `slot` names one pad by number or a device by a piece of its name, omitting it means any connected pad; `rest` / `full` calibrate an axis so `rest` reads 0 and `full` reads 1): - `M.padButton(button: string | number, slot: (number | string)?) -> Binding` - `M.padAxis(axis: string | number, opts: PadAxisOpts?) -> Binding` - `M.padStick(stick: string, opts: StickOpts?) -> Binding` - `M.padTrigger(trigger: string, slot: number?) -> Binding` Predicates: - `M.isBoolean(b) -> boolean` - `M.isAxis(b) -> boolean` - `M.isVector(b) -> boolean` Evaluators: - `M.evalHeld(b) -> boolean` - `M.evalPressed(b) -> boolean` - `M.evalReleased(b) -> boolean` - `M.evalAxis(b) -> number` - `M.evalVector(b) -> Vec2` Pretty-printers: - `M.format(b: any) -> string` — single binding ("Space", "Ctrl+S", "WASD"). - `M.formatAll(bindings: any?, sep: string?) -> string` — joined summary; non-table arg returns `"<no bindings>"`. Types: - `Binding = { [string]: any }` — descriptor table with `kind` plus type-specific fields. - `Vec2 = { x: number, y: number }` - `StickOpts = { slot: number?, as: string?, unitsPerSecond: number?, scale: number? }` ## Notes - Bindings are pure data tables — they serialize cleanly, compare with `Json.encode`, and have no metatables. - `modKey` normalises modifier order in `format()` so a key written as `Shift+Ctrl+KeyS` displays the same as `Ctrl+Shift+KeyS`. The internal `mods = { ctrl, shift, alt }` flags are the canonical representation. - Mouse-delta, scroll, drag and pinch values are raw physical deltas, not clamped to `[-1, 1]`. `as = "delta"` + `unitsPerSecond` on the stick class beside them is what puts every class in one unit. - `as = "delta"` needs `unitsPerSecond` and has no default: the number that makes a pad feel right is the point of declaring the conversion, and a default would be right for one control and quietly wrong for the next. - Reading a member this module does not have raises immediately, naming the nearest members and the full list — a wrong guess at a constructor surfaces at the call rather than as `attempt to call a nil value` later. - `format()` always returns a string, never throws — returns `"<invalid>"` for malformed input.
▲ 0↑ born
·
assettype · born here
❒asset
# assetType (asset type) An asset type says what a kind of asset is: the files an asset of the kind is made of, the code that gives it behaviour, the interface a person uses to work with it, and how it is found, pictured and checked. A `<typename>.assetType/` folder declares a type called `<typename>`, and every `<name>.<typename>/` folder is an asset of it. `assetType` is itself a type, so a type is an asset like any other: it is created, versioned, installed and contributed the same way. ## Making a type `asset.create("assetType", "<typename>")` scaffolds a type. The type registers the moment its folder is written, anywhere under `/zero/source/`, and from then on `<name>.<typename>/` folders are its assets. An asset of a type that is not registered yet is not an asset, so make the type first. A type folder is a root: `~.x` in any file inside it names the type's own `x`, wherever the type is installed. Keep the type's whole implementation inside its folder and reach it that way. What a type folder must hold is set by this type's own `type.yaml`, the same way every type's `type.yaml` sets what its assets hold. `asset.validate` on a type reports anything missing, and the scaffold produces a folder that passes. ## What sets your type's schema (`type.yaml`) `type.yaml` is the structural contract every asset of the type is checked against. The keys below are the ones the engine reads; a key not listed here is ignored. | Key | What it controls | |---|---| | `suffix` | The folder suffix of the type's assets. Defaults to `.<typename>`. | | `primary` | The file or files that are the asset's content: what the asset resolves to when it is used. | | `entry_files`, `primary_aliases` | Further files that load as the asset or share its identity. | | `is_container` | Whether the suffix stays in the identities of what the asset holds. | | `is_opaque_walker` | Whether a walk of the tree stops at the asset and registers only its primary. | | `plural_dir`, `classify_exts` | Loose files in a folder of this name, or with these extensions, are assets of the type. | | `is_text_default` | Whether the asset's files are text unless stated otherwise. | | `broadcasts_subassets` | Whether assets nested inside an asset of the type are found by their own short name. | | `root` | `true` makes every asset of the type a root, so `~.x` inside one names that asset's own `x`. | | `contract_ref: { field, category }` | A key of the primary file that names another asset the asset is built on. | | `files: { required, optional }` | The files an asset holds (below). | | `allow_unlisted` | `false` reports every file the type does not declare. | | `aliases_from: [{ file, key }]` | Further names an asset answers to, read from its own files. | | `settings:` | Typed per-asset settings (below). | | `inspector:` | The interface people use for the type and its assets (below). | | `preview:` | How an asset is pictured (below). | | `references:` | Names of other assets the type's files carry (below). | | `indexing:` | What search reads for each asset (below). | | `describe:` | How a missing description is generated (below). | ### The files an asset holds Each entry under `files.required` or `files.optional` is `{ path, kind: file | folder, one_of_group?, content? }`. `*` in a path matches within one segment. Entries that share a `one_of_group` are satisfied by any one of them. `content` lists checks on the file's bytes: | Check | Passes when | |---|---| | `non_empty` | the file has content | | `json_field { key, type?, non_empty?, accept? }` | the JSON holds the key (a dotted path) with that shape | | `yaml_field { key, type?, non_empty?, accept? }` | the same for YAML | | `described { keys?, headings?, message? }` | the file says what the asset is (see "Ask your assets to say what they are") | Each check takes a `message`, which is what the author is told when it fails. ### Settings `settings: { values, schema: { type | instance, export? } }` gives every asset typed settings. `values` names the file an asset's values live in; `schema.type` declares one schema for the whole type, and `schema.instance` names a file each asset declares its own in. `asset.create` writes the resolved values, and a write to the values file reaches `onChange` with what changed. ## The human side (`inspector.luau`) A type is used by people through its Inspector, and without one the type is usable only from code. The Inspector is the type's interface for a person: for a procedural graph it is the graph editor, for a kit it is the tracking view of what the kit holds and what is still missing. Writing it is part of writing the type. `inspector: { type, instance? }` in `type.yaml` names the files. `type` is the interface for the type itself and for its assets; `instance` names a file an asset may ship to add its own. Each returns: ```luau return { sections = { { id = "graph", title = "Graph", build = function(ctx) ... end } }, replace = { contents = { ... } }, -- replace a default section by id order = { "graph", "contents" }, -- section order } ``` `build(ctx)` receives the asset and builds the section. A section's `title`, and the text its rows carry, is a string or an `i18n.text` value read from a catalog (`i18n.text("inspectors.mesh.title")`), which follows the editor's language. `asset.create("assetType", ...)` scaffolds a working `inspector.luau` to start from. `asset.validate` on a type that names no inspector, or names one that does not load, reports it. ## Say what your type is for (`about.yaml`) Every type carries an `about.yaml` that says what the type is for, in three plain-language texts: ```yaml intent: "Sets the typeface of the text in your game: UI, labels, signs and 3D lettering." function: "A font, from a TTF, OTF or WOFF file, made available to all of Zero's text, including 3D text." usage: "You choose it by name for your UI or your text, and the text appears in that typeface." ``` - **`intent`** is what the type is for in someone's game, in the words a game maker uses. Up to 800 bytes. - **`function`** is how it works today: what an asset of it is made of and what the engine does with it. Up to 1500 bytes. - **`usage`** is what a person or an agent does with one. Up to 1200 bytes. Write about the type as a whole, not one asset of it, and say what it does now. Agents read these texts to learn when to reach for the type and how; people searching find the type by them. The scaffold starts each text with `[[describe]]` and a note on what to write; a text that still starts that way counts as not written. `services describe` can write them. They show up in `asset.inspect` as `detail.about`, in `assetTypeRef:getAbout()`, at the end of the type's `types/<typename>` guide, and at the top of the type's Inspector. ## Ask your assets to say what they are A type can require each asset to carry a description: a file, written by the author or generated, saying what the asset is and what it is for. Declare it with a `described` check: ```yaml files: required: - path: "README.md" kind: "file" content: - { check: "described", message: "Say what this widget is for and where it goes." } ``` A file that is missing, empty or still has a line starting with `[[describe]]` fails the check, and so does a YAML file whose named `keys` are missing or over their `max_bytes`, or a Markdown file missing a named heading. `asset.validate` names the asset, and a push that carries it is refused with `message`. `services describe` finds such assets and writes their descriptions. `describe:` steers what is generated: ```yaml describe: guidance: "Say what the widget shows, what input it reacts to, and where it fits in a UI." examples: - "<identity of an asset of this type whose description reads well>" ``` An example is an asset of your type whose description is a true, written one, never a placeholder and never the asset being described; with none, leave `examples` empty. A type whose assets the model cannot perceive (a sound, a motion) says so in `guidance`, and the description is drawn only from what the asset's own files state. Start the file unwritten in your `template/`: a heading and one line starting with `[[describe]]`, never example content, which every new asset would carry verbatim. A type whose assets say what they are through their own content (a mesh, a texture) declares no check. ## The type's code (`behavior.luau`) `behavior.luau` returns one table. These are the keys the engine reads from it; anything else on the table is the type's own. ### What the type's assets can do | Key | Shape | What the engine does with it | |---|---|---| | `ref` | `{ [name] = function(self, ...) }` | Every function becomes a method on every asset of the type: `ref:name(...)`. | | `modules` | `{ [name] = require(".x") }` | Code the type's assets reach with `asset.containing(__FILE__).modules.<name>`. | | `events` | an events schema | Events an asset fires. Readers subscribe through `ref.events.<name>:connect(...)`; the type fires them. | | `refShapes` | `{ [method] = function(self) -> (typeExpr, source?) }` | The result type of a `ref` method for one particular asset (below). | | `namePattern` | a Lua pattern | The names `asset.create` accepts for the type's assets. Default `^[A-Za-z][A-Za-z0-9_]*$`. | | `derive` | `{ output, module, compute, fingerprint, matches?, required?, timeout? }` | A file computed from the asset when it is committed; a `required` one holds the commit until it lands. | Some `ref` names mean the same for every type, and the engine calls them: - **`instantiate(self, target?, opts?) -> (root, idMap)`**: puts the asset in a scene. Defining it is what makes the type scene-instantiable. Its return is a contract (below). - **`inspect(self) -> detail`**: what `asset.inspect` reports for the asset beyond the common record (below). - **`preview(self, opts)`**: renders the asset's picture; it wins over the type's `preview:` recipe. - **`previewMaterial(self) -> { material }`**: the material a `surface` preview paints. - **`saveDefinition(self)`**: writes the asset's in-memory edits back to its files in edit mode. Some names are answered for every asset before the type is asked, so a `ref` entry of the same name is never reached: `getSource`, `getBytes`, `getText`, `exists`, `deps`, `canInstantiate`, `canPreview`, `preview` (which calls yours when you define one), `meta`, `runtime`, `events`, `typeRef`, `modules`, and the residency flags `has_backing_asset`, `has_runtime_changes`, `cpu_resident`, `gpu_resident`. ### When the engine calls the type | Hook | Signature | When it runs | |---|---|---| | `onCreate` | `(name, opts) -> { [path] = contents }` | On `asset.create`. Returns the files of the new asset, laid over the type's `template/`. Annotate `opts`: its type is the schema `asset.create` checks the caller's arguments against. A `""` key writes a single loose file. | | `onReplace` | `(dest, files) -> files` | On an `asset.create` over an asset already at `dest`, after `onCreate`, so what the author added can be carried into the replacement. | | `onRegister` | `(self)` | Once per asset, when it first registers: when the world loads, on a live `asset.create`, and when an asset arrives later (installed, pulled, synced). This is what makes an asset take effect the moment it is written. | | `onChange` | `(ref, change)` | On every write to a file inside an asset of the type. `change` is `{ path, asset, type, kind, origin }`, plus `settings` and `settingsChanged` for a write to the settings values file; `kind` is `edited` or `seeded`, `origin` is `local` or `remote`. Filter on `change.path`. Writes to one asset arrive in order, each after the hook for the one before has finished, and the hook may wait on what it reads. A write the hook makes inside its own asset arrives later like any other, so keep the hook convergent. | | `onDependencyChange` | `(ref, change)` | When a module the asset's code requires is re-run, or a name the asset carries starts resolving. `change.kind` is `dependency`. | | `onDelete` | `(ref)` | When an asset of the type leaves the world: deleted, or the world it is in is swapped away. | | `validate` | `(ref) -> { { code, message, severity?, path? } }` | On `asset.validate`, after the `type.yaml` checks, for the type's own rules. `severity` defaults to `error`. Runs on every push, so a type's rules hold at publish. A hook that fails reports `validate.hook_failed`. | ### Settings hooks | Hook | When it runs | |---|---| | `settingsDefaults(name, opts, asked) -> table` | Once per `asset.create`, for values the schema's defaults do not give. | | `settingsCorrections(values, name, opts) -> (corrections?, reasons?)` | On every settings write. A correction to a field the writer named refuses the write, giving the reason. | | `settingsDerivedDefaults(values, explicit, changed)` | On a settings write, for fields derived from others. | | `normalizeSettings(values, stored?)` | On every read and write, to map an earlier spelling of a field to the current one. | | `settingsHealed(values, stored)` | On a read, to repair stored values. | | `settingsSchemaProblem(schema, ref) -> string?` | When an asset's own schema is read; a returned string refuses the schema. | `creationInputs` (`{ [opt] = true | selectorOpt }`) names `asset.create` options that are inputs to the type rather than settings. ### Reloading An edit to `behavior.luau` reaches existing assets with no restart. ## How an asset is pictured (`preview:`) | `kind` | The picture is | The type provides | |---|---|---| | `instantiate` | the asset placed in the preview studio through its `instantiate` | `ref.instantiate` | | `image` | a file the asset holds, fitted to the frame | `source: { files }`, the candidate files in order | | `surface` | the asset painted on a mesh | `mesh`, and `ref.previewMaterial` | | `custom` | whatever `ref.preview` returns | `ref.preview` | ```yaml preview: kind: surface mesh: sphere ``` `angle: [yaw, pitch]` turns the camera. The studio owns the light, the backdrop and the framing, so an asset pictures the same in every world. A type with no `preview:` that defines `instantiate` still answers `ref:preview()`. A picture is rendered when something asks to view it (the editor showing the asset, `ref:preview()`), when previews are generated on request (`assets.generatePreviews`), and when the asset is staged. An edit alone renders nothing. The picture records what it was made from, so a stale one is told from a current one. ## The names your type's assets hold (`references:`) Where your type's own format or API carries the name of another asset, declare it here: ```yaml references: keys: # a top-level key of the type's files that holds a name, or a table of them - { key: "shader", type: "shader" } args: # an argument of a call, counting from 1 - { call: "g:node", position: 2, type: "procNode" } fields: # a field of the options table a call takes - { call: "fx.beam", field: "material", type: "material" } ``` `type` is the category the name resolves in. `asset.declareReferenceKey`, `asset.declareReferenceArg` and `asset.declareReferenceField` declare the same from a script. ## What search reads (`indexing:`) `indexing:` is how assets are found. Search reaches an asset only through what its type's `indexing:` names, and adds nothing of its own. That includes you: an asset indexed badly is one you cannot find later, when you are making something else and need it. A type whose assets are never looked for says `indexing: none`. ```yaml indexing: data: # text, read from the asset's files - role: identity extractor: verbatim source: { file: "README.md" } - role: interface extractor: symbols source: { files: ["init.luau"] } - role: implementation extractor: verbatim source: { files: ["init.luau"] } content: # the picture - role: identity modality: image source: { file: "preview.png" } facets: # what a query filters and re-ranks by file: ".metadata" rigged: { type: bool, from: { components: { contains: SkinnedModel } } } roughness: { type: number, filter: range, from: { file: "mat.yaml", field: "floats.roughness" } } ``` **Roles.** Each `data` and `content` entry has a `role`, and a query matches in two slots: - **`identity`**: what an asset is. For anything you look at, the picture; for anything else, the text that says what it is. - **`capability`**: what it does and how it is made. `interface` (the signatures or shape a caller uses) and `implementation` (the body) both count as capability, and a type with code usually declares both. Ask what a person would recognise an asset of the type by, and what it does, and point each role at the file that says it. For text, that is the asset's description: the file your template starts with a `[[describe]]` block, which the author writes or `services describe` fills in (see "Ask your assets to say what they are"). **`data`.** `extractor: verbatim` embeds a file's text as it is; `symbols` embeds the declared signatures of code. `source` is `{ file }` or `{ files: [...] }`. Never index a file name (`source: { field: name }`): one or two words carry nothing to match. **`content`.** `modality: image` embeds the picture itself, so a text query matches what the asset looks like. A type whose assets are looked at makes the picture its identity. **`facets`.** What a query narrows and re-ranks the matches by. `file` is embedded whole, so keys nobody declared in it are still found. Each further key is computed for every asset and states a value for every one, including `false`: a file can imply "not rigged" but never say it, and a query separates rigged from unrigged only because the unrigged ones say `rigged: false`. A key is `{ type: bool | number | enum, filter?: range, from }`, where `from` is `{ file, field }` (a field of one of the asset's files, dotted for nesting), `{ metadata: key }`, or `{ components: { contains | any_outside } }` (what the asset's entities carry). ## What blocks a push A push checks every asset it carries against its type. These refuse it: - a required file that is missing, a `content` check that fails, a `described` file not written yet; - an error from the type's `validate`. Unlisted files and warnings do not. A `described` file blocks only a push that changes the asset. When a push is refused, the message names each asset and what it lacks. `world.publishBlockers()` and `zm status` read the same list without pushing. ## Typing a result from the asset (`refShapes`) A `ref` method whose result depends on the asset (one entry per child folder, per row of a config, per control a map declares) can only be annotated as `{ [string]: Thing }`, which accepts any key. `refShapes` states the result for each asset instead: a function returning a Luau type expression for that asset, and the module whose types the expression uses. Read the asset; never run it. ```lua -- inputMap.assetType/behavior.luau M.refShapes = { activate = function(self): (string, string) local names = {} for _, control in ipairs(M.ref.controls(self)) do table.insert(names, control.name .. ": Handle") end if #names == 0 then return "", "" end return "{ " .. table.concat(names, ", ") .. " }", "@builtin::modules.zinput.scheme" end, } ``` With it, `map.jump:onPressed(fn)` is checked and `map.noexisting` is reported. A per-asset type applies where the call site names which asset: a component field whose default names it, or an annotation `AssetRef<"inputMap", "<identity>">`. `asset.resolve(name, category)` carries only the category, and a name computed at runtime carries nothing, so calls on those keep the declared return. The type belongs to the call's result: index it there, or bind what you need from it there, and the names stay checked. `require("@builtin::assetTypes.assetType.shared.refShapes").published()` shows what was published: `categories` (each type's method surface) and `returns` (per-asset results by identity, then method). An identity missing from `returns` was never published. Results are recomputed when an asset is written; at most 64 assets of one type are read. ## Putting an asset in a scene (`ref.instantiate`) A caller writes one piece of code against every instantiable type, so what `instantiate` returns is fixed: ```lua local Instantiable = require("@builtin::assetTypes.assetType.shared.instantiable") M.ref = { instantiate = function(self, target, opts) local root = Instantiable.root(self, target, opts) -- compose the asset under `root`, now return Instantiable.result(self, root, idMap) end, } ``` **In.** `target` is the entity the asset lands under, or onto for a hierarchy type; with none, the type spawns a new root. `position`, `rotation` (three numbers in degrees, or a quaternion), `scale`, `name` and `temporary` mean the same for every type: `Instantiable.root` applies them to a root you make, `Instantiable.place` to one you adopt. Document any options of your own in the hook's `--!arg` docs. **Out.** `(root, idMap)`. `root` is the composed root, live when you return: build synchronously, never defer to a component's `awake`. `idMap` maps each original id to the spawned one, so a component that composes the asset again on every load can pass it back in and keep references into the composition. Every call goes through `Instantiable.result`, which refuses a root that is not live and turns a missing `idMap` into `{}`. ## Inspecting an asset (`ref.inspect`) `asset.inspect(ref)` builds a record every asset shares (`identity`, `name`, `guid`, `source`, `typeName`, `typeDefinitionPath`, `scope`, `origin`, `description`, `tags`), then calls `ref.inspect(self)` for the type's own `detail`: ```lua M.ref = { inspect = function(self) -- read the asset's own files, never runtime state: inspect works on an asset -- that has not been compiled, uploaded or registered return { --[[ what makes this asset what it is ]] } end, } ``` Without it, the record is the shared part alone, and an agent inspecting the asset learns nothing of what it is. A hook that raises leaves `detail` empty and sets `record.warning`. ## Discovery - `asset.list("assetType")`: every registered type. - `asset.inspect("<typename>")`: the type, its README and its `about.yaml` texts. - `asset.resolve("<typename>", "assetType")`: the type itself.
▲ 0↑ born
▣
module · born here
❒asset
# 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
▣
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
# map A record-shaped map: `Zin.actions` / `Zin.axes` entries organized per device class (`kbm` | `gamepad` | `touch`) with single-parent `extends`, materialized into an EFFECTIVE map and applied as one binding set at a time. Backs `Zin.map`. An `.inputMap` asset with `.inputBinding` children is the map, and `Zin.scheme` is the live set: several maps are live at once and compose, each declaring the `group` its controls belong to and the groups it `suppresses` while live. `Zin.map.bake(name)` writes the map active here out as an `.inputMap` asset, with synthesis made explicit and editable. `man topics/input` covers the control model. Resolution order per action/axis and device class: 1. the map's own class bindings 2. the `extends` parent's (recursively) 3. synthesis from the `kbm` shape (touch class only) A vector `kbm` binding synthesizes a `touchStick`; a boolean `kbm` binding synthesizes a `touchButton`; a vector-shaped `mouseDelta` synthesizes a `touchDrag`; `scroll` synthesizes a `touchPinch`; an `axis`-kind `kbm` binding and a single-axis `mouseDelta` are left unsynthesized (ambiguous which touch shape to guess). A synthesized `touchButton` carries `priority = 100` — an authored `B.touchButton`'s default priority (50) always outranks synthesis on the touch-controls overlay, so a hand-tuned scheme's own layout hints win over whatever filled a gap automatically. A profile record (actions with `bindings`, axes with `binding`) is accepted anywhere a map record is — its bindings are treated as the `kbm` class. ## Activation and the `<axis>@<class>` convention `activate` flattens every class's bindings into each action/axis's single bindings list and applies it through `Zin.profile`, so any device fires the action. For axes — which evaluate exactly one binding — the primary slot is the first of `kbm` / `touch` / `gamepad` present; any OTHER class's binding registers as a class-suffixed sibling axis (`look` + `look@touch`). A consumer that wants both device values reads both names; a kbm-only world's primary axis (`Zin.axes.value("move")`) behaves identically whether or not a touch class exists. `Zin.profile.ensureActive("default")` delegates to `Zin.map.ensureActive()` when the resolved scheme is the builtin default, so it carries every device class rather than kbm alone. `Zin.map.ensureActive()` / `Zin.map.activate` win regardless of call order (`activate` re-registers the flattened profile under the same name and forces a reactivate). ## Exports - `M.materialize(record: any) -> effective map` — resolve `extends` + synthesize, without activating. - `M.activate(record: any) -> effective map` — materialize + apply as the live binding set (registers/activates a `Zin.profile`). - `M.effective() -> effective map?` — the active map's materialized form. - `M.activeName() -> string?` — the active map's name. - `M.bindingsFor(eff, name, class) -> bindings?` — one action/axis's bindings for one device class. - `M.ensureActive() -> effective map` — keep the current map, else activate `@builtin::inputMaps.default`. - `M.bake(name: string) -> AssetRef` — write the active effective map as a new `.inputMap` instance (`asset.create("inputMap", name, { record = ... })`). - `M.addTouchButton(actionName, buttonOpts, emitKey?) -> binding` — add a touchButton binding to an action's touch class on the live effective map (creating the action if absent) and re-activate. Used by `Zin.touchControls.button`. - `M.removeTouchButton(actionName, binding) -> boolean` — remove a binding added via `addTouchButton` and re-activate; drops the action entry once every class is empty. - `M._reset()` — test-only: clear active-map state. ## Usage ```luau local Zin = require("@builtin::modules.zinput") Zin.map.ensureActive() local eff = Zin.map.effective() print(eff.actions.jump.classes.touch ~= nil) -- synthesized or explicit -- Write the active scheme out as a control-asset map: Zin.map.bake("my_scheme") ```
▲ 0↑ born
▣
module · born here
❒asset
# 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
# 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
·
assettype · born here
❒asset
# inputMap assetType A control scheme, expressed as an asset. A `<name>.inputMap/` folder whose `init.luau` returns the map record, and whose **controls are the `<name>.inputBinding/` child folders beside it** — the same containment a `.toolbox` has with its `.tool` children. Containment records the reference, so a scene carrying its map carries every control it declares. ``` racer.inputMap/ init.luau -- what the map is, and how it composes boost.inputBinding/ init.luau steer.inputBinding/ init.luau ``` ```luau -- racer.inputMap/init.luau return { name = "racer", description = "Throttle, steering and boost.", -- The group these controls belong to, and the groups this map stands -- down while it is live. Declaring neither composes with everything. group = "vehicle", suppresses = { "player" }, } ``` Each control carries `kbm`, `gamepad` and `touch`; the `inputBinding` assetType covers the record shape. ## Reading it A controller activates the map it needs and subscribes to the controls it drives. Nothing is live until something asks for it. ```luau public = { inputMap = Field.assetRef("inputMap", "@builtin::inputMaps.default", NoSync, "The controls this component reads."), speed = Field.number(5, NoSync, "World units per second at full deflection."), jumps = Field.number(0, NoSync, "How many times the jump control was pressed."), } local controls function awake() controls = public.inputMap:activate() controls.move:onInput(function(v, dt, active) if not active then return end local p = public.entity.position local step = public.speed * dt public.entity.position = { p.x + v.x * step, p.y, p.z - v.y * step } end) controls.jump:onPressed(function() public.jumps += 1 end) end function onDestroy() public.inputMap:deactivate(controls) end ``` What `activate` returned is this holder's **claim** on the map. Keep it and hand it back: releasing the claim disconnects the subscriptions made through it, and the map stays live for whoever else holds it. A control the map does not declare reads as `nil`, so a typo raises at the subscribe call. A controller written against more than one map tests for an optional control first — `if controls.crouch then controls.crouch:onInput(...) end`. Several maps can be live at once, and the player's surface is the union of them. `group` / `suppresses` are how one map stands another down — a car takes the player over by naming the `player` group, and walking resumes the moment the car releases. `Zin.scheme.live()` reports each live map's `group`, `suppresses` and `suppressedBy`, and `heldBy` — who opened each activation still standing on it, so a control that goes quiet under a suppression leads to the activation doing it rather than to the map. ## Whose keys a map reads A key belongs to the surface it was pressed on. In the editor, where the scene shares the window with panels, the scene holds the keys pressed while it was the active input context: the last click landed in the viewport's picture (on the scene or on the game's own UI drawn there), or play just started. A key pressed after a click on a panel is the editor's, and a game's controls never see it. A map reads the scene's keys unless it declares otherwise: ```luau return { label = "Editor", group = "editor", surface = "editor", -- every key no focused widget took } ``` `surface = "editor"` is for controls that belong to the editor around the scene — its hotkeys, its viewport camera — and answer wherever the author last clicked. Pads and touch belong to no panel and read the same on either surface. `Zin.scheme.live()` reports each map's `surface`. ## Ref methods - `:activate(label?)` — load every `<name>.inputBinding/` child, validate them, add them to the live binding set, and return the handles keyed by control name. Every fault across every child is reported in one error. Activating a map already live adds a holder, so two components sharing one map read one set of controls — each through its own handles, which are the claim it releases by. Every activation reads the children again, so a binding added, edited or removed since the map came up reaches the running set here and reaches the holders already standing on it. `label` names this activation in `Zin.scheme.live()`. - `:deactivate(claim)` — release one holder's claim, disconnecting every subscription that claim made. The map stays live while another holder remains; the last one out takes the controls out of the live set. Name no claim and the caller's own most recent one goes. - `:controls()` — `{ name, label, kind, classes, problems }` per child, read without activating anything, so an authoring tool can show a map's whole surface and everything wrong with it before it goes live. - `:record()` — the raw record its `init.luau` returns. - `:effective()` — the materialized effective map, without activating it. - `:bindingsFor(name, class)` — the bindings a named entry has for one device class in this map's effective form. ## Writing one The `inputAuthor` toolbox writes a map and its controls together, filling in canonical defaults for a control whose name it recognises: ```luau tools.use("inputAuthor", "map", "racer", { "throttle", "steer", "boost" }, { group = "vehicle", suppresses = { "player" } }) tools.use("inputAuthor", "check", "/zero/source/inputMaps/racer.inputMap") ``` `asset.create("inputMap", name, { record = ... })` bakes a record into both shapes a map is read in — `init.luau` beside one `<name>.inputBinding/` child per entry, each carrying all three device classes, a class the record had nothing for written as `false` with the reason beside it. That is the hook `Zin.map.bake(name)` drives to turn the active effective map into an editable asset. The engine's built-in schemes live under `@builtin::inputMaps.<name>`; `asset.list("inputMap")` lists them with every other map. ## In the Inspector Controls: whether this map is the one taking input now, how many controls it declares, and each control's name, label, kind, device classes and problem count.
▲ 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
backing path · modules/zinput.module/scheme.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.