# argForm
<!-- zero:scaffolded-readme -->
<!-- Replace the line below with what this module provides and who
consumes it, then delete both comment lines. -->
TODO: describe this module.
# assetBrowser
<!-- zero:scaffolded-readme -->
<!-- Replace the line below with what this module provides and who
consumes it, then delete both comment lines. -->
TODO: describe this module.
# edui.widgets.controls
edui's own interactive controls, drawn on the `ui.*` canvas substrate (paint
commands + pointer/key/scroll events) rather than the generic `ui.*` widgets, so
an editor control looks and behaves like an editor control and enforces its
type.
`Controls.make(W)` binds them to the widgets barrel and returns:
- **`numberField(P, o)`** — a numeric field that only ever holds a number. Drag
the value to scrub, scroll to nudge, double-click to type digits (letters
can't enter); an optional ▲▼ stepper sits on the right. `o = { value,
onChange, key, readOnly, width?, stepper? }`.
- **`boolToggle(P, o)`** — a pill/knob toggle switch, distinct from a checkbox.
`o = { value, onChange, key, readOnly }`.
Canvas paint points are POSITIONAL `{x, y}` arrays. Interaction payloads arrive
as the value the edui app unwraps from the engine event envelope (`d.dx`/`d.dy`
for drag/scroll).
# edui.document
One open document in an editor panel. `edui.document.new{ id }` makes one;
`doc:open(path, line?)` shows a VFS file or asset in the viewer its kind calls
for; `doc:build(edui.palette())` is the panel content. Text is editable
(`doc:save()` writes it and runs a .luau file through the LSP) and the document
follows its file on disk: a write lands in a buffer with no unsaved edits, and
raises a "changed on disk" bar over one that has them. `doc:setText` tells
the owner (`onChange`) when it moves `doc:dirty()`, so a panel can mark its tab.
`doc:suspend()` sets a document aside while its panel is closed: the watch and
the viewer's resources go, the path and the unsaved edits stay.
`doc:resume()` picks it back up and reads the file as it is now — a clean
buffer adopts what changed meanwhile, an edited one raises the conflict.
Viewers are modes. The built-in ones are `code`, `markdown` (rendered, with a
Source toggle), `image`, `asset` (a live orbitable render for any asset type
that declares a preview) and `info`. `edui.document.registerMode{ name, match,
build }` adds another.
The Code panel is one document; `edui.shown` opens a panel around another.
# entityPicker
<!-- zero:scaffolded-readme -->
<!-- Replace the line below with what this module provides and who
consumes it, then delete both comment lines. -->
TODO: describe this module.
# edui.widgets.fields
Inspector field rows for edui — a two-column (label + control) row whose control
is chosen by the field's declared TYPE (from the component's backing schema),
falling back to the value's shape when no type is given.
The label column carries the field name and a per-type **badge**
(num/str/bool/enum/rgb/vec3/rot/ref/obj, each in its own hue) so a row's type
reads at a glance. The control column maps:
- `number` → drag-scrub numeric field (`controls.numberField`); a spec carrying
`min` / `max` shows its bounds beside the input (`1 – 16`, an open side as `…`)
- `bool` → toggle switch (`controls.boolToggle`)
- `string` → framed text input
- `enum` → a value button that opens a menu of members
- `color` → swatch + native colour picker
- `vec3` → three axis-coloured (x/y/z) numeric cells
- `quat` → an editable euler (X/Y/Z degrees), read back to a quaternion
- `assetRef` → a live-asset chip
- nested table → a recursing disclosure
Each editable leaf fires `onChange(newValue)` (vec3/quat fire the full new
table). A row spec's `description` is the label's tooltip, and its `error` is
drawn beneath the row in the danger colour. Every committed edit is one
undoable operation named after the field.
## `schemaField` — a row from a Field descriptor
`edui.schemaField{ label, desc, value, key, onChange?, readOnly?, error?,
errors?, nameOf? }` is the one place a `Field.*` descriptor becomes its
control. The descriptor decides the control:
| Descriptor | Control |
|---|---|
| `Field.enum` (string with an enum constraint) | dropdown of its members |
| `Field.number` / `Field.range` / `Field.bitmask` | number; a range shows `min – max`, a bitmask `0 – 2^bits-1` |
| `Field.bool` / `Field.string` | toggle / text input |
| `Field.color` | swatch + picker; an edit keeps the value's alpha |
| `Field.vec2` | two axis cells (x/y), each edit emits `{ x, y }` |
| `Field.vec3` / `Field.quat` | axis triple / editable euler |
| `Field.assetRef` / `Field.resource` / `Field.dataRef` | asset chip accepting the descriptor's category |
| `Field.instantiableRef` | asset chip accepting the spawnable kinds (`"*"` is the wildcard category and narrows nothing; the scene-instantiable constraint does) |
| `Field.taggedRef` | asset chip accepting any kind, reading "accepts assets tagged <tag>" — the field's own constraint checks the tag |
| `Field.entityRef` | entity chip, named through `nameOf` |
| `Field.struct` (and `Field.settingsOf`) | a disclosure of its subfields, each a `schemaField` in declaration order (`Settings.orderedNames`); an edit emits the whole struct |
| `Field.list` | a disclosure of its elements, each a `schemaField`, with **Add**, **Remove**, **Move up** and **Move down**; every action emits the whole new list. The first element has no Move up and the last no Move down; Add appends the element descriptor's default |
| `Field.table` / `Field.componentRef` | the value-shaped control `field` would choose |
A value stored as an array (`{ 1, 0, 0, 1 }`) reads as its map form
(`{ r, g, b, a }`), and a missing value shows the descriptor's default.
`error` is this row's own message. `errors` maps paths **relative to this
field** to messages — `"filter"`, `"[2]"`, `"[2].name"` — and each nested row
of a struct or list receives the part under its own name
(`edui.widgets.subErrors(errors, head)` does the re-keying). The descriptor's
`description` is the label's tooltip.
Callback keys, for a row keyed `k`: the disclosure `k:disc`; a subfield or
element `k/<name>` / `k/<i>`; list Add `k:add`; Remove `k:rm:<i>`; Move up
`k:up:<i>`; Move down `k:down:<i>`; a vec2 axis `k:x` / `k:y`.
`Fields.make(W)` binds these to the widgets barrel; the barrel exposes
`edui.field`, `edui.schemaField` and `edui.section`, and
`edui.widgets.subErrors`.
# edui.widgets.tree (module)
The editor hierarchy tree primitive — `edui.tree{...}`.
The tree is **generic over its nodes**. It never reads an `entity` field: a
caller supplies the accessors and owns the state, and the tree only reports
clicks. That is what lets one primitive back the Entities hierarchy, an asset
folder listing, and a scene-layer list with no branch per caller.
- Accessors: `idOf(node)`, `childrenOf(node)`, `labelOf(node)` — defaulting to
`node.id`, `node.children`, and `node.label`/`node.name`.
- Expand state is the caller's: pass an `expanded` set (`{ [id] = true }`) or an
`isExpanded(node, id)` predicate, and handle `onToggle(node, id)`.
- Selection is the caller's: pass `selected` (an id, or an `{ [id] = true }` set
for multi-selection) and handle `onSelect(node, id)`.
- `renderRow(node, row, selected)` replaces the default label with your own
content (badges, per-row icon buttons); return one widget or a list.
## Flattening
`flatten{ roots, ... } -> { { node, id, depth, hasChildren, expanded, parent } }`
is exported separately (`edui.widgets.flattenTree`) and is **pure** — no `ui.*`
calls and no app — so display order is testable without a rendered frame. A
node's children appear only while that node is expanded, so a collapsed tree
costs nothing to build. A node that appears on its own ancestry is reported and
skipped instead of recursing forever.
## The window
`windowBounds(total, offset, viewport, rowH, overscan?, quantum?) -> first, last`
(`edui.widgets.windowBounds`) is the pure arithmetic behind the windowed shape:
the rows in view plus an overscan on each side, the start snapped to a multiple
of the quantum so a small scroll moves nothing. `first` is the 0-based index of
the band's first row and `last` the 1-based index of its last, so the rows are
`first + 1` through `last`.
## Row rendering
Rows are uniform-height, which is exactly the shape `scrollArea`'s `virtual`
prop wants — the renderer then draws only the band in view. Leaf rows still
reserve the disclosure-chevron slot so every label at a given depth starts on
the same column.
Row keys are stable (`"<key>:<id>"`), so the callback ids survive a rebuild and
anything the renderer tracks by id (focus, `ui.widgetState`) stays put.
The disclosure chevron and the select target are **siblings, never nested** — a
click lands on exactly one, so opening a node cannot also select it. The select
target grows to fill the rest of the row, which is what keeps the whole row
clickable rather than just the label. The selection background sits on the
non-clickable row container so it spans the indent and chevron too.
Note that `virtual` is *render*-side windowing: the row widgets are still built
for every visible node. Construction-side windowing (building only the scrolled
band) needs the `virtualTotal`/`virtualFirst` scrollArea props, which are not on
this branch.
# 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**.
# edui.app (module)
The `edui` reactive core. An `App` owns one `ui.*` screen and turns the
string-callback-id protocol into ordinary closures.
`ui.*` dispatches interaction through string ids because closures cannot cross
the FFI boundary: a widget carries `props.onClick = "<id>"`, and the screen's
registered env receives `onCallback(id, data)`. An `App` hides that — during a
build it allocates an id per closure and records id→closure, and its single
`onCallback` looks the id up, calls the closure, and rebuilds.
## Surface
- `new(screenName, opts?) -> App` — `opts.layer` is a render-layer mask applied
via `ui.setScreenRenderLayer` on first register; `opts.callbackKey` overrides
the env key.
- `App:mount(builderFn)` — register the callback env, run the first build.
`builderFn(app) -> widgetTree` is re-run on every rebuild.
- `App:cb(closure, key?) -> id` — the id to place in a widget's `on*` prop. Pass
a stable `key` so the id survives a rebuild, which is required for anything
the renderer tracks by id (focus, drag, `ui.widgetState`).
- `App:dispatch(id, data) -> handled` — what the broadcast calls. Returns false
for an id belonging to another surface so a host can keep routing.
- `App:markDirty()` / `App:rebuild()` — a rebuild requested *during* a build is
coalesced into a single follow-up, so a handler that mutates state and a
builder that reads it never recurse.
- `App:unmount()` — release the env and unregister the screen.
- `current()` — the app whose builder is running right now, or nil outside a
build. The `edui` primitives read this, which is why an author passes a
closure and never threads the app through every call.
Builder errors are logged rather than thrown, so one bad build never wedges the
editor.
```luau
local edui = require("modules.edui")
local app = edui.createApp("myPanel")
app:mount(function(a)
return {
type = "vertical",
children = {
{ type = "button", props = {
text = "Save",
onClick = a:cb(function() save() end, "save"),
} },
},
}
end)
```
# theme
Theme tokens for zui (Layer 2). Reads through `ui.getToken(name)` first
so a loaded engine theme propagates automatically; falls back to
in-module defaults that cover every named color used by the demos. Also
owns the Luau-side `$variable` cascade — `register` / `load` resolve
references end-to-end (cycle-detected) and push flat values to
`ui.registerTheme`.
## Exports
- `M.with(overrides: TokenMap?) -> ThemeView` — read-only view with overlays on top of engine/defaults.
- `M.defaults() -> TokenMap` — raw default token map (same reference each call).
- `M.tokenNames() -> { string }` — sorted list of shipped token names.
- `M.resolve(theme: any) -> (ResolvedTheme?, string?)` — flatten a theme table (`$var` → literal). Returns `(nil, errMsg)` on failure.
- `M.resolveTokens(theme) -> (TokenMap?, string?)` — re-export from cascade.
- `M.resolveStyles(theme, tokens) -> (StyleMap?, string?)` — re-export from cascade.
- `M.register(name: string, theme: any) -> (boolean, string?)` — resolve and push to `ui.registerTheme`.
- `M.load(name: string) -> (boolean, string?)` — require `@builtin::themes.<name>` and register it.
- `M.activate(name: string) -> boolean` — thin wrapper over `ui.setTheme(name)`.
- `M.default: ThemeView` — module-level token view with no overrides.
Types:
- `TokenMap = { [string]: any }`
- `StyleMap = { [string]: { [string]: any } }`
- `Theme = { name: string?, tokens: TokenMap?, styles: StyleMap? }`
- `ResolvedTheme = { name: string, tokens: TokenMap, styles: StyleMap }`
- `ThemeView` — read-only metatable proxy; writes throw.
## Usage
```luau
local Theme = require("@builtin::modules.zui.theme")
Theme.load("dark") -- require + register the built-in dark theme
Theme.activate("dark") -- ui.setTheme("dark")
local view = Theme.with({ accent = "#ff0" })
print(view.accent) -- "#ff0"
print(view.bg) -- engine token or default
```
## Notes
- `register` overrides `theme.name` with the caller-supplied name so
`listThemes()` / `setTheme(name)` find it under the requested key
(mirrors the pre-Phase-4 #942 fix).
- The cascade is cycle-detected — broken inputs surface as structured
`(false, errMsg)` returns instead of silently producing garbage colors.
- `M.default` is built at module-load time, after `M` is fully populated,
so its function-fallback `__index` resolves correctly.
- `ThemeView` writes raise — use `Z.themeWith({...})` to get an overlay
view rather than mutating the existing one.
# dark
Zero Engine dark theme. Data-only module — `return`s a theme table with
`name`, `tokens` (palette), and `styles` (widget rule blocks). Registered
into the cascade resolver via `Z.theme.register`. Controls all visual
appearance — colors, spacing, rounding, sizing — so nothing is hardcoded
in Rust.
`$tokenName` references inside `styles` resolve against the `tokens`
map before flat values are pushed to the engine. Includes a dedicated
code-highlighter palette (`code.*` tokens) tuned for dark backgrounds
and an MCP panel palette (`mcp-*` tokens) for the floating agent
tool-call feed.
## Exports
- `name: string` — `"dark"`. Used as the theme key when registering.
- `tokens: { [string]: string }` — flat map of named tokens (colors, spacings, radii).
- `styles: { [string]: { [string]: any } }` — widget style blocks, indexed by `widget` or `widget.variant`.
## Usage
```luau
local theme = require("@builtin::themes.dark")
Z.theme.register(theme)
```
## Notes
- Pure data. Hot-reloading the module just re-registers the table next
time `Z.theme.register` runs.
- Code-highlighter `code.*` tokens map 1:1 to the highlighter modules;
switching themes re-colors source code automatically.
- MCP panel tokens (`mcp-*`) cover the floating agent tool-call feed —
status colors, code-block backgrounds, hover/row tints.
# 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.
# preview
Render an asset's preview in the preview studio: an isolated camera, lit only
by its own three-point rig, over a neutral backdrop, that nothing in the scene
reaches. `ref:preview()` renders any asset by the recipe its type declares under
`preview:` in its `type.yaml`, and these are the primitives it calls: they spawn
temporary entities, frame an offscreen camera over them, render one frame,
read it back as a PNG, and tear the entities down.
## Surface
- `preview.fromEntities(makeFn, opts?) -> PreviewResult` — run `makeFn` to
instantiate entities, frame a camera to their bounds, render one offscreen
frame, and return the still PNG.
- `preview.fromRecipe(ref, recipe, opts?) -> PreviewResult` — render `ref` by a
declared recipe: `instantiate` stands it through its own `instantiate`,
`surface` paints the material its type's `ref.previewMaterial` returns on the
recipe's mesh, and `image` fits a file the asset holds to the frame on the
studio backdrop without rendering anything.
- `preview.backdrop() -> { r, g, b }` — the studio backdrop's colour in a
finished preview, 0-255.
`PreviewResult` is `{ available, imageBase64?, rendered?, width?, height?,
bounds?, stats?, reason? }` — `imageBase64` is the rendered PNG when `available` is true, and
`reason` explains why when it is false. `opts` is `{ size? = { width, height },
angle? = { yaw, pitch } }`.
A preview pictures its whole subject, however many entities it composes. While
the subject settles, its bounds are measured each frame by walking it in Luau
for up to `opts.entityBudget` entities (default 2000); a subject composing more
is measured by the capture framing alone, which reads each root's hierarchy
bounds from the engine.
## Example
local result = asset.resolve("gold", "material"):preview({ size = { width = 512, height = 512 } })
-- result.imageBase64 holds the rendered PNG (base64)
# previewRecipe (module)
How a type makes its instances' pictures. A type declares it in its
`type.yaml`, under `preview:`, and every instance's `preview.png` is produced
by the recipe named there.
```yaml
preview:
kind: surface # instantiate | image | surface | custom
mesh: sphere # surface: the builtin mesh the asset is painted on
```
| `kind` | The picture is | Needs |
|---|---|---|
| `instantiate` | the asset stood in the studio through its own `instantiate` | — |
| `image` | a file the instance already holds, fitted to the frame | `source.file` or `source.files` |
| `surface` | the asset painted on a builtin mesh | `mesh` |
| `custom` | whatever the type's `behavior.luau` `ref.preview` returns | — |
`angle: [yaw, pitch]` (degrees) states the bearing the camera looks from, for
any kind that renders.
The `preview:` block says how the picture is PRODUCED. Whether search embeds
that picture is a separate declaration — an `image` chunk under
`indexing.content` naming `preview.png` — so a type states both, and a type
that states one without the other gets exactly what it stated.
## Exports
- `M.of(typeName) -> PreviewRecipe?` — the recipe `typeName` declares, or nil
when it declares none or no type answers to that name. Read once and held;
a block naming an unknown `kind`, or missing what its kind needs, is refused
with a warning naming the type.
- `M.forget()` — drop every held recipe. The change dispatcher calls it, with
`declaration.forget()`, for every write inside an `.assetType` folder and for
every removed type, so an edited `type.yaml` is read again.
# json_utils
Safe JSON decoding helpers and a WASM-safe number formatter. Wraps
`Json.decode` with `pcall` so engine-provided JSON strings can't
propagate parse errors into call sites. Also handles the engine
convention of writing the literal string `"null"` when a JSON value is
absent.
## Exports
- `M.decodeOrNil(jsonStr: string?) -> any` — safe decode; returns `nil` on empty input, `"null"`, or parse failure.
- `M.decodeOrEmptyTable(jsonStr: string?) -> table` — safe decode; returns `{}` on any failure or non-table result.
- `M.safeDecode(jsonStr: string?) -> any` — historical alias for `decodeOrNil`.
- `M.formatNumber(n: number, decimals?: number) -> string` — truncate a number to N decimal places using only string ops. WASM-safe.
## Usage
```luau
local JsonUtils = require("@builtin::modules.json_utils")
local payload = JsonUtils.decodeOrNil(engineJsonString)
local table = JsonUtils.decodeOrEmptyTable(maybeMissing)
local label = JsonUtils.formatNumber(3.14159, 2) -- "3.14"
```
## Notes
- `decodeOrNil` short-circuits on `nil`, empty string, and the literal
string `"null"`. The Json.decode call itself is wrapped in `pcall`, so
malformed input is never observable to callers.
- `decodeOrEmptyTable` is intentionally strict: non-table decode results
(numbers, strings, booleans, nil) collapse to `{}`. Use `decodeOrNil`
if you need to distinguish those.
- `formatNumber` uses `tostring` + `string.sub` so it avoids the
`string.format` numeric specifiers that don't work reliably under
WASM in Luau. Pass `decimals = 0` to drop the fractional part
entirely; a count below `0` reads the same as `0`, and a fractional
count counts the whole places in it.
- `formatNumber` truncates the mantissa of a value `tostring` renders in
exponent form (`1.5e-07`) and keeps the exponent, so the result still
reads back through `tonumber`.
# highlight
Syntax-highlighting dispatch + per-language modules. Each language
module exports `(text: string) -> { Segment }` where
`Segment = { text, color, monospace?, italic? }`. `Z.codeEditor` calls
into `dispatch` at update time and passes the resulting segments to
TextInput, which builds the egui LayoutJob in pure Luau. Library authors
can ship their own `@author/zui_highlight_<lang>` modules and slot them
into `Z.codeEditor` via the same `language` opt.
## Exports
- `M.dispatch(language: string, text: string) -> { Segment }` — pick a per-language highlighter (with `yml` / `md` aliases) and tokenize; unknown languages fall through to a single plain segment.
- `M.lua: Highlighter` — Lua highlighter.
- `M.json: Highlighter` — JSON highlighter.
- `M.yaml: Highlighter` — YAML highlighter.
- `M.wgsl: Highlighter` — WGSL highlighter.
- `M.markdown: Highlighter` — Markdown highlighter.
Types:
- `Segment = { text: string, color: string, monospace: boolean?, italic: boolean? }`
- `Highlighter = (string) -> { Segment }`
## Usage
```luau
local Highlight = require("@builtin::modules.zui.highlight")
local segs = Highlight.dispatch("lua", source)
-- segs = { { text = "local", color = "#...", monospace = true }, ... }
-- Or call a specific language directly:
local segs2 = Highlight.json(jsonText)
```
## Notes
- Per-language colors come from the active theme's `code.*` tokens
(`ui.getToken("code.keyword")` etc.). Switching themes
(`ui.setTheme("light")`) automatically re-colors on the next call.
- A single-slot LRU cache keyed by `(language, text, theme)` makes
same-text re-emits free (focus-loss redraws, no-op editor pushes).
Cache returns a shared array reference — callers must not mutate it.
- Aliases: `"yml"` → `yaml`, `"md"` → `markdown`. Unknown languages
return a single default-colored monospace segment so user input never
crashes the dispatcher.
## Roles the Lua highlighter reads
`code.keyword`, `code.string`, `code.number`, `code.comment`, `code.bool`
(`true` / `false` / `nil`), `code.attribute` (`--!` directives),
`code.type` (a name after `:`, `->`, `::` or `type`), `code.function` (a name
a call is made through, or one `function` declares), `code.property` (a
member reached by `.` that is not called), `code.builtin` (the standard
library's globals), and `code.default` for the rest.
# editorSelection
Named selection scopes for the editor. A scope is an independently
tracked, ordered set of typed refs plus a primary (the last ref added
or clicked). Distinct scopes never clobber each other, so viewport,
outliner, inspector and asset browser share one answer to "what is
selected" per kind.
A ref is `{ kind: string, id: string }` — a stable id, never a display
string, so rename/move never invalidates a selection.
## Exports
- `M.scope(name) -> Scope` — get/create a named scope handle.
- `M.set(scope, refs)` — replace refs in order; primary becomes the last.
- `M.get(scope) -> { Ref }` — refs in click order (fresh array).
- `M.primary(scope) -> Ref?` — last-clicked ref, or nil.
- `M.clear(scope)` — empty a scope.
- `M.toggle(scope, ref)` — add if absent, remove if present.
- `M.add(scope, refs)` — add each ref not already present; primary becomes the last added.
- `M.remove(scope, refs)` — remove each of `refs`; primary becomes the last remaining or nil.
- `M.contains(scope, ref) -> boolean` — membership by `(kind, id)`.
- `M.count(scope) -> number` — the scope's selection size.
- `M.subscribe(scope, fn) -> handle` / `M.unsubscribe(scope, handle) -> boolean`.
- `M.context() -> { scope, refs, primary }` — last-focused scope, for command ctx.
## Usage
```luau
local Selection = require("@builtin::modules.api.editor.selection")
local scope = Selection.scope("entity")
Selection.set(scope, { { kind = "entity", id = "player_1" } })
Selection.subscribe(scope, function() refreshInspector() end)
```
## Notes
- State lives in a fixed `_G` slot, seeded pre-seal by the boot chain
(`prelude.luau`); it survives hot-reload and edit↔play flips. Mutations
after boot write into nested tables only.
- `set` / `toggle` / `clear` mark their scope as last-focused, which drives
`context()` and therefore which scope commands act on.
- The service holds the editor's selection state in Luau. Refs handed back by
`get` / `primary` / `context` are copies, so a caller can hold or mutate them
without touching internal state.
# text_diff
Pure-Luau line-diff helper used by `world.diff` / `world.show` and the
`zm diff` / `zm show` shell commands. LCS-based; produces structured
hunks (op-tagged lines, not unified-diff text) so AI consumers can
pattern-match on `op` instead of parsing `+`/`-`/` ` prefixes.
## Exports
- `M.diff(oldText: string?, newText: string?, opts: DiffOpts?) -> FileDiff` — diff two strings, return the structured per-file shape.
- `M.added(newText: string?, opts: DiffOpts?) -> FileDiff` — pure-add convenience (equivalent to `M.diff("", newText, opts)`).
- `M.removed(oldText: string?, opts: DiffOpts?) -> FileDiff` — pure-remove convenience.
- `M.toUnifiedText(fileDiff: FileDiff) -> string` — render structured diff back into unified-diff text.
- `M.toStatLine(fileDiff: FileDiff) -> string` — `git diff --stat`-style one-line summary.
- `M.SIZE_CAP_BYTES: number` — per-file size cap (256 KB). Files larger than this return a size-only summary with `is_text=false`.
Types:
- `DiffLine = { op: string, text: string }` — one tagged line. `op` is `"+"`, `"-"`, or `" "` (context).
- `DiffHunk = { old_start, old_count, new_start, new_count, lines: { DiffLine } }` — git-style hunk.
- `DiffOpts = { context: number?, path: string?, action: string? }`.
- `FileDiff = { path?, action?, is_text, added?, removed?, hunks?, size_old?, size_new? }`.
## Usage
```luau
local TextDiff = require("@builtin::modules.text_diff")
local d = TextDiff.diff(oldBytes, newBytes, { path = "foo.luau" })
if d.is_text then
print(TextDiff.toStatLine(d)) -- "modified foo.luau +3 -1"
print(TextDiff.toUnifiedText(d))
else
print(string.format("oversize: %d -> %d bytes", d.size_old, d.size_new))
end
```
## Notes
- The per-file size cap (`M.SIZE_CAP_BYTES = 256 * 1024`) mirrors the
spacetime `text_blobs` inline threshold. Anything above that lives in
the bucket as binary anyway, so the diff library never sees it as
text in practice; the cap is belt-and-suspenders for callers that
bypass the routing.
- The alignment is a longest common subsequence computed on the diagonal
band of the table its edit distance reaches, one bit per cell, after the
common prefix and suffix are aligned line by line. Memory and time follow
the lengths of the two texts times their edit distance, so a few changed
lines in a long file cost a few bands of that file's length. A long diff
runs in slices that hand the frame back (`FrameBudget.yield`) when the
caller runs on a coroutine that can yield.
- Where repeated lines leave several equally long alignments, the diff takes
the one a walk back from the last lines takes: a common pair of lines is
kept, and otherwise the new side's line is let go first, so each run of
changed lines lists its removed lines before its added ones.
- Default context window is 3 lines (matches `git diff -U3`). Override
via `opts.context`.
- Hunk header line numbers follow git's `@@ -0,0 +1,N @@` shape for
pure additions (and the mirror for pure deletions).
- Trailing newline handling: a final `\n` doesn't produce an empty
trailing element. Matches POSIX `wc -l` semantics and most diff tools.
# edui.shell (module)
The editor dock shell on the CSS-parity `ui.*` surface. One edui app owns a
`ui.*` native `dockArea` whose children are a `dockPanel` per registered edui
panel — real `egui_dock` tabs, splits and drag, with the arrangement persisting
across rebuilds because the dockArea and each dockPanel carry a stable `id`.
## Why a separate registry
The shell keeps its own panel registry (`addPanel` / `removePanel` /
`panelsSorted`), distinct from the deprecated zui `editor.registry`. That keeps
the zui editor completely untouched while panels migrate to edui one at a time:
the zui dock renders the zui-framework panels it always has, and the edui shell
renders the edui panels registered here. The two registries fold into one at
cutover, when the zui dock is retired.
## One app, one reactive loop
`App.rebuild` sets the shell as the building app before it calls `buildShell`,
so a panel's `build()` — which uses `edui.current()` to register its closures —
wires every callback onto the ONE shell app. All interaction for every panel
flows through the shell's single callback env, and a click anywhere rebuilds the
whole dockArea. That is why the shell needs no per-tab scheduler (unlike zui's
`dockApp`): the edui App is the scheduler.
## Usage
```lua
local edui = require("@builtin::modules.edui")
edui.shell.addPanel{
id = "entities", title = "Entities", order = 10,
build = function()
return edui.panel{ title = "Entities", body = edui.tree{ ... } }
end,
}
edui.shell.mount() -- registers the screen on the EditorUI layer
-- each editor-update frame:
edui.shell.update(dt) -- liveness rebuild every `refresh` seconds
```
`mount(opts?)` takes `{ refresh? }` (seconds between liveness rebuilds, default
0.5). `refresh()` forces an immediate rebuild; `unmount()` tears the screen down
but keeps the panel registrations for a later `mount`.
# assetType.shared.settings
Resolves four questions about an asset's typed settings, all answered from its
type's `type.yaml` — nothing here is found by convention.
```lua
local Settings = require("@builtin::assetTypes.assetType.shared.settings")
-- or, from inside the assetType runtime:
local Settings = require("@builtin::assetTypes.assetType.shared").settings
```
## Where does a type's schema live?
`type.yaml` names it in a `settings:` block:
```yaml
settings:
values: "settings.yaml" # where an instance's own values live
schema: { type: "settings.luau" } # one schema for every asset of this type
```
or, for a type whose settings differ per instance (an importer):
```yaml
settings:
values: "settings.yaml"
schema: { instance: "settings.luau" }
```
or, for a type whose schema is a table its instance's own source declares and
whose values live elsewhere (a component: its `public` fields, valued on each
entity it is on):
```yaml
settings:
schema: { instance: "init.luau", export: "public" }
```
Whether an instance may lack its schema file is what the type's `files:`
block says of that file. Listed under `files.optional`, it may be absent, and
an instance without it declares no settings — the importer type lists it
there, since most importers take none. Listed under `files.required`, or not
listed at all, it must load, and an instance missing it is a broken
declaration and is logged.
`schema.type` is required at the folder relative to the TYPE's own
`.assetType/` directory (one schema shared by every instance).
`schema.instance` is required relative to each INSTANCE's own folder (`init`
resolves the instance's own identity; anything else is a sibling module under
it). Without `schema.export`, the file is required as a module and its return
value IS the schema. With `schema.export`, the file is run in an environment
of its own and `export` is read from a returned table carrying it, or else
from the globals the file assigned — a component's `public` is such a global.
That environment reads through to `_G` and takes every write itself; its own
`_G` is itself, its `declare` and `computed` record into it, and its `task`
records spawned, deferred and delayed work instead of starting it. Every other
global is the real one, so a call the file makes through one runs as it does
anywhere. The schema is the declared table's Field descriptors. A schema that
resolves to nothing says why through `Settings.schemaProblemOf(ref)`: the file
could not be read, compiled or run, or declared no such table. An instance
schema is read again when its file, its type's `type.yaml`, or the entry file
of any module the asset `require`s changes. `Settings.blockFor(typeName)`
returns the raw block; `Settings.schemaForType(typeName)` and
`Settings.schemaOfInstance(ref)` resolve the two schema shapes respectively;
`Settings.schemaFor(ref)` tries the type-level schema first, falling back to
the instance-level one. `ref` naming an assetType asset itself — e.g.
`asset.resolve("texture", "assetType")`, rather than an instance of it —
reports that type's own declared schema, the same one every instance of it
reports.
## Where do an asset's values live?
`settings.values` names a file living beside the asset's own content —
`Settings.valuesPathOf(ref)` joins it onto the asset's path.
`Settings.valuesOf(ref)` / `Settings.writeValues(ref, values)` read and write
it; this module only names where it is. A type that declares its schema with
no `settings.values` keeps no values in the asset — a component's live on each
entity it is on — so `valuesOf` answers nil for it, `asset.create` refuses a
`settings` table for it, and `asset.setSettings` refuses a write.
`Settings.recordedWrite(path, text)` writes a file the way every values file
is written, and an editor uses it for any other file it writes. It writes the
whole contents, records the write into the open undo operation when one is
open (so undoing it restores what the file held), and raises when the write
does not land.
## In what order are a schema's fields declared?
Every `Field.*` constructor stamps its descriptor with `declaredOrder`, one
more than the last. Luau evaluates a table constructor's entries in the order
they are written, so `Settings.orderedNames(schema)` lists a schema's fields —
and a struct's subfields — in the order the source writes them.
A values file, or a legacy `.metadata` settings block, may hold an older
spelling — a renamed field, an older enum member. Every read passes what is
stored through the type's `normalizeSettings` (`Settings.normalizeFor`), so
it answers in the fields the schema declares today, and writes nothing. The
next local edit of that asset rewrites the file in the declared spelling
(`Settings.healLegacyIfNeeded`).
`asset.setSettings(ref, patch)` writes a partial patch:
`Settings.resolvePatch(ref, patch)` normalises it, merges it over the current
values and applies the type's derived defaults for the fields it changed, and
`Settings.writeValues(ref, values, patch)` applies the corrections, checks the
schema and writes the file.
## How is a new asset's settings resolved at creation?
`asset.create` calls `Settings.resolveForCreate(typeName, name, destPath,
creationOpts, callerSettings, importerSettings)` before running the type's
`onCreate`, checks the result against the schema, writes it to the values
file, and hands `onCreate` a COPY of it as `opts.settings` (`Settings.
cloneValues`) — never the same table the values file gets, so nothing
`onCreate` does to its own copy can reach what was stamped. `onCreate` reads
settings from `opts.settings` and never writes to it. `asset.create` also
seeds the change baseline with the stamped values
(`Settings.seedChangeBaseline`), so the values file's own first dispatch
reports nothing changed and the payload `onCreate` encoded is the only
encode a create runs.
The layers, lowest priority first, each overriding the ones before it field
by field:
1. The schema's own declared defaults (`Settings.defaultsOf`).
2. The type's own `settingsDefaults(name, opts, asked)` hook, when its
`behavior.luau` exports one. `asked` holds what layers 3 to 5 name, so a
default can follow a field one of them sets.
3. The Preset Manager's matching row (`Settings.presetLayerFor`).
4. The creating importer's settings for this type.
5. The `settings` table the caller passed to `asset.create`.
6. The type's own `settingsDerivedDefaults(values, explicit, changed)` hook,
when its `behavior.luau` exports one — a field whose default follows
another field, set only when no layer from 2 to 5 named it.
7. The type's own `settingsCorrections(values, name, opts)` hook, when its
`behavior.luau` exports one — applied last, once every other layer has
merged.
Layers 2 to 5 are each read through the type's `normalizeSettings`, so a
layer naming a field in an older spelling sets the field it names today.
`asset.create`'s top-level settings alias accepts those older names too
(`Settings.acceptedFieldNames`).
Layer 7 is `Settings.applyCorrections(typeName, values, explicit, context)`,
the one corrections path every settings write takes — this create chain, and
`Settings.writeValues` for every later write (`asset.setSettings`, a type's
first-encode seed, the legacy heal). `explicit` names the fields the writer
asked for: the caller's `settings` table here, the patch for
`asset.setSettings`. A correction lands SILENTLY on a field the writer did not
name — nobody asked for that value, so overriding it just states a fact. A
correction that contradicts a field the writer named REFUSES the write,
naming the field, the value asked for, and why it cannot hold — the same as
every other place this codebase refuses an explicit request it cannot satisfy
(a `Field.checkSchema` violation, a BC7 alignment error) rather than silently
rewriting it into something else. So `asset.setSettings(tex, { compression =
"rgba16" })` on a mipped texture stores `generateMipmaps = false` beside it,
while `asset.setSettings(tex, { compression = "rgba16", generateMipmaps = true })`
is refused.
`Field.checkSchema` runs once, over the result AFTER the corrections hook has
applied — a bad value nothing corrects refuses the creation.
### Four hooks, four different jobs
Every hook is an optional export on a type's `behavior.luau`, alongside
`onCreate` / `onChange`. **None is ever handed a table to mutate** — each
reads what it's given and RETURNS a table of what it wants changed (or nil);
`resolveForCreate`, `resolvePatch`, `applyDerivedDefaults` and
`applyCorrections` are the only places that write to the values, by merging
what a hook returns the same way every other layer merges.
- **`normalizeSettings(values) -> values`** maps every older spelling a
stored file or a write may carry to the field and member the schema
declares now, returning a new table; a table naming both an older field
and its replacement keeps the replacement. The companion export
**`normalizedSettingNames = { ... }`** lists the older field names it
accepts beyond the schema, so a write naming one is not refused as an
undeclared field. `texture.assetType`'s maps the fields its earlier schema
stored to `colorSpace` + `compression`, and the older `filter` keywords to
`linear` / `nearest`.
- **`settingsDerivedDefaults(values, explicit, changed) -> partial?`**
answers the values of fields whose default follows another field. At
creation `changed` holds every field; on a write it holds the fields the
write moved. A returned field applies only where `explicit` — the fields
the writer named — does not name it.
- **`settingsDefaults(name, opts, asked) -> partial?`** supplies a DEFAULT
the schema itself has no syntax for — something only knowable at creation
time, like a naming convention, a fact read off a payload the caller handed
in, or a value that follows a field a higher layer sets (`asked` holds what
the Preset Manager, the importer and the caller name, the higher one's
value where two name a field). It runs early (layer 2 above), so any later
layer — Preset Manager, importer, caller — freely overrides it.
`texture.assetType`'s returns the `textureType` the name suggests (a
`_normal`-suffixed name is a `normalMap`), `compression = "uastc"` and
`maxDimension = 4096`, with `rgba8` for a `textureType` of `sprite` that a
higher layer names; for a pre-encoded ZTEX payload it returns the colour
space, compression and sampler the payload's own header carries. Either
way, an explicit `settings = { ... }` from the caller still wins.
- **`settingsCorrections(values, name, opts) -> (partial?, reasons?)`**
enforces a CROSS-FIELD CONSTRAINT the schema itself has no syntax for — a
fact about one field that depends on another field's resolved value, true
regardless of which layer produced that value. It runs last (layer 7
above), over the fully merged `values`, and again on every later write of
the values file. Nothing is left unmet in what gets
validated and stamped — but a value the caller explicitly asked for is
never silently rewritten to satisfy it; `applyCorrections` refuses instead
(see above). The optional second return, `{ [field]: reason }`, supplies
the "why" for that refusal message; a field with no reason falls back to a
generic one. `texture.assetType`'s returns `{ generateMipmaps = false,
maxDimension = 8192, colorSpace = "linear" }` whenever the RESOLVED
`compression` is high-precision (the encoder stores one verbatim, linear,
and refuses a mip chain or a downsample for it outright), paired with a
reason naming the compression, and `nil` otherwise.
## What does a declarer declare?
`Field.settingsOf(identity, mode)` embeds another declarer's schema as a
struct field without restating it. The identity names one of two kinds of
declarer, and `Settings.schemaOfDeclarer(identity)` tells them apart by what
`identity` resolves to:
- **An assetType** (e.g. `"@builtin::assetTypes.texture"`) — embeds the
schema every instance of that type carries, resolved via
`schemaForType`. This is the type-level shared schema from the section
above, not a per-instance one — an assetType has no settings of its own
to declare per instance.
- **Anything else** (an importer, or any other asset that declares settings
of its own) — embeds that asset's own schema, resolved via
`schemaOfInstance`.
Every schema this module serves has already run its `Field.settingsOf`
fields through this resolution — a caller reading `schema.someField.fields`
never sees an unresolved `declarer` with no `fields`. Resolution descends
into an already-literal struct's `fields` and a list's `element` the same
way, so a declarer embedded several fields deep is still reached. A declarer
that embeds itself, directly or through another declarer, stops one level
short of the loop instead of recursing forever.
## What are the defaults?
`Settings.defaultsOf(schema)` reads every field's declared `default` into a
plain table — a field declared without one is absent from the result rather
than holding a `nil` value.
# edui.shown
Panels opened to put a file in front of the user. `edui.shown.open(path,
{ line?, title? })` opens a new dock tab around an `edui.document` and brings
it to the front — one tab per call, beside whatever the user has open. The tab
is editable where the file is text and follows the file on disk. Unsaved edits
mark its tab, and closing it — the tab's X, or `close(id)` — asks the user to
save or discard them first; `close` then answers `false` and why. Closing
releases the document; no saved layout records it.
`resolve` turns an asset name, identity or guid into its VFS path;
`scratchPath(title, ext)` names an unused file under `/zero/source/tmp/show/`
for text with no file behind it. The `show` toolbox is the agent surface over
this module.
# transform
Math helpers for positions, rotations, and directions on transforms.
Exposed as the global `Transform` table via `--!global Transform` — no
explicit require needed in user code. Functions that take an entity
accept either an entity ID string or an entity proxy table from
`entity("id")`.
## Exports
Look-at and entity-aware helpers:
- `Transform.lookAtQuat(fx, fy, fz, tx, ty, tz) -> (qx?, qy?, qz?, qw?)` — quaternion from origin toward target. Nil when degenerate.
- `Transform.lookAt(entity, txOrTarget, ty?, tz?) -> (boolean, string?)` — make an
entity face a world position or another entity. Both slots read world space:
the subject and an entity target are read as `entity(id).position` and the aim
is written as `entity(id).rotation`, so a parent under either one still leaves
the aim on the point named. Returns whether the rotation was written, and the
reason when it was not.
- `Transform.distance(x1, y1, z1, x2, y2, z2) -> number` — Euclidean distance between two points.
- `Transform.distanceBetween(entityA, entityB) -> number?` — distance between two entities' world positions. Nil when either is unresolvable.
- `Transform.direction(fromX, fromY, fromZ, toX, toY, toZ) -> (dx, dy, dz)` — unit direction vector.
- `Transform.directionBetween(entityA, entityB) -> (dx, dy, dz)` — unit world-space direction between two entities' world positions.
Rotation shapes:
A quaternion **constructor** here returns the four components as four separate
values, so a caller either names them or braces the call to make one table:
```lua
local qx, qy, qz, qw = Transform.quatFromAxisAngle(0, 1, 0, math.rad(90))
entity("cam").localRotation = { Transform.quatFromAxisAngle(0, 1, 0, math.rad(90)) }
```
A rotation-taking **surface** reads that table through
`Transform.toQuaternion`, which also takes euler DEGREES — so
`{ qx, qy, qz, qw }`, `{ x =, y =, z =, w = }`, `{ pitch, yaw, roll }` and
`{ pitch =, yaw =, roll = }` all mean the same thing wherever a rotation is
assigned: `entity(id).rotation` / `.localRotation`, `entityOps.spawn`,
`entityOps.transform`, and the capture viewpoints.
- `Transform.toQuaternion(rotation, label?) -> { qx, qy, qz, qw }` — the shared reading of a rotation a caller wrote. Raises when the value matches no form, naming what arrived; a value that is one of the shapes a quaternion helper returns is named as such along with the packing it goes in as.
- `Transform.tryQuaternion(rotation, label?) -> ({ qx, qy, qz, qw } | nil, message?)` — the same reading without raising, for a surface that wants to raise the message at its own caller's line.
- `Transform.readVec3(value, label?) -> { x, y, z }` — the same for a vector.
- `Transform.snapVec3(v, step) -> { x, y, z }` — quantize a vector to a step grid.
Quaternion construction / conversion:
- `Transform.quatFromYaw(yaw)`, `Transform.quatFromYawPitch(yaw, pitch)`, `Transform.quatFromAxisAngle(ax, ay, az, angle)` — quaternion constructors.
- `Transform.quatIdentity()` — identity quaternion.
- `Transform.euler(qx, qy, qz, qw) -> (yaw, pitch, roll)` and the named alias `Transform.quatToEuler`.
- `Transform.eulerToQuat(yaw, pitch?, roll?)` — euler-to-quaternion in YXZ order.
Lerps and interpolation:
- `Transform.lerp(ax, ay, az, bx, by, bz, t) -> (x, y, z)` — vec3 lerp.
- `Transform.lerp1(a, b, t) -> number` — scalar lerp.
- `Transform.normalizeAngle(a) -> number` — wrap angle into `[-pi, pi]`.
- `Transform.lerpAngle(a, b, t) -> number` — shortest-arc angle lerp.
- `Transform.slerp(ax, ay, az, aw, bx, by, bz, bw, t) -> (qx, qy, qz, qw)` — quaternion slerp with shortest-path and near-parallel fallback.
Quaternion operations:
- `Transform.quatMul(...) -> (qx, qy, qz, qw)` — `qa * qb` composition.
- `Transform.quatInverse(qx, qy, qz, qw) -> (qx, qy, qz, qw)` — inverse (= conjugate for unit quats).
- `Transform.quatRotateVec(qx, qy, qz, qw, vx, vy, vz) -> (x, y, z)` — rotate a vec3 by a quaternion.
Pose helpers:
- `Transform.orbit(centerX, centerY, centerZ, radius, height, angle) -> (x, y, z, qx, qy, qz, qw)` — orbital pose facing the center.
- `Transform.worldToLocal(...)` / `Transform.localToWorld(...)` — pose-space conversions.
Nested `Transform.vec.*` namespace (component-wise vec3):
- `Transform.vec.add`, `sub`, `scale`, `dot`, `cross`, `length`, `normalize`.
Types:
- `Vec3 = { x: number, y: number, z: number }`
- `EntityRef = string | { entityId: string }`
## Usage
```luau
-- Look-at by coordinates or by target entity:
Transform.lookAt("cam", 0, 1, 0)
-- an entity target resolves to that entity's world position
local aimed, why = Transform.lookAt("cam", "box")
-- Orbit pose around a point:
local x, y, z, qx, qy, qz, qw = Transform.orbit(0, 1, 0, 5, 2, t)
entity.find("cam").localPosition = { x, y, z }
entity.find("cam").localRotation = { qx, qy, qz, qw }
-- Quaternion math:
local qx, qy, qz, qw = Transform.quatFromYawPitch(math.pi / 4, 0)
local sx, sy, sz, sw = Transform.slerp(0, 0, 0, 1, qx, qy, qz, qw, 0.5)
-- Component-wise vec3 helpers:
local nx, ny, nz = Transform.vec.normalize(1, 1, 0)
```
## Notes
- The `--!global Transform` directive promotes the module's typed
functions onto the runtime universe's globals bucket, so `Transform.*`
is available without any per-source `require`.
- Entity-aware functions (`lookAt`, `distanceBetween`,
`directionBetween`) report a missing entity or a missing transform in
their return value rather than raising: `lookAt` answers
`false, "unresolved"` / `"no-transform"` / `"incomplete-target"` /
`"degenerate"`, `distanceBetween` answers `nil`, and
`directionBetween` answers zeros.
- Quaternion APIs operate on raw `(qx, qy, qz, qw)` tuples for parity
with the entity proxy's `localRotation.get`/`set`. Use
`Transform.quatIdentity()` rather than hand-rolling `(0, 0, 0, 1)`.
- `Transform.slerp` flips the second quaternion if `dot < 0` to take
the shortest path, and falls back to lerp+normalize when the inputs
are within `dot > 0.9995` to avoid `1/0` near-parallel issues.
# edui.inspector
The Inspector as an ordered list of **sections**. A subject — an asset, or a
component on an entity — gets generic sections, merged with the sections its
declarer's `inspector.luau` adds or replaces, in the order that file names.
```luau
local Inspector = require("@builtin::editor.edui.inspector")
local sections, ctx = Inspector.assetSections(ref, asset.inspect(ref))
local nodes = Inspector.render(sections, ctx) -- section cards
local nodes = Inspector.renderAsset(guid) -- the same, from an asset id
local sections, ctx = Inspector.componentSections(entityId, "Camera")
local nodes = Inspector.render(sections, ctx, { nested = true }) -- a component card's body
```
## Sections
A section is `{ id, title, icon?, open?, build(ctx) -> { node } }`. The generic
asset sections, in default order, are `identity`, `problems` (present only
when `asset.validate` reports any), `tags`, `move`, `settings`, `preview` and
`operations` (see `assetSections.module`). A type declares its
own in the file its `type.yaml` names:
```yaml
inspector: { type: "inspector.luau" }
```
That file returns `{ sections?, replace?, order? }`: sections it adds (placed
before `operations`), generic sections it replaces by id, and the ids to put
first. `material.assetType/inspector.luau` is a worked example, and
`@builtin::assetTypes.assetType.shared.inspector` documents the declaration.
A component on an entity has one generic section, `settings`: its public
fields as typed controls over the live component, three-number colour and
vector aliases as one grouped control, each edit checked against the schema
and written as one undoable operation. A component that ships an
`inspector.luau` beside its `init.luau` (named by `component.assetType`'s
`inspector: { instance: "inspector.luau" }`) adds, replaces and orders
sections of its card the same way; its sections read `ctx.component` and
`ctx.selection.id`. `SceneModule.component/inspector.luau` is a worked example.
A declaration that cannot be read, or that names a section that is not there,
shows its problem as a first `inspector-problem` section while every other
section still renders. Every build runs through
`Inspector.buildSection(section, ctx) -> (rows, problem?)`: a build that raises,
or returns anything but a list, shows its error inside that section alone.
## The Context
Every `build(ctx)` receives one Context, made by `Inspector.valuesContext`:
| Field | What it is |
|---|---|
| `ref` | the inspected asset (on an entity, the component asset) |
| `info` | `asset.inspect(ref)` |
| `schema` | `asset.schema(ref)`, `settingsOf` resolved |
| `schemaProblem` | why a declared schema did not resolve |
| `settings` | the current values |
| `setSettings(patch)` | checks the patch with `Field.checkSchema`, then writes it as one undoable operation named for the field; answers `(ok, violations)` |
| `rejected` | field path -> the message of its last rejected edit, for this subject only |
| `selection` | `{ scope = "asset" \| "entity", id, component?, name? }`; on an entity, `component` is the component's identity and `name` the name the entity lists it by |
| `component` | the live component proxy (entity scope) |
| `nameOf(id)` | the name an entity-reference field shows for an entity id (entity scope) |
| `widgets` | the edui framework table (`field`, `schemaField`, `section`, `button`, `text`, `vbox`, `hbox`, ...) |
| `keyPrefix` | the callback-key namespace for this subject |
| `refresh()` | rebuild the Inspector after a write that moves no revision |
| `actions` | when set, the ids of the Settings actions offered (`{ reset = true }`); nil offers every action that applies |
| `parts` | the building blocks a section composes: facts, lists, tables, asset and entity links, actions, a file opener, problems, swatches, a content-versioned cache, an lsp check and typed values (`parts.module`) |
`Inspector.valuesContext{ subject, schema?, schemaProblem?, values?, write, ref?,
keyPrefix?, info?, selection, component?, nameOf?, actions? }` is the one way to make a Context: `write(patch)`
performs a patch already checked against the schema.
## The rest of the API
- `Inspector.mergeSections(generic, decl, problem, file)` — the merge and order.
- `Inspector.componentSections(entityId, componentName)` — a component card's
sections and Context; `Inspector.componentSettingsRows(ctx)` is its generic
`settings` section's body.
- `Inspector.componentValuesSignature(entityId, componentName)` — text that
moves whenever one of the component's declared fields holds a different
value (an edit, an undo, a script's write); a panel folds it into its build
signature.
- `Inspector.typeSections(ref)` — the sections `ref`'s type declares, plus
Settings when it has values; what the inline editor under an asset chip shows.
No other generic section is built for it, so it runs no validation. Nil when
the type declares no `type:` inspector.
- `Inspector.render(sections, ctx, { nested = true })` — titled groups inside a
card, for the inline editor.
- `Inspector.signature(assetId)` — text that moves whenever what the asset
view shows can have moved: the asset folder's content version (the change
dispatcher moves it after a write inside the asset reaches its type's hook —
an edit, an undo or redo, a peer's write) and the settings values file's. A
panel folds it into its build signature; `edui.widgets.openEditorsSignature()`
is the same for every open inline editor.
- `Inspector.buildSection(section, ctx)` — runs one section's build and judges
it: `(rows, nil)`, or one error row and the problem text.
- `settingsSection.fields(ctx)` — the field rows of the whole schema without
the actions beneath them.
- `settingsSection.fieldRows(ctx, fields)` / `settingsSection.actionRow(ctx)`
— the two halves of `settingsSection.build`, for a section that shows part of
a schema and acts on all of it.
- The Context, Section and Declaration shapes are exported as types:
`Inspector.Context`, `Inspector.Section`, `Inspector.Declaration`.
- `Inspector.release(keyPrefix)` — forget the rejections, section
disclosures and parts state (action failures, file checks, and cached values
no other open Context read) kept under a Context's key prefix and the
prefixes nested in it; a closed inline editor calls it for its own.
- `Inspector.epoch()` — moves on every disclosure, rejection and write the
Inspector records; a panel folds it into its build signature.
- `Inspector.settingsSection` — the Settings section (`settingsSection.module`).
- `@builtin::editor.edui.inspector.presetActions` — the Settings section's
Save as preset / Apply preset… actions, and `presetsFor(declarer)`, the
presets whose target is a declarer. `preset.assetType/inspector.luau` is
the preset's own view: its target and its values edited through the
target's schema.
# assetType.shared.inspector
Which inspector a type declares for its assets, and the declaration that file
returns. The editor's Inspector (`edui.inspector`) reads it to add, replace and
order the sections an asset shows.
## The block
A type names its inspectors in `type.yaml`, with either key or both:
```yaml
# the Inspector for every asset of the type, a file in the type's own folder
inspector: { type: "inspector.luau" }
# a file each asset may ship in its own folder, for what that asset declares
inspector: { instance: "inspector.luau" }
# both
inspector: { type: "inspector.luau", instance: "inspector.luau" }
```
`type:` is what selecting an asset of the type shows. `instance:` applies to
the things an asset declares, never to the asset's own view: a component
names `instance: "inspector.luau"`, and a component that ships that file
shapes its card on every entity it is on. Each value is a `.luau` file name.
A block that is not a map, names another key, names neither key or names a
file that is not `.luau` is malformed; the assetType validator reports it as
`assetType.inspector_block`, and a `type:` file missing from the type folder
as `assetType.inspector_file_missing`.
## The declaration
The file returns a table:
```luau
return {
-- sections this inspector adds (before Operations)
sections = {
{ id = "summary", title = "Summary", build = function(ctx)
return { ctx.widgets.text{ text = "mode is " .. tostring(ctx.settings.mode) } }
end },
},
-- a generic section id -> the section shown in its place
replace = { tags = { id = "tags", title = "Labels", build = function(ctx) return {} end } },
-- section ids, first to last; ids it does not name follow in default order
order = { "summary", "identity" },
}
```
A section is `{ id, title, icon?, open?, build(ctx) }`; `build` returns the
section's body as a list of edui nodes. Any member of the declaration other
than `sections`, `replace` and `order` must be a function (a helper the file
exports). `material.assetType/inspector.luau` is a full example.
The Inspector rebuilds an asset's sections when the asset's files change. A
section that shows state held outside those files names it with a
`signature(ref)` member: text that moves when that state moves, read every
time the Inspector checks for a rebuild, so it has to be cheap.
`renderFeature.assetType/inspector.luau` folds in whether the feature runs
and its live settings, so a feature enabled or reconfigured from a script
shows in the Inspector as it happens.
## API
```luau
local InspectorDecl = require("@builtin::assetTypes.assetType.shared.inspector")
InspectorDecl.blockFor("material") -- { type = "inspector.luau" }
InspectorDecl.blockProblem({ other = "x.luau" }) -- why a block is malformed, or nil
InspectorDecl.declaresTypeInspector("material") -- true: the asset view reads one
local decl, problem, file = InspectorDecl.declarationFor(matRef)
local cdecl = InspectorDecl.instanceDeclarationFor(compRef)
InspectorDecl.shapeProblem(decl) -- nil when well-formed
```
`declarationFor(ref)` (and `typeDeclaration(typeName)`) read the `type:` file:
- `(nil, nil, nil)` when the type names no `type:` inspector;
- `(nil, problem, file?)` when the block is malformed, or the file is missing,
raises while loading, or returns the wrong shape — the problem names the
file and what is wrong with it;
- `(declaration, nil, file)` otherwise.
`instanceDeclarationFor(declarerRef)` reads the `instance:` file in the
declaring asset's own folder, and answers `(nil, nil, file)` when that asset
ships none.
# edui
The editor UI framework, on the CSS-parity `ui.*` surface. An editor-only
toolkit: panels author closures instead of callback ids, a dock shell over
`ui.*` native docking, and typed editor-chrome primitives. Gameplay and normal
world UI author raw `ui.*` trees and need none of this.
**`edui.guide` beside this file is how to use it** — creating a panel, the spec
it returns, how a panel is drawn and redrawn, the whole widget vocabulary, and
how a panel reaches the selection and the dock.
## What installs
- **`framework`** — everything under one table. From outside the package,
`require("@builtin::~edui.framework")`; inside it, `require("~.framework")`.
It carries `app`, `widgets`, `shell`, `topbar`, `query`, `fileDialog`,
`worldDialog`, `stats`, and the chrome primitives flat (`panel`, `tree`,
`field`, `section`, `text`, `button`, `menu`, …).
- **`app`** — maps a panel's closures to `ui.*` callback ids, dispatches to
them, and coalesces redraws.
- **`widgets`** — the primitives, plus the typed inspector layer
(`widgets.tree`, `widgets.fields`, `widgets.controls`).
- **`inspector`** — the Inspector as an ordered list of sections: the generic
asset sections, the Settings section and its actions, and the merge with
the sections a type's `inspector.luau` declares (`inspector.assetSections`,
`inspector.settingsSection`), and the building blocks those sections
compose (`inspector.parts`, reached as `ctx.parts`).
- **`shell`** — the dock: one `ui.*` `dockArea` holding a `dockPanel` per
registered panel, and the panel registry behind it.
## Referencing
- Inside this package, modules reference siblings with `~.` — e.g.
`require("~.app")`, `require("~.widgets.fields")`.
- Editor content built on the framework references it by package identity —
`require("~edui.framework")`, `require("~edui.shell")`.
# cascade
Pure-Luau `$variable` cascade resolver for theme tokens and styles. Walks
a theme table's tokens and styles, expands every `$tokenName` reference
into a literal value with cycle detection, and returns a flat result.
Used by `Z.theme.register` so the engine receives fully-resolved
`(token, value)` and `(selector, prop, value)` pairs — no runtime
variable indirection. Cycle detection surfaces broken theme inputs as
structured `register` errors instead of silently leaving `Variable(name)`
in place and producing garbage colors.
## Exports
- `M.resolveValue(value, tokens, visited, order) -> (any, string?)` — single-value resolver. Exposed for tests; not part of the typed surface.
- `M.resolveTokens(theme: any) -> (TokenMap?, string?)` — flatten `theme.tokens`. Returns `(nil, errMsg)` on first cycle / unknown reference.
- `M.resolveStyles(theme: any, resolvedTokens: any) -> (StyleMap?, string?)` — flatten `theme.styles` against pre-resolved tokens.
Types:
- `TokenMap = { [string]: any }`
- `StyleMap = { [string]: { [string]: any } }`
- `Theme = { tokens: TokenMap?, styles: StyleMap? }`
## Usage
```luau
local Cascade = require("@builtin::modules.zui.theme.cascade")
local tokens, err = Cascade.resolveTokens(theme)
if err then error(err) end
local styles, err2 = Cascade.resolveStyles(theme, tokens)
if err2 then error(err2) end
-- `tokens` and `styles` now contain no `$variable` strings.
```
## Notes
- Pure module — no engine calls, no module state. Safe to invoke during
any phase (boot, test, runtime).
- Error messages include the offending token / selector / prop so cascade
failures are diagnosable from the structured error alone.
- `resolveStyles` resolves against pre-flattened `resolvedTokens` (not raw
`theme.tokens`) so chained references (`$a → $b → c`) are already
collapsed by the time style values are walked.
- Numbers, booleans, and arrays pass through unchanged — only strings
beginning with `$` are treated as references.
# zui
> **Deprecated for authoring content.** `zui` predates the engine's CSS-parity
> `ui.*` surface and writes unlike CSS, producing flatter results. Author screens
> as raw widget trees (`{ type, style, props, children }`) styled with `ui.*`, and
> read `@builtin::examples.ui.*` for complete worked screens. `zui` remains in use
> internally by the editor; it will be rebuilt on the CSS-parity core.
Convenience UI library on top of the engine's `ui.*` Rust bindings.
Ships Layer 1 (per-widget builders), Layer 2 (theme tokens), Layer 3
(app lifecycle), router with unhandled-warning, pre-built shells, and
debug overlay. The engine's Rust UI surface is the substrate — `zui` is
one library on top of it. Any third-party Lua UI library can build on
the same primitives; the engine has no concept of "the zui library",
only widget types and a stable contract. See
[`docs/specs/ui-v3-architecture.md`](../../../../docs/specs/ui-v3-architecture.md).
## Exports
Layer 1 (widget builders) — short aliases on `Z.*`:
- `Z.lbl`, `Z.btn`, `Z.icon`, `Z.iconBtn`, `Z.iconButton`, `Z.chip`,
`Z.badge`, `Z.card`, `Z.colorSwatch`, `Z.dialogueBox`, `Z.kbd`,
`Z.input`, `Z.codeEditor`, `Z.slider`, `Z.dragValue`, `Z.checkbox`,
`Z.toggle`, `Z.dropdown`, `Z.datePicker`, `Z.radioGroup`,
`Z.selectableList`, `Z.image`, `Z.viewport`, `Z.progressBar`,
`Z.richText`, `Z.fader`, `Z.knob`, `Z.meter`, `Z.healthBar`,
`Z.hotbar`, `Z.minimap`, `Z.hbox`, `Z.vbox`, `Z.grid`, `Z.split`,
`Z.sides`, `Z.panel`, `Z.section`, `Z.scroll`, `Z.collapsible`,
`Z.window`, `Z.modal`, `Z.popup`, `Z.contextMenu`, `Z.scene`,
`Z.area`, `Z.anchor`, `Z.topPanel`, `Z.bottomPanel`, `Z.leftPanel`,
`Z.rightPanel`, `Z.centralPanel`, `Z.spacer`, `Z.flex`, `Z.sep`,
`Z.plot`, `Z.graph`, `Z.dndList`, `Z.canvas`, `Z.tabs`, `Z.tree`,
`Z.filterRow`, `Z.statRow`, `Z.statusLabel`, `Z.node`
- `Z.lsp` — LSP composite-widget namespace.
- `Z.fs` — Filesystem composite-widget namespace.
- `Z.widget` — full widget namespace (for explicit access).
Layer 2 (theme tokens):
- `Z.theme` — active default token table.
- `Z.themeWith(overrides)` — derive a theme with token overrides.
- `Z.themeNames()` — list known token names.
- `Z.Theme` — the underlying module.
Shared utils (re-exported):
- `Z.round`, `Z.fmt`, `Z.fmtVec3`, `Z.id`, `Z.eventValue`, `Z.map`,
`Z.when`, `Z.compact`, `Z.Utils`.
Layers 3-7 (app lifecycle + advanced features):
- `Z.app(name, builder)` — App lifecycle wrapper (`Z.App.create`).
- `Z.dynamic(list, fn)` — one-screen-per-list-item bucket.
- `Z.dataSource(fetchFn, opts)` — TTL + gated cached fetcher.
- `Z.highlight` — syntax-highlighting dispatch and per-language modules.
- `Z.shell` — pre-built shell shapes (docked, canvas, inspector).
- `Z.tags`, `Z.screens` — Luau-owned screen tag registry + lifecycle helpers.
- `Z.defineWidget(name, fn)` / `Z.unregisterWidget(name)` — register Luau builders for raw `{ type = name, ... }` widget tables.
- `Z.widgetState(id, key, default)` / `Z.widgetState.set(id, key, value)` — per-widget reactive state.
- `Z.VERSION`, `Z.SPEC` — version string and spec link.
## Usage
```luau
local Z = require("@builtin::modules.zui")
local C = Z.theme
local function tree()
return Z.centralPanel({
Z.topPanel({
Z.hbox({
Z.lbl("◈ MY APP", { color = C.accent, fontSize = 14, bold = true }),
Z.flex(),
Z.btn("Save", "save:click", { bg = C.accent, color = C.bg, bold = true }),
}, { style = { gap = 8, padding = { 6, 12, 6, 12 } } }),
}),
Z.section("CONTROLS", {
Z.slider("vol", 0.5, 0, 1, { onChange = "vol:set" }),
Z.btn("Reset", "vol:reset"),
}, { bg = C.panel, border = C.border, padding = { 8, 12, 8, 12 } }),
})
end
ui.registerScreen("my-app", tree(), 0)
ui.showScreen("my-app")
```
## Notes
- This module's surface is mostly re-exports: every `Z.*` widget alias
is `Widget.*` (see `widget.module/`), every theme alias is
`Theme.*`, every util is `Utils.*`. The aliases exist for ergonomics
only — explicit access via `Z.widget`, `Z.Theme`, `Z.Utils`, etc.
works the same way.
- The module registers a handful of `ui.defineWidget` handlers at
load time (tabs, card, sides, badge, colorSwatch, separator,
progressBar, iconButton, dialogueBox, hotbar) so raw
`{ type = "<name>", ... }` widget tables in existing demos and editor
tools keep rendering after their Rust-side definitions were deleted.
Re-running registration on hot-reload is safe — the engine replaces
the previous closure.
- `Z.defineWidget` requires the engine `ui` global; off-host execution
raises a clear error.
- `Z.widgetState` is a callable read path with a `.set` write
sub-method — no metatables on the caller side. Returns the `default`
when the engine global is missing.
- The library is built on a stable Rust substrate (`ui.registerScreen`,
`ui.getToken`, `ui.defineWidget`, etc.). Other Lua UI libraries can
build on the same substrate and coexist with `zui`; the engine has
no concept of a privileged library.
- See `docs/specs/ui-v3-architecture.md` for the full layered design,
Rust binding gaps, and follow-up roadmap.
## Tall content inside an anchored panel
A `Z.anchor("Center", ...) { Z.panel(rows) }` whose `rows` exceed the
viewport will silently clip top + bottom — the player has no scrollbar
and no way to reach the off-screen entries. Opt into in-place scrolling
on the panel:
```luau
Z.anchor("Center", {}, {
Z.panel(rows, { scroll = true, maxHeight = 480 }),
})
```
`scroll = true` wraps the children in a `scrollArea` so overflow stays
reachable. Without `scroll = true`, `maxHeight` only clips. See the
[panel README](widget.module/panel.module/README.md) for `scrollMaxHeight`,
header/footer pinning, and the full pattern (closes #3270).
# 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.
# 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.
# 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).
# 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.
# 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.