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

shared

What a `.scene` folder does when it is loaded, saved, built, or swapped.

by◐lumi·posted 2mo ago
What it does

scene runtime

What a .scene folder does when it is loaded, saved, built, or swapped.

A <name>.scene/ carries scene.json (the entity arrangement), an optional build.luau (the code author's half), an optional entrypoint.luau, and a scene_dirty/ overlay of unsaved edits. Reading, composing and writing all four is the scene type's own behaviour, so it lives in the type.

Sub-modules

ModuleResponsibility
loader.moduleReads scene.json v6 and v7, refuses versions it does not know, composes canonical + dirty overlay, spawns the entities, and runs the entrypoint.
saver.modulePersists scene state as a delta overlay against the canonical file, promotes that overlay on save, and answers which edits are still pending.
build.moduleRuns a build.luau inside an entity capture scope and composes what it spawned into scene records.
observe.moduleThe read side — the per-scene counts and costs layers and loader write.
swapOrchestrator.moduleDrives multiplayer room transitions and the scene-swap gate, so a local swap does not leak despawns to peers in the old room.

Reaching it

local rt = require("@builtin::assetTypes.scene.shared")
rt.saver.hasPendingSceneEdits(layers.active.name)

Fields resolve lazily. The prelude installs swapOrchestrator and starts saver's dirty writer in a fixed order, which a table that required all five on load would take away from it.

Interface

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

conforms to

zero/source-extract/v2

module SceneRuntime The scene runtime — what a `.scene` folder does when it is loaded, saved, built, or swapped. require @builtin::assetTypes.scene.shared about A `<name>.scene/` folder carries `scene.json` (the entity arrangement), an optional `build.luau` (the code author's half — see `scene.assetType`'s README), an optional `entrypoint.luau`, and a `scene_dirty/` overlay of unsaved edits. Reading, composing, and writing all four is what this runtime does, and it lives here because that is the scene type's own behaviour. | Field | Responsibility | |---|---| | `loader` | Reads scene.json v6/v7, composes canonical + dirty overlay, spawns the entities, runs the entrypoint. | | `saver` | Persists scene state as a delta overlay, promotes it to canonical, and answers what is still unsaved. | | `build` | Runs a `build.luau` in an entity capture scope and composes what it spawned into records. | | `observe` | The read side — per-scene counts and costs `layers` and `loader` write. | | `swapOrchestrator` | Drives multiplayer room transitions across a scene swap. | Fields resolve LAZILY. The prelude installs `swapOrchestrator` and starts `saver`'s dirty writer in a fixed order; a table that required all five on load would take that ordering away from it.

__index(self: ?, key: string) → void

argtypedescription
self?
keystring

Sub-parts

Everything contained inside this part. Assets are composite children (clickable cards). Files are leaf payloads. Expand any row to view its source.

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

103+items
▣
module · born here
❒asset
# Scene agent context Produces bounded authoring summaries for the open scene and publishes changed summaries through the scoped world-content context channel. `summary(status)` reduces the scene authoring status to retained-field counts, pending operation counts, conflicts, persistence state and up to three short errors. `update()` samples the root scene, caches its authoring reads by source checksum and persistence state, and publishes the result with the observed world, branch and scene identities. A rejected publication is retried on the next sample. The summary names `sceneAuthoring.reviewRecorded` for detailed review. Values are labelled world content in agent responses. `install()` starts one engine-lifetime sampler at quarter-second intervals, including while gameplay is paused. The prelude installs it on the engine thread. The sampler reads the current module on each sample, reports distinct failures, and retries publication. The response's `state.worldContext.values.sceneAuthoring` carries the summary under its world, branch and scene scope.
▲ 0↑ born
▣
module · born here
❒asset
# scene_build Turns builder code into scene records, and scene records into scene entities. `run(builder)` opens an entity capture scope, calls `builder`, and composes every entity it created into records — then despawns them. The builder writes ordinary spawn code; what comes back is data. A builder that raises leaves nothing behind. What a component the builder attached creates while running its own lifecycle belongs to that component: the record names the COMPONENT, and the same lifecycle runs again wherever the record is put back. That is what makes a nested build one build — a placement the builder makes runs its own module and owns what it lands, and the build around it describes the placement. `reconcile(records, target, owner)` applies records to the scene under `target`, writing `owner` and the record's place in the hierarchy onto each entity it places as the `buildOwner` / `buildKey` attributes. A rebuild reads that pair back off the entities under `target` and lands on the same ones, so nothing has to be remembered between two rebuilds — the pair is in the scene, and a reload brings it back with the entity. It returns the ids it landed on, keyed by record identity. A record is identified by its place in the hierarchy — the chain of names from the build root down to it, `base/coin_3` — so dropping a line from the middle of a builder, inserting one, or emitting two entities in the other order leaves every other entity's id where it was. Children of one parent that share a name carry their rank among those, `base/crate#2`, counted in the order the builder created them. Together these are the bake: code in, durable static-id scene content out. ## Who states an entity An entity names the build that placed it, so `ownerOf(id)` answers which build owns it — and answers nil for an entity an author spawned. `sourceOf(owner)` names the file that build is written in, from the `source` the reconcile running it passed. That pair is what makes ownership legible where an author meets it. `notePreview(id, values)` records what an entity carries after an author's change and `takePreview(id)` reads it back exactly once, in the run that states the entity again, which is where what the author set and what the build says can be named side by side. ## What a rebuild keeps Every entity a build places records what that build stated about it. A rebuild whose code states a value the way the last build did leaves that value as the scene holds it, so a hand edit to a built entity (a move, a rename, an attribute, a component field) survives every plain rebuild. The scene's build answers for all of it: ```lua local report = layers.active.asset:build({ save = false }) print(report.message) -- opens with one line counting all four lists ``` `kept` lists the hand edits to entities the build placed, `driven` the fields another component writes at runtime, `handAdded` the components and attributes added by hand to built entities, and `handPlaced` the entities no build placed. `layers.active.asset:build({ restate = true })` lands every value `build.luau` states over the kept ones. `reconcile(records, target, owner, { restate = true })` is the same at this level, and its third return value is the `kept` list. `kept` covers every value a build states about an entity it placed: its name, internal flag, transform, active flag, lifecycle mode, replication scope, synced flag, attributes and components. A restate writes exactly those: a number the scene holds within the precision a saved record keeps, and the bookkeeping a component writes about its own runtime, stay as they are. `drift()` reads the entity's own values alone; the build's report is the whole answer. `guides { path: "core/scenes-as-code" }`, "What a rebuild touches", gives the shape of every entry.
▲ 0↑ born
▣
module · born here
❒asset
# Scene composition Require `@builtin::assetTypes.scene.shared.composition`. `compose(generated, intents, settingsEdits, options, previous?)` computes a candidate scene document. Each entry in `intents` is keyed by persistent entity id and contains `edits` over the value returned by `SceneRecords.saved`. An entry can also carry captured `bookkeeping` for component additions. `settingsEdits` addresses the scene document with its entities field removed. Options supply `componentGuid(typeName)` and `componentName(guid)` resolvers. `externalEntities` explicitly identifies entities supplied by an enclosing composition. The result contains `candidate`, `document`, `blocked`, `conflicts`, and satisfied paths per entity. Field conflicts retain authored values. Missing edited entities, invalid parent graphs, dangling declared entity references and missing component-reference targets block the candidate. A blocked result returns an independent copy of `previous` as its visible document. Its edits remain the caller's durable input. `planMigration(canonical, visible, generated?, options)` converts a legacy saved scene and its composed dirty state into a generated baseline, entity intents and settings intents. It validates that composing these inputs preserves every normalized visible entity and scene setting. Supply a recovered build baseline where available. Without one, retained content becomes authored additions and the plan reports unresolved baseline identities. Legacy deletions remain explicit intents even when only the saved record supplies their prior values. Build identity metadata survives on retained additions. The function writes no files; the migration coordinator owns source snapshots, revision checks, recovery and activation. The composer validates entity references declared by captured `entity_fields` annotations and component-reference envelopes. Component schema and asset-specific validation belong to the caller's semantic validation pass. The function computes data; the caller chooses when to commit and activate that data.
▲ 0↑ born
▣
module · born here
❒asset
# Scene composition transactions `capture(folder, inputs)` reads a scene and its authored records under a world-bound source transaction. Capture build inputs before evaluating the builder, and pass the resulting document to `rebuild`. `edit` accepts saved entity records before and after an authored change. Both compose and validate before preparing an atomic update of the accepted generated base, intent records, and `scene.json`. `editChanges(snapshot, entities, settingsEdits, opts, retirePaths?, attribution?)` accepts compact observed field changes. Each entity row has `id`, `changes` from `FieldEdits.diff` over normalized records, and optional component `bookkeeping`. Settings use field edits over the scene fields. Changes retain their original observed values when retried against a newer snapshot. `retirePaths` names captured journal files removed atomically with the accepted composition; a newer journal revision makes the entire transaction stale. `editDocument` projects saved documents into this same field-change path. Journal consumers pass a session/sequence receipt to `editChanges` with the corresponding captured operation path in `retirePaths`. The coordinator checks the consecutive sequence, records its checksum in accepted state and retires that source atomically. Rebuilds preserve these receipts. `assetTypes.scene.shared.journal` handles operation creation, persistence, recovery and retry checks. `migrate` accepts a legacy visible document derived from the captured scene and overlay, together with a recovered generated base when available. It retains the canonical and visible documents as recovery history and records unresolved baseline identities. `incorporate` prepares source replacements together with selected intent retirement. Each selection names an entity (or scene settings), the captured intent revision, and exact field paths. The candidate generated value must reproduce every selected value. Unselected intents remain. Candidate source fingerprints, the generated base, build digest and artifact advance together. For a loaded scene’s `build.luau`, `scene:prepareSourceChange(sourcePlan, selections)` evaluates the candidate from `SourceEditing.prepareTarget`. It returns the coordinator plan together with the target’s scope and known outputs. Candidate evaluation uses isolated capture: persistent writes, external requests, deferred task work and foreign-entity changes are refused. Component lifecycle work on candidate-owned entities is captured and cleaned up. `awaitApplied(folder, revision, scope)` waits for an accepted complete revision to arrive through the local subscription. A committed result acknowledges backend persistence; this wait establishes local visibility. `commit` returns the durable source-operation result. Its operation identity supports inspection, retry and cancellation through `modules.sourceOperations`. Runtime scene activation observes the committed files. Structural conflicts return a plan with `ready=false` and preserve the last valid document.
▲ 0↑ born
▣
module · born here
❒asset
# Authored scene copies Prepare a guarded copy of an authored scene with fresh contained-asset identities, relocated JSON references and exact static Luau references, preserved authored records, and updated source bindings. Preparation leaves the destination untouched. Unsupported or ambiguous internal reference forms are refused before commit. `prepare(source, destination)` returns a source transaction; `commit(plan)` persists it and observes the copied scene identity and artifact.
▲ 0↑ born
▣
module · born here
❒asset
# Scene intent storage Require `@builtin::assetTypes.scene.shared.intents`. The store keeps one versioned JSON record per entity under a scene's `authoring/entities` folder. The filename is the entity id encoded as UTF-8 hex; the record carries its readable id, revision, field edits, per-edit attribution and component reconstruction metadata. 1. `read(sceneFolder, entityId)` captures the current record and exact source identity/bytes in a frozen snapshot. `readAll(sceneFolder)` discovers every entity record, including manual additions, and verifies that each filename matches its entity id. 2. `prepare(snapshot, generated, previous, current, bookkeeping?, attribution?)` records an operation over normalized SceneRecords values. Use the accepted generated base and the visible values before and after the operation. Independent fields merge with existing intent. Overlapping unseen changes return a conflict for the caller to retain and resolve. 3. `apply(plan)` creates an absent file with `overwrite=false`, or updates it through sourceEditing's snapshot check. A stale plan leaves the newer file intact. Empty intent records retain their revisions. `prepareChanges(snapshot, generated, changes, bookkeeping?, attribution?)` accepts field changes produced by `FieldEdits.diff`. Each change retains its observed and proposed values. It composes those changes over the latest accepted intent, preserving independent fields and returning conflicting values for overlapping edits. Entity identity and the settings document shape are validated before a prepared result is returned. `prepare` computes these changes from its before/after values and uses the same path. `readSettings(sceneFolder)` reads the scene-wide record at `authoring/settings.json`. Pass that snapshot to `prepare` with the scene fields after removing `entities`, then `apply` the prepared result. All three settings values must be tables. Settings carry their own revision, and entity enumeration remains scoped to entity records. Supply the returned settings edits to `SceneComposition.compose` alongside the entity intents. Version 3 stores field history as a readable JSON array under `edits`, one entry per field edit with its earlier and later values, and exposes active dependencies through `references`. The references describe the merged visible entity, including component identities and asset envelopes; the scene asset type declares `references` as the only field of these files that carries dependencies, so an asset a historical value names stays data. Historical values remain available for conflict detection. Reads accept version 1 records and version 2 records, whose history is an encoded string; the next changed operation, and a scene copy, writes version 3. Opening a scene rewrites nothing. Snapshot records expose decoded field edits to callers. `unpackSettings(source)` and `packSettings(record)` decode and encode a settings file in that form. Scene inspection exposes a bounded `authoring` summary, also available through `sceneRef:authoringStatus()`: recorded pending scene edits, entity intent and field counts, settings field count, and explicit read errors. `complete` indicates that these reads succeeded; the summary observes recorded state without draining queued scene writes. `hasRecordedEdits` indicates that at least one recorded change exists. These counts include retained satisfied intents. The returned VFS report distinguishes durable source, play shadow and scratch. This per-file operation uses the world's existing synchronization and conflict protocol. Callers coordinate these records with build sources and generated artifacts.
▲ 0↑ born
▣
module · born here
❒asset
# Observed scene operations SceneJournal stores field edits with their original observed and proposed values. Each entry belongs to a world, branch, scene GUID and unique editing session. Session sequence numbers order operations under `scene_dirty/operations/<session>/<sequence>.json`. `session()` creates a session token. `create(snapshot, session, sequence, previous, current, resolvers, attribution?)` normalizes the two scene documents and records their field differences. `append(sceneFolder, entry)` writes an immutable entry; it returns the path and whether an accepted receipt already settles the entry. Reusing a pending sequence with different bytes is refused. The latest retired sequence can be retried with identical bytes; older retired sequences are refused. `createChanges(observed, session, sequence, entities, settingsEdits, attribution?)` records incremental normalized changes. `observed` carries the scene GUID, world, branch and accepted revision. The live scene writer uses this form for changed entities and settings. `visible(sceneFolder, resolvers, session?, previous?)` composes pending entries over the locally accepted artifact. An optional session restricts which pending values are shown. Conflicts identify their journal operation. Structural conflicts retain the supplied previous complete document, or the accepted artifact. The read leaves all source files unchanged. `resolveFields(snapshot, path, resolutions, resolvers)` chooses values for exact changed fields. Each selection has an entity id (omit it for scene settings), a field path and a `recorded` or `accepted` choice. Other proposed changes remain. Every remaining conflict must be resolved before the transaction is ready, and duplicate or absent field selections are refused. `review(snapshot, resolvers)` returns captured operation rows, their recorded changes, current conflicts, and whether an earlier entry in the same session must settle first. `resolve(snapshot, path, choice, resolvers)` prepares a resolution of one whole reviewed operation. Choose `recorded` to retain its proposed fields against the reviewed accepted values, or `accepted` to keep those accepted values. Structural validation still applies. The resulting transaction checks the reviewed source revisions and retires only that operation with its receipt; a stale resolution leaves it intact. `prepare(latestSnapshot, path, resolvers)` recovers the captured entry, verifies its identities and predecessor, and prepares a scene transaction. Commit it with `SceneCoordinator.commit`, then use `awaitApplied` before reading the accepted revision locally. Successful commit updates the artifact and authored intents, removes the consumed journal entry, and records its sequence and checksum atomically. A stale operation, validation failure or field conflict retains the entry for inspection and resolution. The accepted scene state retains one receipt per editing session.
▲ 0↑ born
▣
module · born here
❒asset
# `scene.shared.loader` Luau-side scene loader. Reads `scene.json` v6, dispatches to engine FFIs, runs the sibling `entrypoint.luau`. ## Public surface ```lua local loader = require("@builtin::assetTypes.scene.shared.loader") loader.load(ref, opts?) -- ref: AssetRef<scene> | identity string | VFS path -- opts.layer: layer name (default "main") -- Returns: the Scene proxy (with player_config + camera_config attached). loader.unload(layerName) -- Wrapper around layers.unload(name); symmetric to M.load. -- Cannot unload "main". ``` ## Behavior 1. Resolve `ref` to a VFS path; append `/scene.json` if needed. 2. `vfs.read` + `Json.decode` (from `modules.json`) → body table. 3. Version check — refuse anything but `version: 6`. 4. Attach `body.player` + `body.camera` to the Scene proxy as `player_config` / `camera_config` (consumed by player_spawner + camera_spawner). 5. Activate the target layer via `layers.find(layerName)` (the loader threads the layer through `entity.spawn` opts), spawn `body.entities` in two passes (shells + transforms first, parents + components second), then restore the previous active layer. 6. Apply `body.lighting` via `lights.setup` + `lights.addPointLight`. Field name mapping: `directional` → `sun`, `clear_color` → `clearColor` (both engine API names and v6 field names are accepted). 7. Auto-discover sibling `entrypoint.luau` via `vfs.exists`; if present, compile with `loadstring` + run. ## Performance ~5 ms for a 1000-entity scene (≈5k FFI calls × ~1 µs each). Acceptable for a load-time operation. If a particular call class becomes hot, batch primitives can be added in a narrow follow-up. ## Why pure Luau Per § 10 of the unification integration design, the scene format is data + dispatch — no Rust-only primitives needed. The existing ECS FFI (`entity.spawn`, `entity(id).component.add`, etc.) covers everything. Keeping the loader in Luau means iteration speed, auditability, and hot-reload. ## FFI corrections vs. the original plan The plan was drafted against assumed API names. The actual engine FFIs differ: | Plan assumed | Actual engine API | |---|---| | `json.parse(s)` | `require("..json").decode(s)` (`modules.json`) | | `json.encode(t)` | `require("..json").encode(t)` | | `entity.spawn(n, { layer }).id` | layer activation via `layers.find(layer)` + `entity.spawn(n, opts).id` | | `entity.setParent(id, pid)` | `entity(id).setParent(pid)` | | `unloadLayer(name)` | `layers.unload(name)` | | `lights.setup({ directional })` | `lights.setup({ sun })` | | `lights.setup({ clear_color })` | `lights.setup({ clearColor })` | | `lights.addPointLight(table)` | `lights.addPointLight(name, x, y, z, opts)` | The loader accepts both the v6 field names and the engine API names for the lighting fields so that round-tripping through the scene saver and back works without a conversion step.
▲ 0↑ born
▣
module · born here
❒asset
# scene_observe The record of what a scene load did, and what each loaded scene costs. Backs `layers.observe`, `layers.lastLoad`, `layers.lastUnload`, `layers.loadHistory`, `layers.problems`, `layers.whyPartial`, `layers.inventory`, `layers.cost` and `layers.resetCostWindow`, and the `scene` toolbox's `observe`, `whyPartial` and `cost` above them. `layers` and `scene_loader` are its writers. ## One record per load A load opens a record; the loader, the lifecycle dispatchers and the scene's own build write their failures and phase timings into it; the load's own completion point closes it with the duration the engine already measured for its `DONE` line. Reading is lazy — nothing here walks the world, and the only writer that runs every frame is `noteUpdate`, which the entrypoint tick calls once per scene that declares one. ```lua local r = layers.lastLoad() print(r.name, r.outcome, r.durationMs) print(r.entities.added, "arrived,", r.entities.removed, "left") print(r.phases.teardown, r.phases.instantiate, r.phases.settle) ``` `outcome` is `"ok"` when everything the scene declared was produced, `"partial"` when the load finished with failures in it, `"failed"` when the load raised and left no layer, and `"unchanged"` when the scene asked for was already the active root — that load rebuilt nothing, so the layer keeps the record of the load that built it and still answers why it is not whole. `reason` names the nearest cause from the closed set — `loaderRaised`, `entrypointCompileFailed`, `entrypointBodyRaised`, `entrypointRaised`, `buildRaised`, `entityFailed`, `parentMissing`, `parentRefused`, `parentAbandoned`, `componentUnresolved`, `componentRefused`, `subscriberRaised`, `updateRaised` — ranked so it names the thing to fix rather than the last thing to break. ## Failures reach the layer they belong to Every write of a failure calls the subscriber `layers` registers through `M.onFailure`, which republishes the record onto that layer's proxy: `ok` false, `failures` the records, and `"partial"` in place of `"ready"` once the layer has settled. A tick that starts raising on frame 400 moves the layer the same way one raised during the load does. A failure identical to one already held raises that one's `count`, so a tick raising every frame keeps one record. `FAILURE_LIMIT` bounds the distinct records a report holds, and `failuresOmitted` states how many arrived past it. ## Cost `noteUpdate` accumulates each layer's entrypoint tick into a per-guid entry — calls, total, last, max, average and how many raised — summed across the window `M.window()` reports. `M.resetWindow()` opens a new one, leaving the load history alone. An unload drops the layer's entry.
▲ 0↑ born
▣
module · born here
❒asset
# Scene record projection Require `@builtin::assetTypes.scene.shared.records`. `saved(record, componentGuid)` converts a persisted entity into `{value, bookkeeping}`. `captured(record, ids, componentGuid)` converts an entity-record capture and remaps captured entity references to persistent placement ids. The resolver receives a component type spelling and returns its stable identity; unresolved types must raise an error. Captured entities require an entry in `ids`. `value` holds editable fields with normalized transform and lifecycle defaults. Components are grouped by stable type identity: `named[name]` addresses one named instance, while `anonymous` preserves an ordered group. Saved `instance_index` markers are reconstruction metadata, and restoration emits them alongside named `instance_name` markers. FieldEdits treats that anonymous array atomically. Asset references compare by guid and type. Component references retain their entity, instance information and stable component type. `bookkeeping` holds build ownership attributes, component order, and captured reference paths and row-field declarations. These capture annotations describe reconstruction and stay outside field comparisons. Compose edits over `value`, then call `restore({value=composed, bookkeeping=current.bookkeeping}, componentName)` to produce the saved record. The reverse resolver supplies the current component type spelling. Surviving instances retain their order; added instances are appended in deterministic order. The module validates structured input before copying it. Duplicate named instances and missing identities fail before any scene mutation.
▲ 0↑ born
▣
module · born here
❒asset
# `scene.shared.saver` Luau-side scene saver. Writes `scene.json` v6 — **authored intent only**. No captured runtime state. ## Public surface ```lua local saver = require("@builtin::assetTypes.scene.shared.saver") saver.save(name, opts?) -- name: logical scene name ("main") OR full VFS path -- opts.layer: layer name to read from (default layers.active.name or "main") -- Returns: the absolute VFS path written. ``` ## What is captured | Field | Source | Notes | |---|---|---| | `format`, `version` | constants | Always `"scene"` + `6`. | | `entities` | `entity.findAll()` walk | Excludes `temporary` entities + the spawner-managed Player + primary Camera. | | `entities[].transform` | local position / rotation / scale | NOT world transform — local only. | | `entities[].components` | component.list + component.get | Strips `_`-prefixed runtime fields. | | `entities[].attributes` | `attribute.list` + `attribute.get` | The entity's key/value bag, written as a `{ [key] = value }` map; omitted for an entity that holds none. Holds the authored keys — a `_`-prefixed key is the engine's own session bookkeeping. | | `lighting` | `lights.snapshot()`, filtered | Scene-level `clear_color` + `sky` only. Directional / ambient / point lights persist as `Light` entities in `entities[]`. | | `player` | `sceneProxy.player_config` | Carried forward from load-time, authored only. | | `camera` | `sceneProxy.camera_config` | Carried forward from load-time, authored only. | ## What is NOT captured - Local player's position / rotation. Runtime drift; not authored intent. - Primary camera's transform. Runtime; behavior-driven. - Any entity flagged `temporary = true`. Debug helpers, runtime markers. - Internal component fields prefixed with `_` (e.g. `_velocity` on CharacterController). The spawner-managed entities (Player + primary Camera) are excluded because they're created on load by player_spawner / camera_spawner from the scene's declarative `player` + `camera` blocks. Saving them would double them on the next load. ## Parts The module is a folder of parts, each a module of its own that `init.luau` requires: - `scene_saver.serialize`: one live entity as the record a scene file carries. - `scene_saver.recordDiff`: the comparisons the record diffs are built from. ## When to use `layers.active:save(name)` (Phase 6) routes through this module. Callers that want a state snapshot (save-game systems, undo stacks) should use `world.debugSaveToDisk(...)` instead — that captures runtime state by design.
▲ 0↑ born
▣
module · born here
❒asset
# @builtin::assetTypes.scene.shared.swapOrchestrator Owns the user-scope orchestration for scene swaps: leaves the prior scene's multiplayer room, gates concurrent loads via the `__scene_load.begin/finish` token, drives `scene_loader.M.load` for the new scene, and joins the new scene's room. Keeps the swap atomic from a multiplayer-sync standpoint (room transition + entity churn happen inside a single barrier).
▲ 0↑ born
·
assettype · born here
❒asset
# Module (asset type) A module is a reusable, stateless (or globally-stateful) Luau library that other code pulls in with `require()`. Modules are the unit of factored-out logic in a world: helpers, math libraries, format parsers, registries, shared algorithms. ## When to use one - You have logic you want to share across multiple components, services, scenes, or tools. - You have a registry, lookup table, or shared cache that callers all read from / write to. - You want a stable API surface (`M.fn`) other code can depend on. If the logic is bound to one entity, use a `.component`. If you want a named UI of fields rather than functions, use a `.preset`. ## Where it lives - Source: `/zero/source/.../<name>.module/` - Identity: the source path with `/` written as `.` and each segment's type suffix dropped — `/zero/source/demo/beats.module` is `demo.beats`, and `/zero/source/kit.package/beats.module` is `kit.beats`, the container's name kept and its `.package` suffix gone. `asset.create` returns this string, `asset.resolve(...).identity` reads it back, and the `require` forms below write it as `<identity>`. - Folder shape: - `init.luau` (or `init.lua`) — module body. **Required.** Returns a table (conventionally named `M`). - `README.md` — instance-level documentation. **Required.** - `.metadata` — agent-editable tags + free-form fields. **Required.** ## How to create one ```luau asset.create("module", "<name>") -- Creates: /zero/source/<name>.module/ -- init.luau (canonical `local M = {} … return M`) -- README.md (instance README template) -- `folder` places it in a subfolder of /source, and that subfolder -- leads the identity: `{ folder = "lib" }` produces `lib.<name>`. -- `into` authors it inside a resolved container (a package, a toolbox), -- whose own identity leads the same way: asset.create("module", "<name>", { folder = "lib" }) asset.create("module", "<name>", { into = asset.resolve("myPkg.package") }) ``` ## How it operates 1. **Registration.** Writing `init.luau` into a `.module/` folder indexes the asset and registers the module path with the resolver. 2. **Loading.** The first `require("<identity>")` runs the file's body and caches the returned table. Subsequent requires from anywhere return the **same table** — this is the shared-state lever for "module-local" registries. The body runs in an environment of the module's own: a name it declares without `local` is readable by the module's own functions and by no other script, so an export reaches its callers through the returned table and nothing else. Requiring a component's folder runs its chunk the same way, once, and its `update`, `start` and `public` stay in that environment; a component runs on an entity through `entity(id).component.add(name)`. 3. **Hot reload.** Editing the file re-runs the module body and folds what it returns into the table already loaded, so that table keeps its identity: a caller that captured it with `require` reads the new source's functions and values through the reference it already holds, and a later `require` returns that same table. A key the new source drops goes away; a key something set at runtime stays. The body's own `local`s start again from their initial values, so state that must outlive an edit lives in `modules.state()` (`guides { path: "core/scripting-and-tasks" }`). 4. **Identity resolution.** A module is reached by its `<identity>`, and where the caller lives decides which spelling of it resolves. For a module in a **world**, from a caller in that same world — another module, a component, a scene entrypoint, or an `execute` chunk: - `require("<identity>")` — the identity on its own, resolved against the caller's own root. It carries every folder segment, so a module created with `{ folder = "demo" }` is `require("demo.beats")`. - `require("@root::<identity>")` — the same root-relative resolution, written out. - `require(".sibling")` — a module in the same folder, by its bare name; `..name` steps up one folder, `...name` two. Logs, stack traces and hot-reload notices name that same module `@local.source.<identity>` — its key under the world source root. The `<identity>` tail of that key is the form above, so a trace reading `@local.source.demo.beats` is `require("demo.beats")`. For a module in a **library** — content under `/zero/source/libs/@<lib>/` — `@<lib>::` addresses that library's root from anywhere: `require("@builtin::modules.transform")`. Mounting a world as a library moves its files under such a root and flips the caller root to `@<lib>::`, which is what keeps the root-relative forms above resolving across the move. ## Discovery - `asset.list("module")` — every registered module. - `asset.inspect("<name>")` — public functions, source path, this type README. - `ls /zero/source/<name>.module` lists the files the folder holds. ## Authoring conventions - Return a single `M` table from `init.luau`. Top-level statements with side effects run on first require — useful for one-time initialization, dangerous if they touch the engine before it's ready. - Write exported functions as `typed function`, not `function`: the argument types are enforced at the call and the checker knows the signature, so a caller's mistake is reported where they made it. - Annotate exported functions with `--!desc` / `--!arg` / `--!return` / `--!example` so the LSP, `tools.list`, and `asset.inspect` surface them. A function with no `--!desc` is reachable only by someone already reading this file. - Declare a VALUE with `Field.<kind>(default, mode, description)`, and a table whose members are reached through a metatable with `--!members <TypeName>` — the latter gives the surface its accepted member set, its type, and its documentation from one table. See `guides { path: "core/authoring" }` for all four rules and `modules/api/engine/entity.module/members.module` for a worked member table. - Keep module state in module-local upvalues or in `modules.state()`. A name the body declares without `local` lives in the module's environment, which every run of the module shares: a function the previous run left in place reads what the reload assigned. Module-locals start again from their initial values with each hot reload; the table `modules.state()` returns is the same table on both sides of every reload. - Prefer focused modules over kitchen-sink modules. If two halves of a module have no shared state, split them. ## Common pitfalls - **Cyclic requires.** A `require` chain that loops will return the partial table (the half built before the cycle was detected). Design for one-way dependencies. - **Engine-time side effects.** Don't `entity.spawn` at module top-level — the engine may not be ready. Expose an `M.init` and call it from a scene entrypoint. - **Hot-reload + module-local cache.** A module that caches expensive computation in upvalues loses that cache on reload — fine for dev, but be aware in performance work. - **`init.lua` vs `init.luau`.** Either works, `.luau` is canonical. - **Writing one while play runs.** A `/source` write made while play is running lands on the play shadow, and a guarded play-exit discards it unless it is kept. One `.module` write shadows `init.luau`, the `README.md` and the `.metadata` together. `vfs.write(path, bytes, { durable = true })` skips the shadow, and `vfs.promotePlayShadow` keeps what is already on it — the `core/vfs` guide has the model and what each route costs. ## Related types - `.component` — for entity-bound state + lifecycle hooks. - `.service` — generates content you don't have yet (a mesh, sound, texture, …) via a metered provider. - `.tool` — for a single agent-callable function with a YAML schema. - `.package` — to group several modules + components + scenes into one shippable folder. ## In the Inspector Exports: what the module exports (name, kind, signature), parsed from its source without running it, with **Check** (the LSP's diagnostics for its entry file) and **Open**.
▲ 0↑ born
▣
module · born here
❒asset
# scene_saver.recordDiff The comparisons the saver's record diffs (`transformDiffLines`, `recordDiffLines`, the pending scene edits) are built from. - `diffEqual(a, b)` and `valuesEqual(a, b)` compare two record values, numbers within a tolerance that absorbs the f32 round trip of a live read. - `componentMatchName(t)` answers the name a component type matches by, whichever spelling the record used; `componentList(rec)`, `componentMatchNameOf(c)`, `componentInstanceLabel(c, typeName)` and `componentData(c)` read a record's components the way the comparison needs them, answering empty for a malformed record. - `selfWrittenFieldSet(entityId, componentType, instanceName)` answers the fields a component instance wrote about its own runtime. - `pushAttributeDiffLines(oldRec, newRec, push)` hands `push` one line per attribute added, changed or removed. ```luau local RecordDiff = require("@builtin::assetTypes.scene.shared.saver.recordDiff") assert(RecordDiff.diffEqual({ 1, 2 }, { 1.00001, 2 })) RecordDiff.pushAttributeDiffLines({ attributes = { hp = 1 } }, { attributes = {} }, print) -- - attribute.hp ```
▲ 0↑ born
▣
module · born here
❒asset
# scene_saver.serialize One live entity as the record a scene file carries, and the reads the saver asks of a live entity while it decides what to record. - `serializeEntity(id, parentById)` answers the record for a live entity: its name, parent reference, transform, components (each field value serialized), participation, network scope, render layer and attributes. A field holding a runtime GPU handle is reported once, with the remedy, and left out of the record. - `serializeFieldValue(v)` answers one component field value as a record states it, with the reason when the value has no record form. - `entityDisplayName(id)` answers the name an entity is shown by, and `entityIsTemporary(id)` whether it is marked as never saved. ```luau local Serialize = require("@builtin::assetTypes.scene.shared.saver.serialize") for _, e in ipairs(entity.findAll()) do print(Serialize.serializeEntity(e.id).name) end ```
▲ 0↑ born
·
assettype · born here
❒asset
# assetType (asset type) An asset type says what a kind of asset is: the files an asset of the kind is made of, the code that gives it behaviour, the interface a person uses to work with it, and how it is found, pictured and checked. A `<typename>.assetType/` folder declares a type called `<typename>`, and every `<name>.<typename>/` folder is an asset of it. `assetType` is itself a type, so a type is an asset like any other: it is created, versioned, installed and contributed the same way. ## Making a type `asset.create("assetType", "<typename>")` scaffolds a type. The type registers the moment its folder is written, anywhere under `/zero/source/`, and from then on `<name>.<typename>/` folders are its assets. An asset of a type that is not registered yet is not an asset, so make the type first. A type folder is a root: `~.x` in any file inside it names the type's own `x`, wherever the type is installed. Keep the type's whole implementation inside its folder and reach it that way. What a type folder must hold is set by this type's own `type.yaml`, the same way every type's `type.yaml` sets what its assets hold. `asset.validate` on a type reports anything missing, and the scaffold produces a folder that passes. ## What sets your type's schema (`type.yaml`) `type.yaml` is the structural contract every asset of the type is checked against. The keys below are the ones the engine reads; a key not listed here is ignored. | Key | What it controls | |---|---| | `suffix` | The folder suffix of the type's assets. Defaults to `.<typename>`. | | `primary` | The file or files that are the asset's content: what the asset resolves to when it is used. | | `entry_files`, `primary_aliases` | Further files that load as the asset or share its identity. | | `is_container` | Whether the suffix stays in the identities of what the asset holds. | | `is_opaque_walker` | Whether a walk of the tree stops at the asset and registers only its primary. | | `plural_dir`, `classify_exts` | Loose files in a folder of this name, or with these extensions, are assets of the type. | | `is_text_default` | Whether the asset's files are text unless stated otherwise. | | `broadcasts_subassets` | Whether assets nested inside an asset of the type are found by their own short name. | | `root` | `true` makes every asset of the type a root, so `~.x` inside one names that asset's own `x`. | | `contract_ref: { field, category }` | A key of the primary file that names another asset the asset is built on. | | `files: { required, optional }` | The files an asset holds (below). | | `allow_unlisted` | `false` reports every file the type does not declare. | | `aliases_from: [{ file, key }]` | Further names an asset answers to, read from its own files. | | `settings:` | Typed per-asset settings (below). | | `inspector:` | The interface people use for the type and its assets (below). | | `preview:` | How an asset is pictured (below). | | `references:` | Names of other assets the type's files carry (below). | | `indexing:` | What search reads for each asset (below). | | `describe:` | How a missing description is generated (below). | ### The files an asset holds Each entry under `files.required` or `files.optional` is `{ path, kind: file | folder, one_of_group?, content? }`. `*` in a path matches within one segment. Entries that share a `one_of_group` are satisfied by any one of them. `content` lists checks on the file's bytes: | Check | Passes when | |---|---| | `non_empty` | the file has content | | `json_field { key, type?, non_empty?, accept? }` | the JSON holds the key (a dotted path) with that shape | | `yaml_field { key, type?, non_empty?, accept? }` | the same for YAML | | `described { keys?, headings?, message? }` | the file says what the asset is (see "Ask your assets to say what they are") | Each check takes a `message`, which is what the author is told when it fails. ### Settings `settings: { values, schema: { type | instance, export? } }` gives every asset typed settings. `values` names the file an asset's values live in; `schema.type` declares one schema for the whole type, and `schema.instance` names a file each asset declares its own in. `asset.create` writes the resolved values, and a write to the values file reaches `onChange` with what changed. ## The human side (`inspector.luau`) A type is used by people through its Inspector, and without one the type is usable only from code. The Inspector is the type's interface for a person: for a procedural graph it is the graph editor, for a kit it is the tracking view of what the kit holds and what is still missing. Writing it is part of writing the type. `inspector: { type, instance? }` in `type.yaml` names the files. `type` is the interface for the type itself and for its assets; `instance` names a file an asset may ship to add its own. Each returns: ```luau return { sections = { { id = "graph", title = "Graph", build = function(ctx) ... end } }, replace = { contents = { ... } }, -- replace a default section by id order = { "graph", "contents" }, -- section order } ``` `build(ctx)` receives the asset and builds the section. A section's `title`, and the text its rows carry, is a string or an `i18n.text` value read from a catalog (`i18n.text("inspectors.mesh.title")`), which follows the editor's language. `asset.create("assetType", ...)` scaffolds a working `inspector.luau` to start from. `asset.validate` on a type that names no inspector, or names one that does not load, reports it. ## Say what your type is for (`about.yaml`) Every type carries an `about.yaml` that says what the type is for, in three plain-language texts: ```yaml intent: "Sets the typeface of the text in your game: UI, labels, signs and 3D lettering." function: "A font, from a TTF, OTF or WOFF file, made available to all of Zero's text, including 3D text." usage: "You choose it by name for your UI or your text, and the text appears in that typeface." ``` - **`intent`** is what the type is for in someone's game, in the words a game maker uses. Up to 800 bytes. - **`function`** is how it works today: what an asset of it is made of and what the engine does with it. Up to 1500 bytes. - **`usage`** is what a person or an agent does with one. Up to 1200 bytes. Write about the type as a whole, not one asset of it, and say what it does now. Agents read these texts to learn when to reach for the type and how; people searching find the type by them. The scaffold starts each text with `[[describe]]` and a note on what to write; a text that still starts that way counts as not written. `services describe` can write them. They show up in `asset.inspect` as `detail.about`, in `assetTypeRef:getAbout()`, at the end of the type's `types/<typename>` guide, and at the top of the type's Inspector. ## Ask your assets to say what they are A type can require each asset to carry a description: a file, written by the author or generated, saying what the asset is and what it is for. Declare it with a `described` check: ```yaml files: required: - path: "README.md" kind: "file" content: - { check: "described", message: "Say what this widget is for and where it goes." } ``` A file that is missing, empty or still has a line starting with `[[describe]]` fails the check, and so does a YAML file whose named `keys` are missing or over their `max_bytes`, or a Markdown file missing a named heading. `asset.validate` names the asset, and a push that carries it is refused with `message`. `services describe` finds such assets and writes their descriptions. `describe:` steers what is generated: ```yaml describe: guidance: "Say what the widget shows, what input it reacts to, and where it fits in a UI." examples: - "<identity of an asset of this type whose description reads well>" ``` An example is an asset of your type whose description is a true, written one, never a placeholder and never the asset being described; with none, leave `examples` empty. A type whose assets the model cannot perceive (a sound, a motion) says so in `guidance`, and the description is drawn only from what the asset's own files state. Start the file unwritten in your `template/`: a heading and one line starting with `[[describe]]`, never example content, which every new asset would carry verbatim. A type whose assets say what they are through their own content (a mesh, a texture) declares no check. ## The type's code (`behavior.luau`) `behavior.luau` returns one table. These are the keys the engine reads from it; anything else on the table is the type's own. ### What the type's assets can do | Key | Shape | What the engine does with it | |---|---|---| | `ref` | `{ [name] = function(self, ...) }` | Every function becomes a method on every asset of the type: `ref:name(...)`. | | `modules` | `{ [name] = require(".x") }` | Code the type's assets reach with `asset.containing(__FILE__).modules.<name>`. | | `events` | an events schema | Events an asset fires. Readers subscribe through `ref.events.<name>:connect(...)`; the type fires them. | | `refShapes` | `{ [method] = function(self) -> (typeExpr, source?) }` | The result type of a `ref` method for one particular asset (below). | | `namePattern` | a Lua pattern | The names `asset.create` accepts for the type's assets. Default `^[A-Za-z][A-Za-z0-9_]*$`. | | `derive` | `{ output, module, compute, fingerprint, matches?, required?, timeout? }` | A file computed from the asset when it is committed; a `required` one holds the commit until it lands. | Some `ref` names mean the same for every type, and the engine calls them: - **`instantiate(self, target?, opts?) -> (root, idMap)`**: puts the asset in a scene. Defining it is what makes the type scene-instantiable. Its return is a contract (below). - **`inspect(self) -> detail`**: what `asset.inspect` reports for the asset beyond the common record (below). - **`preview(self, opts)`**: renders the asset's picture; it wins over the type's `preview:` recipe. - **`previewMaterial(self) -> { material }`**: the material a `surface` preview paints. - **`saveDefinition(self)`**: writes the asset's in-memory edits back to its files in edit mode. Some names are answered for every asset before the type is asked, so a `ref` entry of the same name is never reached: `getSource`, `getBytes`, `getText`, `exists`, `deps`, `canInstantiate`, `canPreview`, `preview` (which calls yours when you define one), `meta`, `runtime`, `events`, `typeRef`, `modules`, and the residency flags `has_backing_asset`, `has_runtime_changes`, `cpu_resident`, `gpu_resident`. ### When the engine calls the type | Hook | Signature | When it runs | |---|---|---| | `onCreate` | `(name, opts) -> { [path] = contents }` | On `asset.create`. Returns the files of the new asset, laid over the type's `template/`. Annotate `opts`: its type is the schema `asset.create` checks the caller's arguments against. A `""` key writes a single loose file. | | `onReplace` | `(dest, files) -> files` | On an `asset.create` over an asset already at `dest`, after `onCreate`, so what the author added can be carried into the replacement. | | `onRegister` | `(self)` | Once per asset, when it first registers: when the world loads, on a live `asset.create`, and when an asset arrives later (installed, pulled, synced). This is what makes an asset take effect the moment it is written. | | `onChange` | `(ref, change)` | On every write to a file inside an asset of the type. `change` is `{ path, asset, type, kind, origin }`, plus `settings` and `settingsChanged` for a write to the settings values file; `kind` is `edited` or `seeded`, `origin` is `local` or `remote`. Filter on `change.path`. Writes to one asset arrive in order, each after the hook for the one before has finished, and the hook may wait on what it reads. A write the hook makes inside its own asset arrives later like any other, so keep the hook convergent. | | `onDependencyChange` | `(ref, change)` | When a module the asset's code requires is re-run, or a name the asset carries starts resolving. `change.kind` is `dependency`. | | `onDelete` | `(ref)` | When an asset of the type leaves the world: deleted, or the world it is in is swapped away. | | `validate` | `(ref) -> { { code, message, severity?, path? } }` | On `asset.validate`, after the `type.yaml` checks, for the type's own rules. `severity` defaults to `error`. Runs on every push, so a type's rules hold at publish. A hook that fails reports `validate.hook_failed`. | ### Settings hooks | Hook | When it runs | |---|---| | `settingsDefaults(name, opts, asked) -> table` | Once per `asset.create`, for values the schema's defaults do not give. | | `settingsCorrections(values, name, opts) -> (corrections?, reasons?)` | On every settings write. A correction to a field the writer named refuses the write, giving the reason. | | `settingsDerivedDefaults(values, explicit, changed)` | On a settings write, for fields derived from others. | | `normalizeSettings(values, stored?)` | On every read and write, to map an earlier spelling of a field to the current one. | | `settingsHealed(values, stored)` | On a read, to repair stored values. | | `settingsSchemaProblem(schema, ref) -> string?` | When an asset's own schema is read; a returned string refuses the schema. | `creationInputs` (`{ [opt] = true | selectorOpt }`) names `asset.create` options that are inputs to the type rather than settings. ### Reloading An edit to `behavior.luau` reaches existing assets with no restart. ## How an asset is pictured (`preview:`) | `kind` | The picture is | The type provides | |---|---|---| | `instantiate` | the asset placed in the preview studio through its `instantiate` | `ref.instantiate` | | `image` | a file the asset holds, fitted to the frame | `source: { files }`, the candidate files in order | | `surface` | the asset painted on a mesh | `mesh`, and `ref.previewMaterial` | | `custom` | whatever `ref.preview` returns | `ref.preview` | ```yaml preview: kind: surface mesh: sphere ``` `angle: [yaw, pitch]` turns the camera. The studio owns the light, the backdrop and the framing, so an asset pictures the same in every world. A type with no `preview:` that defines `instantiate` still answers `ref:preview()`. A picture is rendered when something asks to view it (the editor showing the asset, `ref:preview()`), when previews are generated on request (`assets.generatePreviews`), and when the asset is staged. An edit alone renders nothing. The picture records what it was made from, so a stale one is told from a current one. ## The names your type's assets hold (`references:`) Where your type's own format or API carries the name of another asset, declare it here: ```yaml references: keys: # a top-level key of the type's files that holds a name, or a table of them - { key: "shader", type: "shader" } args: # an argument of a call, counting from 1 - { call: "g:node", position: 2, type: "procNode" } fields: # a field of the options table a call takes - { call: "fx.beam", field: "material", type: "material" } ``` `type` is the category the name resolves in. `asset.declareReferenceKey`, `asset.declareReferenceArg` and `asset.declareReferenceField` declare the same from a script. ## What search reads (`indexing:`) `indexing:` is how assets are found. Search reaches an asset only through what its type's `indexing:` names, and adds nothing of its own. That includes you: an asset indexed badly is one you cannot find later, when you are making something else and need it. A type whose assets are never looked for says `indexing: none`. ```yaml indexing: data: # text, read from the asset's files - role: identity extractor: verbatim source: { file: "README.md" } - role: interface extractor: symbols source: { files: ["init.luau"] } - role: implementation extractor: verbatim source: { files: ["init.luau"] } content: # the picture - role: identity modality: image source: { file: "preview.png" } facets: # what a query filters and re-ranks by file: ".metadata" rigged: { type: bool, from: { components: { contains: SkinnedModel } } } roughness: { type: number, filter: range, from: { file: "mat.yaml", field: "floats.roughness" } } ``` **Roles.** Each `data` and `content` entry has a `role`, and a query matches in two slots: - **`identity`**: what an asset is. For anything you look at, the picture; for anything else, the text that says what it is. - **`capability`**: what it does and how it is made. `interface` (the signatures or shape a caller uses) and `implementation` (the body) both count as capability, and a type with code usually declares both. Ask what a person would recognise an asset of the type by, and what it does, and point each role at the file that says it. For text, that is the asset's description: the file your template starts with a `[[describe]]` block, which the author writes or `services describe` fills in (see "Ask your assets to say what they are"). **`data`.** `extractor: verbatim` embeds a file's text as it is; `symbols` embeds the declared signatures of code. `source` is `{ file }` or `{ files: [...] }`. Never index a file name (`source: { field: name }`): one or two words carry nothing to match. **`content`.** `modality: image` embeds the picture itself, so a text query matches what the asset looks like. A type whose assets are looked at makes the picture its identity. **`facets`.** What a query narrows and re-ranks the matches by. `file` is embedded whole, so keys nobody declared in it are still found. Each further key is computed for every asset and states a value for every one, including `false`: a file can imply "not rigged" but never say it, and a query separates rigged from unrigged only because the unrigged ones say `rigged: false`. A key is `{ type: bool | number | enum, filter?: range, from }`, where `from` is `{ file, field }` (a field of one of the asset's files, dotted for nesting), `{ metadata: key }`, or `{ components: { contains | any_outside } }` (what the asset's entities carry). ## What blocks a push A push checks every asset it carries against its type. These refuse it: - a required file that is missing, a `content` check that fails, a `described` file not written yet; - an error from the type's `validate`. Unlisted files and warnings do not. A `described` file blocks only a push that changes the asset. When a push is refused, the message names each asset and what it lacks. `world.publishBlockers()` and `zm status` read the same list without pushing. ## Typing a result from the asset (`refShapes`) A `ref` method whose result depends on the asset (one entry per child folder, per row of a config, per control a map declares) can only be annotated as `{ [string]: Thing }`, which accepts any key. `refShapes` states the result for each asset instead: a function returning a Luau type expression for that asset, and the module whose types the expression uses. Read the asset; never run it. ```lua -- inputMap.assetType/behavior.luau M.refShapes = { activate = function(self): (string, string) local names = {} for _, control in ipairs(M.ref.controls(self)) do table.insert(names, control.name .. ": Handle") end if #names == 0 then return "", "" end return "{ " .. table.concat(names, ", ") .. " }", "@builtin::modules.zinput.scheme" end, } ``` With it, `map.jump:onPressed(fn)` is checked and `map.noexisting` is reported. A per-asset type applies where the call site names which asset: a component field whose default names it, or an annotation `AssetRef<"inputMap", "<identity>">`. `asset.resolve(name, category)` carries only the category, and a name computed at runtime carries nothing, so calls on those keep the declared return. The type belongs to the call's result: index it there, or bind what you need from it there, and the names stay checked. `require("@builtin::assetTypes.assetType.shared.refShapes").published()` shows what was published: `categories` (each type's method surface) and `returns` (per-asset results by identity, then method). An identity missing from `returns` was never published. Results are recomputed when an asset is written; at most 64 assets of one type are read. ## Putting an asset in a scene (`ref.instantiate`) A caller writes one piece of code against every instantiable type, so what `instantiate` returns is fixed: ```lua local Instantiable = require("@builtin::assetTypes.assetType.shared.instantiable") M.ref = { instantiate = function(self, target, opts) local root = Instantiable.root(self, target, opts) -- compose the asset under `root`, now return Instantiable.result(self, root, idMap) end, } ``` **In.** `target` is the entity the asset lands under, or onto for a hierarchy type; with none, the type spawns a new root. `position`, `rotation` (three numbers in degrees, or a quaternion), `scale`, `name` and `temporary` mean the same for every type: `Instantiable.root` applies them to a root you make, `Instantiable.place` to one you adopt. Document any options of your own in the hook's `--!arg` docs. **Out.** `(root, idMap)`. `root` is the composed root, live when you return: build synchronously, never defer to a component's `awake`. `idMap` maps each original id to the spawned one, so a component that composes the asset again on every load can pass it back in and keep references into the composition. Every call goes through `Instantiable.result`, which refuses a root that is not live and turns a missing `idMap` into `{}`. ## Inspecting an asset (`ref.inspect`) `asset.inspect(ref)` builds a record every asset shares (`identity`, `name`, `guid`, `source`, `typeName`, `typeDefinitionPath`, `scope`, `origin`, `description`, `tags`), then calls `ref.inspect(self)` for the type's own `detail`: ```lua M.ref = { inspect = function(self) -- read the asset's own files, never runtime state: inspect works on an asset -- that has not been compiled, uploaded or registered return { --[[ what makes this asset what it is ]] } end, } ``` Without it, the record is the shared part alone, and an agent inspecting the asset learns nothing of what it is. A hook that raises leaves `detail` empty and sets `record.warning`. ## Discovery - `asset.list("assetType")`: every registered type. - `asset.inspect("<typename>")`: the type, its README and its `about.yaml` texts. - `asset.resolve("<typename>", "assetType")`: the type itself.
▲ 0↑ born
▣
module · born here
❒asset
# agentContext Named blocks of world data published to the agents working in a world. Each block is scoped to a world and branch, and optionally to the root scene it describes; a block published for another scope is refused, and a block is cleared only by the scope it was published for. ```luau local agentContext = require("modules.api.engine.agentContext") local ok, why = agentContext.publishWorld("sceneAuthoring", worldGuid, branch, sceneGuid, Json.encode(body)) agentContext.clearWorld("sceneAuthoring", worldGuid, branch, sceneGuid) ```
▲ 0↑ born
▣
module · born here
❒asset
# json JSON encode/decode library for Luau. Encodes Lua values to JSON strings and decodes JSON strings back to Lua values. Used for communication with the Rust side of the engine, the VFS read/write bridge, and any wire-format that needs JSON. Pure Luau, no engine dependencies. Compact and pretty-printed encoders, plus a hand-rolled decoder that streams the input by position so it works under WASM as well as native. ## Exports - `Json.encode(value: any, indent?: string, currentIndent?: string) -> string` — compact encode. Functions / unknown types and NaN/Inf encode as `null`. - `Json.encodePretty(value: any, indentStr?: string) -> string` — pretty-printed encode with sorted object keys (diff-friendly). - `Json.encodeArgs(...: any) -> string` — encode varargs as a JSON array. - `Json.decode(str: string) -> any` — decode a JSON string. Returns the decoded value, or `nil` + error message on failure. ## Usage ```luau local Json = require("@builtin::modules.json") local widget = { type = "button", text = "Click Me" } local compact = Json.encode(widget) -- '{"text":"Click Me","type":"button"}' local pretty = Json.encodePretty(widget, " ") local decoded = Json.decode(compact) local v, err = Json.decode("oops") -- v = nil, err = error message ``` ## Notes - Object keys are sorted alphabetically in both encoders for consistent output across runs. - Numeric keys on objects are stringified at encode time (JSON has no numeric keys). Pure-integer key sets get detected as arrays via `isArray` and encoded with brackets. - NaN, +Inf, -Inf encode as `null` — JSON has no representation. Round trips through `decode` recover `null` (Lua `nil`), so they don't preserve. - Unicode `\uXXXX` escapes decode to UTF-8 by hand to stay WASM-safe. Only the BMP is covered; supplementary planes via surrogate pairs are not. - Functions encode as `null`. - Decode is character-streamed — no regex, no `string.match` patterns on the whole input — so the line-and-column information needs to be reconstructed from the position offset.
▲ 0↑ born
▣
module · born here
❒asset
# Source bindings Captures editable inputs supplied by builders, remaps their generated output ids to persistent scene ids, and retains exact source revisions for later checked edits. ```lua local Bindings = require("@builtin::modules.sourceBindings") local inputs, result = Bindings.capture(function() Bindings.attach(target) -- target from SourceEditing.bind return "built" end) local registry = Bindings.pack({{owner="build",targets=inputs,placements={captured="persistent"}}}) local available = Bindings.list(registry, "persistent") local reopened = Bindings.resolve(registry, "build", available[1].id) ``` Inside a scene build, `build.source()` returns the exact `build.luau` snapshot being evaluated, including proposed source during candidate preparation. Use it with `SourceEditing.calls` to locate editable arguments, then call `build.bindSource(target)` after creating the entities named by the target. The scene captures these registrations, maps their outputs to persistent placements, and saves the registry in `authoring/state.json` under `build.bindings`. Source files discovered through bindings join the transaction read set; a changed original input or edit record refuses the build. A tool can reopen that saved registry with `Bindings.resolve` to prepare a checked source replacement. The registry deduplicates source versions by asset guid and stores their exact-byte SHA-256 revisions. Resolving an input follows its asset identity to its current path and refuses changed bytes. Repeated registrations of one owner/input id combine known outputs only when their source occurrence and scope agree. Every output must occur in the supplied placement map. Scope completeness remains explicit. Nested capture scopes keep their registrations separate and restore the outer scope after an error.
▲ 0↑ born
▣
module · born here
❒asset
# Field edits Scene authoring uses FieldEdits to keep structured field intent separate from generated data. Each edit carries a path, the value that field was based on, and the authored value, with explicit presence flags for additions and removals. ```lua local Fields = require("@builtin::modules.fieldEdits") local base = {position={0,0,0}, light={intensity=1}} local visible = {position={2,0,0}, light={intensity=1}} local edits = Fields.diff(base, visible) local rebuilt = Fields.compose({position={0,0,0}, light={intensity=3}}, edits) assert(not rebuilt.blocked) assert(rebuilt.value.position[1] == 2) assert(rebuilt.value.light.intensity == 3) ``` - `copy(value)` validates and copies structured data without sharing mutable tables. - `diff(before, after)` creates deterministic field edits. Objects merge by string key; arrays and asset references are atomic values. - `compose(generated, edits)` applies authored values and reports divergence from their stored baseline. Missing parents, missing edited targets and conflicting root additions block the result. Satisfied paths identify intent the generated value already matches. - `update(generated, previous, current, edits)` records a new authoring operation while retaining existing baselines and satisfied intent. An addition followed by its removal cancels that addition. - `updateChanges(generated, current, changes, edits)` records original observed changes against their merged visible result. A change already satisfied by the current generated value remains an authored intent for subsequent builds. - `keep(generated, edits, paths?)` acknowledges reviewed generated changes while retaining the authored values at the selected exact paths. Inputs are copied, edit paths are non-overlapping dense arrays of strings, and values are finite serializable data with bounded nesting. Scene-level hierarchy, reference and component validation belongs to the scene composer consuming these field results.
▲ 0↑ born
▣
module · born here
❒asset
# component_snapshot Serialized snapshots of script-component public data. A component's `public` table is a live proxy — its fields live behind `__iter` / `__index` metamethods, so copying or JSON-encoding the proxy directly yields an empty table. This module materializes the plain, serializable form. It is the script-component parallel to `ecs.snapshot` (native components). ```lua local componentSnapshot = require("modules.component_snapshot") -- one component: live proxy -> plain table local data = componentSnapshot.snapshot(entity(id).component.get("Camera")) -- whole entity: { [type] = data }, named/multi instances nested as -- { [type] = { [instanceName or "__default"] = data } } local all = componentSnapshot.snapshotEntity(entity(id)) ``` `componentSnapshot.plainCopy(value)` materializes ONE live value the same way — a table behind a proxy is walked into a plain table, every other value passes through — for callers reading a single field rather than a whole component. Serialized form: entity refs become id strings, asset refs become `{ __ref, name, type }` envelopes, vectors and colors their plain-table forms; framework functions are omitted. `snapshot` returns nil for a proxy with no serializable fields. Persistence (scene serializer, bundle capture, prototype spawn) and inspection tooling (`debug.inspect`) read component data through this module. Live gameplay reads and writes stay on the proxy itself via `entity(id).component.get` / `getAll`.
▲ 0↑ born
▣
module · born here
❒asset
# entity_records Walks a live entity hierarchy into the flat record array the engine's entity templates use — `{ name, original_id, parent_id, position, rotation, scale, hidden, components }` per entity, root first, parents before children. `bundle` composes its `entity_template` through this module; scene builds compose their baked output through it. One record shape, one implementation. `compose(rootId)` walks one hierarchy. `composeMany(rootIds)` walks several, which is what a build needs — a builder may leave more than one unparented root. Temporary descendants are pruned; an explicitly-named temporary root is kept. `compose(rootId, nil, nil, true)` keeps the temporary descendants too, so the records hold every entity under the root.
▲ 0↑ born
▣
module · born here
❒asset
# assetType.shared.ref Builds the metatable every `AssetRef` (the `{ __ref, type, name, guid, identity, path }` envelope returned by `asset.resolve` / `asset.ref`) carries. Replaces the per-call C metatable that used to live in `crates/zero_scripting/src/ffi/bindings/asset.rs::attach_asset_ref_metatable`. ## Public API ```lua local assetRef = require("@builtin::assetTypes.assetType.shared.ref") -- Called by the Rust factory (push_asset_ref_handle) via -- _G.__build_asset_ref_proxy after the envelope fields are set. assetRef.build(envelope) -- attaches AssetRefMT, returns the table ``` The module exposes no invalidation surface — discovery is registry-driven and hot-reload is transparent (see "Discovery and hot-reload" below). ## Method dispatch order `ref.foo` is resolved in this order: 1. **Default methods** — `getSource` / `getBytes` / `getText` / `exists` / `inspect` and the lazy `meta` property. Per-type definitions cannot override these (engine contract from gh#1889). 2. **Per-type `ref` table** — discovered through `asset.resolve(<typename>, "assetType")` + `require(<identity>.behavior)`. The lookup resolves to whichever `<typename>.assetType/` folder is currently registered for the typename (built-in, user, or library-vendored) and pulls its `ref` methods. 3. **Nil** — unknown key, same shape as the original C metatable. ## Adding methods for a new asset type Drop a `behavior.luau` into the type folder: ``` src/lua/lib/assetTypes/<typename>.assetType/ ├── type.yaml -- structural spec (existing) ├── behavior.luau -- ref + global behaviour (new) └── template/ -- placeholder body (existing) ``` `behavior.luau` returns: ```lua return { ref = { --!desc Per-instance method on every `<typename>` AssetRef. myMethod = function(self, ...) ... end, }, global = { -- Reserved for the asset.<typename>.* surface — not consumed -- yet; included so the contract from gh#1889 lands cleanly. }, } ``` Within `ref` methods, `self` is the AssetRef envelope: `self.path`, `self.identity`, `self.guid`, `self.type`, `self.name` are available. Engine-required fields (`guid`, `path`, `identity`, `type`) must not be redefined. ## Discovery and hot-reload Type discovery uses the asset registry, so it doesn't matter where a `<typename>.assetType/` folder lives — engine built-ins under `@builtin::assetTypes.<X>`, user types dropped under `/zero/source/<X>.assetType/`, or types vendored inside an imported library all resolve identically. The dispatcher walks `asset.resolve(<typename>, "assetType")` → canonical identity → `require <identity>.behavior` on every miss; the asset registry is the cache for the resolve half and Luau's `_LOADED` is the cache for the require half. Hot-reload is transparent. When a `<typename>.assetType/behavior.luau` is rewritten through VFS, the engine's `invalidate_require_cache_for_state` re-runs the module and mutates the cached `_LOADED[<identity>.behavior]` table in place. Dispatch reads `mod.ref` on every access (rather than caching a sub-pointer), so existing AssetRefs see the new methods on the very next access — no Rust-side hook into this module is needed, and no invalidation API is exposed for callers to call. The same registry-driven path also handles type **registration** correctness: dropping a new `<typename>.assetType/behavior.luau` updates the asset registry, the next `asset.resolve(<typename>, "assetType")` returns the new ref, and AssetRefs of that type immediately gain the new methods. ## Why Luau, not Rust The asset surface needed per-category behaviour (`material:getProperties()`, `bundle:instantiate(entityId)`, `tool:run(args)`) and the old shape couldn't grow without an FFI change per method. Owning the proxy in Luau means: - Type-specific methods ship as content (the `<typename>.assetType/` folder), not engine code. - Adding a new asset type drops in a new folder; no Rust rebuild. - Methods can call any other Luau global (`vfs`, `asset`, `Material`, `entity`, etc.) directly, instead of going through narrow FFI primitives. ## Consumers - `crates/zero_scripting/src/ffi/bindings/asset.rs::attach_asset_ref_metatable` — the Rust factory that pushes envelopes invokes `_G.__build_asset_ref_proxy` once per push. - Every Luau call site of `asset.resolve` / `asset.ref` / `entity(id).component.X.material` / any binding declared `AssetRef<...>` — they all receive envelopes built through this module.
▲ 0↑ born
▣
module · born here
❒asset
# defaults The Preset Manager: the world's ordered `[[presets]]` rows in `/zero/source/.world_settings`. A row names one declarer (`target`), one preset for that declarer (`preset`) and a path glob (`filter`). When something a declarer governs is created — an asset of an assetType, an import an importer runs, a component added to an entity — the first row naming that declarer whose filter matches the new thing's path gives a layer of its settings. Rows are read only at creation. A component row's filter reads the entity's hierarchy path (names from the root down, joined with `/`). What a scene build's capture scope adds takes the rows in any mode, whoever runs the build; outside a build, a component takes a row when it is added in edit mode. A component put back from existing content takes none: one added inside `materializing` (a saved scene, a peer's record, a template clone, a bundle's hierarchy, a build's records), and one a component's own code adds outside a build, on any coroutine that code runs. A scene build records which fields the rows gave each component, and a rebuild restates a component only when the code states it differently, so a row edit alone changes nothing a build already placed. Rows are written as guid envelopes and checked as a whole. A row is refused when its target does not resolve, is consulted at no creation, or declares no settings; when its preset does not resolve, is not a preset, or targets another declarer; or when its filter is not a string. A write replaces the `[[presets]]` block and keeps the rest of the file byte for byte. ## The row format ```toml [[presets]] target = { __ref = "8cc28fc8-ed63-48ee-83a6-15f4192e27e1", type = "importer", name = "texture" } preset = { __ref = "0b6c1f0e-5d0c-4d5e-9d64-3c1b7f2a9e11", type = "preset", name = "pixel_art" } filter = "sprites/**" ``` `target` and `preset` are guid envelopes: `__ref` is the guid, and `type` and `name` tell a person reading the file what it names. A row written by hand may name either by identity or guid; the next write rewrites it as envelopes. `.world_settings`'s `.refs` pins each row's target and preset by guid. ## Matching For a new thing a declarer governs, the rows are read in order and the first naming that declarer whose filter matches the thing's path applies; the rest are not consulted. A filter is a glob (`preset.glob`) over the path relative to `/source` with forward slashes, or an entity's hierarchy path for a component row; the empty filter matches everything, and a filter that is not a string matches nothing. A matching row whose preset does not resolve, or targets another declarer, is the match and contributes nothing, with one warning. A preset value the declarer's schema rejects is left out and the rest apply. ## Sync The rows are part of `.world_settings`, so they sync with the world like any other file and every peer reads the same rows. A row applies where the creation happens, when it happens: a peer's edit reaches only what is created after it arrives, and what was created before keeps the settings it was stamped with. A runtime asset lives for the engine process; a peer that started before a row edit keeps its old settings on a re-created runtime identity until it restarts. ## Exports - `Defaults.PATH`, `Defaults.BLOCK` — the file and the array-of-tables name. - `Defaults.SCHEMA` — the block's Field schema, `{ presets = Field.list(row) }`. - `Defaults.rows() -> { Row }` — every row, resolved, with its problems. - `Defaults.write(rows)` — normalise, check, and replace the rows. - `Defaults.normalize(input) -> StoredRow` - `Defaults.rowProblems(row) -> (problems, targetRef, presetRef)` - `Defaults.consultedAt(declarer) -> "asset.create" | "import" | "component.add" | nil` - `Defaults.relativePathOf(path) -> string?` — the path a filter reads. - `Defaults.match(declarerGuid, relPath) -> (Row?, index?)` - `Defaults.layerFor(declarerGuid, relPath) -> (values?, Match?)` - `Defaults.check(value, constraint) -> (ok, reason)` — the `presetDefaultRow` constraint. - `Defaults.removeAt(index)` — remove one row, writing every other row back as the file holds it. - `Defaults.importerSettings(importerRef, sourcePath) -> (settings, Match?)` - `Defaults.materializing(fn, ...) -> ...` — run `fn` with no row reaching a component add. - `Defaults.entityPath(id) -> string` — the hierarchy path a component row's filter reads. - `Defaults.forComponent(entityId, typeName, data?) -> data?` — the data a component add takes. - `Defaults.batchLayers(targets, typeName, data?) -> { { targets, data } }` — a batch add split into runs. - `Defaults.resolveValue(v) -> AssetRef?` — a row value as the asset it names. - `Defaults.recordingStamps(fn, ...) -> (stamps, ...)` — run `fn` and return what the rows gave the components a capture scope added meanwhile, per `stampKey`. - `Defaults.stampKey(entityId, componentGuid, instanceName?) -> string` The `preset` global exposes the rows as `preset.defaults`, `preset.setDefaults`, `preset.addDefault`, `preset.removeDefault` and `preset.defaultFor`.
▲ 0↑ born
▣
module · born here
❒asset
# frame_budget The share of a frame that cooperative engine work spends before it hands the frame back. Some engine work is one long sequence of small units run on a task: a scene load applies one record after another, and the world-load `onRegister` sweep fires one instance's hook after another. Run back to back in one frame, a long sequence holds that frame for its whole length, and nothing else the engine does (answering a call, drawing, input) happens until it is through. Asking `due()` before each unit and yielding when it answers true runs the same work across as many frames as it needs, a slice of each. ```luau local FrameBudget = require("@builtin::modules.frame_budget") for _, item in ipairs(items) do FrameBudget.yield() process(item) end ``` - **One slice per frame, shared.** Each caller is charged the time it runs between its readings of the slice in a frame (`task.runTime`), whoever runs it, and the charges of every caller add up to the frame's slice. What the rest of the frame runs (systems, components, other tasks) is not charged, so a busy frame still gives the slice to the work. Two long pieces of work running at once share a frame's slice rather than taking one each. - **A unit is never split.** The first unit of a frame always runs, so a frame holds at most the slice plus the one unit that crossed it. A unit that is itself long stays one piece of work. - **Code that cannot yield runs in its frame.** `due()` answers false outside a coroutine that can yield, so a caller called from such code does all its units in the frame it was called in, as it would without the budget. A caller that does work of its own around the yield asks `due()` and calls `wait()`, which yields to the next frame and opens that frame's slice as the caller resumes; `yield()` is the two together. Work whose unit is a native call that bounds itself by time is told how long it may run: `remainingMs()` answers what is left of the current frame's slice, or nil for code that cannot yield, which then runs the whole of its work in the frame it was called in. The publish gate's script check runs this way: ```luau local block, checking = __spacetime_vcs.scriptPublishBlock(FrameBudget.remainingMs()) while checking do FrameBudget.wait() block, checking = __spacetime_vcs.scriptPublishBlock(FrameBudget.remainingMs()) end ``` ## The background lane Some work is started early so it is ready when asked for, and no picture waits on it, such as the search text an editor reads ahead of the first `tools.search`. `background(fn)` runs `fn` on the background lane: every `yield`, `due` and `wait` its work makes on that coroutine hands the frame back for as long as a hold on the lane stands, and takes its slice as usual once none does. ```luau FrameBudget.background(function() for _, path in ipairs(paths) do FrameBudget.yield() warm(path) end end) ``` Work the picture waits on holds the lane while it runs: `holdBackground(key)` until `releaseBackground(key)`. A world's entry holds it under `"world entry"` from the moment the world is ready (its `onRegister` sweep) until its `onWorldLoad` has returned, so the frames of the entry carry the world's load and the background work runs in the frames before and after it. A hold no one releases lapses after `BACKGROUND_HOLD_SECONDS` (or the seconds it was taken for), with a warning naming its key, so work on the lane always runs in the end. `backgroundHolds()` lists the keys holding the lane now, and `backgroundWaits()` answers whether the calling code's next unit waits for it (a walk with a clock of its own asks it between its pieces). `FrameBudget.DEFAULT_MS` is the slice a call that names none spends. `spent()` answers how much of the current frame's slice is gone. A caller with a budget of its own reads `mark()` where its work starts. `ranMs(mark)` answers how long it has run since, none of the time it spent suspended; `cpuMs(mark)` answers the CPU time of its work since: those stretches and the stretches of every coroutine it resumes, and every one they resume, while it waits on them, which a machine whose cores are taken by other work does not stretch, so a bound that refuses work for running too long refuses the same work on a loaded machine as on an idle one, and work handed to a coroutine as work run in place. A task it starts and waits for runs while it is suspended, which `cpuMs` does not count.
▲ 0↑ born
▣
module · born here
❒asset
# Source operations Require `@builtin::modules.sourceOperations` to coordinate revision-checked changes to text files in a bound world. `capture(paths, directories?)` waits for local writes in the named scope and captures authoritative file revisions and directory membership. It includes containing asset inventories for their derived checksums. The returned snapshot is frozen and names its world and branch. `revisionToken(snapshot)` returns a deterministic token for the guarded world, branch, file revisions and directory membership. A later capture with the same guarded revisions has the same token; guarded changes invalidate it. It leaves the snapshot and source files unchanged. `source(snapshot, path)` reads a SourceEditing snapshot whose identity and storage checksum match the captured row. Use SourceEditing's call discovery and exact-range helpers to select the intended declaration and scope. ```lua local Ops = require("@builtin::modules.sourceOperations") local Source = require("@builtin::modules.sourceEditing") local path = "/zero/source/scenes/main.scene/build.luau" local snapshot = Ops.capture({path}) local source = Ops.source(snapshot, path) local calls = Source.calls(source, "asset.resolve") assert(calls[1], "select an asset.resolve declaration in this builder") local edit = Source.replace(calls[1].arguments[1], Source.literal("props.Table")) local plan = Ops.plan(snapshot, {{path=path, source=Source.preview(source, {edit})}}) -- Review plan.uploads and the selected declaration's affected outputs. local prepared = Ops.prepare(plan) assert(prepared.state == "prepared", prepared.reason) local result = Ops.commit(plan.operation, plan.scope) assert(result.state == "committed", result.reason) ``` `plan(snapshot, changes)` accepts disjoint text-file replacements and explicit `{path=..., remove=true}` removals. It preserves existing file identities, allocates identities for new files, derives candidate reference tables and recomputes containing asset checksums through the engine. Every mutation must be covered by the captured read set. Create asset containers through `asset.create`, then plan changes to their source files. Directory inventories participate in revision checks, including additions at previously absent paths. References are derived against the current asset registry and the captured prior reference table. `plan` enforces ordinary source-write permissions, including computed-output protection declared by an asset type. A compiler uses `materialize(snapshot, changes)` to include its computed outputs together with their inputs. Materialization keeps the same revision, directory, identity and reference checks and respects world and library write permissions. `prepare(plan)` first retains the exact request and its candidate pins, then uploads missing candidates under those pins. It returns prepared state once every candidate is available, already committed state after a completed operation, or failed state with the operation id retained. Repeated preparation uploads only missing candidates. Interrupted preparation is inspectable as awaitingCandidates, with the missing content hashes; resume with the retained plan or cancel it. `commit(id, scope?)` applies the retained request against its read set. A committed result acknowledges server persistence; scene activation observes the resulting files. `inspect(id, scope?)` returns committed, prepared, awaitingCandidates, cancelled or missing state. Prepared records include the exact request, and committed records include the receipt. Use the same operation identity after a lost reply. `pending()` enumerates this identity's unfinished operations in the bound world and branch. `cancel(id, scope?)` releases a prepared operation's candidates and makes its identity terminal. Failed commits retain their prepared record for inspection and explicit resolution.
▲ 0↑ born
▣
module · born here
❒asset
# sourceEdits Checks for authored source before it is written. `candidate` validates a source's syntax and derives the checksum, size, kind and reference table that storing it would state, without writing anything. `folderChecksum` derives a folder asset's checksum from its leaves, `newIdentity` mints a UUID, and `checkWrite` answers the canonical path a source write may take. ```luau local sourceEdits = require("modules.api.engine.sourceEdits") local checked = Json.decode(sourceEdits.candidate(path, text)) local guid = sourceEdits.newIdentity() ```
▲ 0↑ born
▣
module · born here
❒asset
# Source editing Tools and script builders use this module to discover Luau call arguments and edit their source declarations. A snapshot records the file identity and exact text. Every replacement uses a checked UTF-8 byte range in that snapshot; apply refuses changed files and overlapping ranges, and validates Luau or JSON syntax before writing. ```lua local Source = require("@builtin::modules.sourceEditing") local snapshot = Source.read("/zero/source/scenes/main.scene/build.luau") local calls = Source.calls(snapshot, "asset.resolve") local edit = Source.replace(calls[1].arguments[1], Source.literal("props.Chair")) local preview = Source.preview(snapshot, { edit }) local result = Source.apply(snapshot, { edit }) assert(result.applied, result.reason) ``` Candidate evaluation uses a coroutine-local read scope: ```lua local report, value = Source.evaluate({{snapshot=snapshot, source=plan.candidate}}, function() return Source.read(snapshot.path).source end) ``` Only `Source.read` uses the proposed bytes. The callback's ordinary VFS reads continue to see committed content. The report contains original read snapshots for revision guards and the candidate paths actually consumed. Nested scopes restore their caller after success or failure. Scene source replacement uses this for JSON inputs read through this module, and commits their source, rebuilt scene and refreshed bindings together. Encode JSON replacement values with `Json.encode`. Choose the intended occurrence and scope before preparing a replacement: one call in a loop can produce many placements. Discovery reports the function spelling, original argument expressions, line numbers and zero-based byte offsets with exclusive ends. Builders supply the semantic relationship between their outputs and those inputs. A package can retain an immutable target alongside its generated output: ```lua local target = Source.bind(snapshot, calls[1].arguments[1], { id = "room-west.asset", scope = "west room declaration", outputs = {"room-west"}, scopeComplete = true, }) local plan = Source.prepareTarget(target, Source.literal("props.Chair")) -- Present plan.candidate and plan.target.scope/outputs to the caller. local result = Source.apply(plan.target.snapshot, plan.edits) assert(result.applied, result.reason) ``` The package supplies the stable input id and output identities. A declaration used by several placements lists that scope; use `scopeComplete = false` when the known outputs are only part of its effect. The target retains the exact snapshot it was bound against, so another source edit makes its apply stale. Rebind against a fresh snapshot after resolving the intended input again. Per-iteration changes in procedural loops need a distinct editable input or a package transformation that creates one. Apply returns the ordinary VFS write report. Edit-mode writes become source; a caller participating in play follows the play-shadow rules. World sync reports remote persistence and conflicts. Read a fresh snapshot to prepare the next operation. JSON inputs use the same exact-range replacement and binding operations: ```lua local Json = require("@builtin::modules.json") local snapshot = Source.read("/zero/source/layout.json") local value = Source.jsonValue(snapshot, "/rooms/1/asset") local edit = Source.replace(value, Json.encode("props.Chair")) local result = Source.apply(snapshot, {edit}) assert(result.applied, result.reason) ``` JSON Pointers use zero-based array indices; escape a key's tilde as `~0` and slash as `~1`. An empty pointer selects the root value. Discovery validates the complete document and refuses duplicate member names in traversed objects. Replacement preserves the surrounding bytes, including formatting. Encode JSON replacements with `Json.encode`; `Source.literal` produces Luau expressions. An array index locates a value in the reviewed snapshot. A package resolves its stable record key, such as a room id, before selecting that index and binding its input. Changed source invalidates the prepared edit, including a reordered array. For an array of records with string identities, select by the key: ```lua local value = Source.jsonRecordValue(snapshot, "/rooms", "id", "east", "/asset") local target = Source.bind(snapshot, value, { id="east.asset", scope="east room", outputs={"east"}, scopeComplete=true, }) local plan = Source.prepareTarget(target, Json.encode("props.Chair")) ``` Every record in the selected array must carry the named string key, and those keys must be unique. Missing identities, duplicate keys and non-record array members are refused. Resolve again against a fresh snapshot after an array reorder: the key finds the same record, while the prepared edit still checks the exact old bytes before applying.
▲ 0↑ born
▣
module · born here
❒asset
# profiler Module Public Luau surface over the `__profiler` Internal FFI namespace — frame-level profiler capture, EMA stats, and named blocks. ## Purpose Wrap the raw `__profiler.*` FFI namespace in a typed Luau table that gets auto-injected as `_G.profiler` via the prelude. Captures persist to VFS at `/zero/runtime/profiler/<label>.json`; EMA stats and named blocks land back in the engine's `SystemProfiler` resource so they're visible in captures and in the in-engine profiler panel. ## Usage ```luau -- Capture a window of frames. One recording runs at a time engine-wide, -- and several agent sessions share one engine, so a refused start is -- answered with who holds it rather than with the bare fact that -- something does. if not profiler.startCapture("hitch") then print("held by", profiler.recordingHold()) return end task.wait(2) local json = profiler.stopCapture() print(json) -- Read live EMA stats. `avg_frame_ms` is the block's share of the -- current frame; `avg_ms` is what one run of it costs. for _, s in ipairs(profiler.stats("schedule.*")) do print(s.name, s.avg_frame_ms, s.avg_ms, s.max_ms) end -- Named blocks profiler.begin("ai.tick") runTick() profiler.finish("ai.tick") -- Or scope it with measure() (handles errors) local result = profiler.measure("ai.tick", function() return runTick() end) ``` ## Exports - `profiler.startCapture(label?) -> boolean`. Takes the one engine-wide recording slot for the calling caller. False when another recording holds it; `profiler.recordingHold()` then names what does. - `profiler.recordingHold() -> string?`. JSON `{ label, owner, started_at, held_seconds }` for the live recording, or nil when none runs. `owner` is the caller key that took the slot, the same value `vfs.currentAuthor().id` reads for the calling caller, so a caller refused the slot tells its own earlier recording from a sibling session's. - `profiler.stopCapture() -> string?`. JSON capture summary. `callers` carries each caller's share of the window's queued Luau, and each frame carries its own split as `agent_by_caller`. - `profiler.isCapturing() -> boolean` - `profiler.lastCapture() -> string?` - `profiler.stats(pattern?) -> { ProfilerStat }` — live EMA stats. Each entry carries two averages: `avg_ms` averages one RUN of the block, folded when the block runs, so a block that has stopped running keeps the last value it saw; `avg_frame_ms` averages one FRAME, folded every frame including the frames the block did not run in, so it is the block's share of the current frame and falls back to zero once the block stops running. - `profiler.counters(pattern?) -> { ProfilerCount }` — unitless per-frame tallies kept apart from the millisecond timings of `stats`, for example the engine thread's waits on the process-wide lock under `system.schedule.frame.process_local_waits`, and the queue submissions the renderer and the UI made under `system.schedule.frame.queue_submissions` (each one is a fixed cost to the GPU driver, whatever it carries), and the uploads the renderer's device staged: the buffer and texture writes under `system.schedule.frame.queue_buffer_writes` and `system.schedule.frame.queue_texture_writes`, and the staging buffers the device created to carry them under `system.schedule.frame.staging_buffer_creations` (the device stages a frame's writes in chunks it reuses, so a frame whose writes fit the chunks it holds creates none; in a browser's WebGPU the browser stages the writes and the three read zero), and the maps of the renderer's statistic readbacks under `system.schedule.frame.gpu_readbacks`, with each readback's own maps under that key followed by its name: `hiz.occlusion_counts` and `instanced_compaction.submitted` (the counts `renderer.cullStats().occlusionTested` / `occlusionCulled` and `renderer.drawStats().compactedDrawn` answer, read back on the two rendered frames after each read and one frame in 60 otherwise), `cluster_cull.counters`, `visibility.resolve_counters` and `gpu_timing.readback` (so `system.schedule.frame.gpu_readbacks.hiz.occlusion_counts` counts the occlusion counts' maps), and the profiler names resolved by hashing them under `system.profiler.name_lookups`: a measurement's name is resolved the first time it is recorded and found by its key after that, so a frame recording only measurements it has recorded before counts none (a `profiler.begin` / `profiler.measure` block finds its key by the Luau string naming it, so a name a script builds again after its last string was collected is resolved again). `frame` is the tally of the frame in progress, `prev_frame` the last complete frame's, `max_frame` the highest complete-frame tally and `total` the tally since the profiler started. - `profiler.begin(name)` / `profiler.finish(name?) -> number?` — paired named blocks, LIFO by default. - `profiler.measure(name, fn) -> ...` — scoped block around a function.
▲ 0↑ born
▣
module · born here
❒asset
# handles Loads the native components a saved record lists. A record (a scene entity, a bundle `entity_template` entry) states its native components beside its script components as `ecs = { { type = "<public name>", data = <row> } }`: `type` is the name the component answers to under `ecs`, and `data` is the row `ecs.snapshot` answers for it. Every field that holds a GPU handle is written as the guid of the ASSET the handle came from, because the guid outlives the session and the handle does not. Loading resolves each of those guids to the handle the component holds (`ref:handle()`, the call a `Model` makes, which puts the asset on the GPU) and inserts one value into every entity that states the same entry. ## Exports - `M.handleFields(typeName) -> { { rust, category } }?` - the fields of a native component that hold a GPU handle, each with the asset category its guid names (`mesh`, `material` or `texture`). nil for a name `ecs` does not hold. - `M.value(entry, site?) -> value` - the component value one `{ type, data }` entry states, ready for `ecs.insert`. A guid that names no asset of the field's category raises, naming the component and field. `site` is the path or identity of the asset the entry was read from: a site inside a carried mount reads each guid within that mount's closure (`asset.tryResolve(guid, category, site)`). - `M.insertAll(specs, site?) -> failures` - inserts `{ id, type, data }` specs, one `ecs.insertMany` per distinct `(type, data)`, reading every guid at `site` the way `M.value` does. Answers one `{ type, ids, message }` per entry that did not land. ## Usage ```luau local handles = require("modules.api.engine.ecs.handles") local failed = handles.insertAll({ { id = a, type = "Mesh", data = { mesh = meshGuid } }, { id = b, type = "Mesh", data = { mesh = meshGuid } }, { id = a, type = "Material", data = { id = materialGuid } }, }) for _, failure in ipairs(failed) do log.error(failure.type .. ": " .. failure.message) end ``` The scene loader and `bundle:instantiate` call `insertAll` after a record's script components are added.
▲ 0↑ born
▣
module · born here
❒asset
# prototype_lifecycle The play-mode invariant for authored player prototypes and EditorOnly entities. In play a PlayerPrototype subtree is the clone source, not a live scene entity: the scene loader spawns it only in edit, and the spawn-on-join flow instantiates a clone per joining user in play. This module deactivates and hides any prototype still live when play begins (the fallback when the loader spawned one) and every EditorOnly entity, so neither is simulated nor rendered in play; in edit both are fully live. Runtime clones are tracked here and despawned on the return to edit. Location: `src/lua/lib/modules/api/engine/prototype_lifecycle.module`
▲ 0↑ born
▣
module · born here
❒asset
# sky Module Public Luau surface over the `__sky` Internal FFI namespace — sky type, time of day, day/night cycle, procedural parameters, presets, explicit sun direction. ## Purpose Wrap the raw `__sky.*` FFI namespace in a typed Luau table that gets auto-injected as `_G.sky` via the prelude. Set queues sky-config mutations into the scripting mutation queue; get reads back via the sky-snapshot bridge. ## Usage ```luau sky.preset("clear_day") sky.set({ time_of_day = 14, sync_sun_to_light = true }) print(sky.getTimeOfDay()) -- 14 sky.setSunDirection({ 0.5, -1, 0.3 }) local cfg = sky.get() print(cfg.type, cfg.material_name, cfg.solid_color) ``` ## Exports - `sky.set(opts)` / `sky.get() -> table` - `sky.setTimeOfDay(t)` / `sky.getTimeOfDay() -> number` - `sky.preset(name)` - `sky.setSunDirection(dir)`
▲ 0↑ born
▣
module · born here
❒asset
# player_prototype_spawn The deterministic spawn core for authored player prototypes. A PlayerSpawn entity names a PlayerPrototype subtree to instantiate; `spawnFor` clones that subtree from its captured authored template, prunes clone-subtree nodes whose networkScope excludes the caller's owner/authority role, marks the clone RuntimeOnly, and turns the clone root into the joining user's hidden UserIdentity, named `user` like every user identity (the prototype keeps its own name, so a lookup by that name reaches the prototype), plugging it into the players registry, join/leave, ownership, and sync. The body named by `PlayerPrototype.body` is adopted as the user's avatar and placed at the PlayerSpawn's world transform; the prototype's CameraRig follows it. `installJoinHook` wires `spawnFor` to a scene's user-join event so a joining user is placed automatically. Location: `src/lua/lib/modules/api/engine/player_prototype_spawn.module`
▲ 0↑ born
▣
module · born here
❒asset
# resource_handle Recognises a **live GPU resource handle** — the value `renderer.mesh.create`, `renderer.material.create` and `renderer.texture.create` answer with. A handle is a table of the shape `{ kind = "<Category>Handle", category, guid, name }`, and its `guid` names a slot in the **running process's** GPU registry. It is minted when the resource is created and identifies that resource for as long as the registry lives. An `AssetRef`'s guid is content identity — it names a stored asset, and any session that can reach the world's content resolves it. The two look alike at a glance and answer differently at every **session boundary**, which is what this module exists to tell apart: - **The replication wire.** A peer runs its own GPU registry, so a handle's guid means nothing there. The sync layer drops such a value and the receiver falls back to the field's declared default. - **Durable content.** A scene record outlives the session that wrote it. The next session — a peer loading the world, or the same engine after a restart — mints its own registry, so a recorded handle names a resource that session never created. `asset.create(category, name, handle)` is the crossing: it stores the resource and hands back a ref whose guid does survive both boundaries. A record is also the medium a scene reloads through **inside** one session: a play flip unloads the live entities and rebuilds them from the same bytes a peer receives, and the handle is valid there. So a handle a record leaves out is **parked** in `modules.session` under the entity and component it came from — `park` as the record is written, `withParked` as it is applied. A load inside the minting session puts it back; every other session opens an empty store and the field takes its declared default. ## API ```luau local ResourceHandle = require("modules.resource_handle") local mesh = renderer.mesh.create(geometry) ResourceHandle.isLive(mesh) -- true ResourceHandle.isLive(asset.resolve("wall.texture")) -- false (an AssetRef) ResourceHandle.isLive("cube") -- false ResourceHandle.label(mesh) -- "mesh handle 'msh_grass_1'" -- Component field maps: `data` unchanged when it holds no handle. local data, dropped = ResourceHandle.withoutLive({ model = mesh, visible = true }) -- data -> { visible = true } -- dropped -> { model = "mesh handle 'msh_grass_1'" } -- What a record leaves out, held until no record names the entity. ResourceHandle.park(entityId, "@builtin::components.Model", { model = mesh }) local applyData, restored = ResourceHandle.withParked(data, entityId, "@builtin::components.Model") -- applyData -> { visible = true, model = mesh } -- restored -> 1 -- No record names the entity any more: nothing will put its handles back. ResourceHandle.forget(entityId) ``` `withoutLive` returns the **same table** when there is nothing to leave out, so the common case allocates nothing. When it does drop, the second return names each field and the handle it stood for, so the caller reports what happened at the point it happens rather than leaving the field to fail later. `park` replaces whatever that entity-and-component pair held before, so a field that stops holding a handle stops being restored with the ones that do. `withParked` fills only the fields the record has no value for — a record that carries a value is the authority on it. The scene saver calls `forget` for an entity once a save leaves no record naming it, so what is parked is the size of the entities the scene carries rather than of every entity a session wrote. ## Consumers `scene_saver` asks per field as it serialises an entity, reports the entity, component and field once per session, and parks the handles it left out. `scene_loader` asks per component as it applies a record: it reports the whole scene's count of recorded handles in one line — one generator run writes the same field on every entity it made, so a per-entity report would say the same thing hundreds of times — and puts the parked ones back. `dirty_hot_reload` applies a peer's body to a live entity and leaves the handles in it out.
▲ 0↑ born
▣
module · born here
❒asset
# environment.drawnSky Keeps the sky the scene draws as the light the scene is lit and reflected by, whatever draws it: a sky component, an `ecs.Sky` row content inserted itself, a content sky shader, or the engine's fallback sky. ## Purpose The environment's sky slot is the fallback every surface reflects where no reflection probe covers it, the sky light matte surfaces take, and the source environment lighting (`EnvironmentLighting`) is built from. The follower looks at the sky pass four times a second (`renderer.reflectionEnvironment()`): when a sky is drawn and the slot holds no capture of it, it captures the sky into the slot (`environment.captureSky`), which arms the sky fallback. From then on the renderer retakes the slot itself as the sky changes. A capture waits while the sky's material compiles, and the follower asks again after two seconds when no capture has landed. While a sky is drawn the follower holds a claim on the sky-visibility field (`@builtin::systems.skyVisibility.skyVisibility`), so the sky lights only what can see it, and releases the claim when no sky is drawn. The scene loader starts the follower at the first root scene load, once the renderer is up, so a scene reflects and is lit by its sky with no call from content. ## Usage ```luau local drawnSky = require("modules.api.engine.environment.drawnSky") -- Start following (idempotent; the scene loader already does this). drawnSky.follow() -- What the follower last saw and did. local s = drawnSky.state() print(s.material, s.captured, s.requests, s.claimed) -- Retake the sky slot from scratch: the follower captures the sky again. environment.releaseSky() ``` ## Exports - `drawnSky.follow() -> boolean`: start the follower for the life of this VM; true when this call started it, false when it was already running - `drawnSky.state() -> State`: what the follower last saw and did `State` fields: - `following: boolean`: whether the follower is running - `material: string?`: the material the sky pass draws from at the last look, nil when no sky is drawn - `captured: boolean`: whether the sky slot held a capture at the last look - `requests: number`: captures this follower has asked for - `claimed: boolean`: whether the sky-visibility claim is held
▲ 0↑ born
▣
module · born here
❒asset
# value_type Converts a **handle-backed value type** — `ColorSequence`, `NumberSequence` — between the live object a session holds and the durable payload its `serialize()` produces. A sequence has two forms: | Form | Shape | Meaning | |------|-------|---------| | live | `{ kind = "ColorSequence", __h = 13 }` | `__h` names a curve in **this process's** curve registry | | durable | `{ kind = "ColorSequence", keypoints = { … } }` | the curve itself, which any session rebuilds | `__h` is minted when the curve is created and is meaningful for exactly as long as that registry lives, so a record carrying it names nothing in the session that reads it back. The keypoints are the authored data, and they cross every boundary intact — which is why a record carries the durable form and a live component field carries the live one. Both forms carry `kind`, so a value read out of a component field says which converter owns it whether it came from memory or from a record. The two are told apart by which of `__h` / `keypoints` the table itself holds. `Field.table` copies the table it is handed and drops its metatable, so a live value read back off a component field answers no methods at all. The field gives that same stored table back on every read, so `bind` puts the methods on it once and the field answers them from then on. ## API ```luau local ValueType = require("modules.value_type") local color = ColorSequence.new({ 1, 0.3, 0.1 }, { 0.1, 0.1, 1 }) ValueType.kindOf(color) -- "ColorSequence" ValueType.isLive(color) -- true ValueType.isPayload(color:serialize()) -- true -- The keypoints out of either form. The second argument is the kind to read a -- bare `{ __h = n }` as, for a caller that knows its field's type. ValueType.keypoints(component.color, "ColorSequence") -- The durable payload for a live value; nil for anything else. ValueType.serialize(color) -- { kind = "ColorSequence", keypoints = { … } } -- The live value a payload names, rebuilt in this session; nil for anything else. ValueType.revive(record.color) -- A whole component field map, with every payload rebuilt. local applyData, rebuilt = ValueType.withRevived(record.data) -- Put the methods back on a value read out of a component field. ValueType.bind(component.color, "ColorSequence"):evaluate(0) ``` `withRevived` returns the **same table** when the map carries no payload, so the common case allocates nothing; the second return says how many fields were rebuilt. ## Consumers `scene_saver` asks per field as it serialises an entity, and writes the payload in place of the handle. `scene_loader` rebuilds the payloads in a component's record before applying it, so the component takes the field holding the same curve it held when the record was written. `dirty_hot_reload` does the same as it applies a body, and reduces the live side of its record comparison to the durable form so both sides are compared in one shape.
▲ 0↑ born
◇
component · born here
❒asset
# Asset Promote the bundle's spawned children from temporary to permanent scene state and remove the Asset component, "baking" the bundle's contents directly into the owning scene. Subsequent saves persist the baked entities verbatim and stop replaying the bundle template. Location: `src/lua/lib/components/Asset.component`
▲ 0↑ born
▣
module · born here
❒asset
# asset_create `asset.create` — the single, generic "instance a new asset of an existing type" API. The same entry point scripts and agents use; there is deliberately no tool wrapper, because agents author in Luau and call `asset.create(...)` directly. ```lua local inst = asset.create("material", "my_metal", { base_color = { 0.8, 0.7, 0.2 } }) -- → AssetRef: inst.path == "/zero/source/my_metal.material", inst.guid, plus the -- material type's ref methods. ``` `asset.create` makes a new *instance of an already-registered type* by running that type's `onCreate(name, opts)` behaviour hook (declared in its `behavior.luau`) and writing the produced files to `/zero/source/<name>.<typeName>/` — the one authored location, in every mode. While play runs, the play-mode write lock takes that write onto the **play shadow**: live in the session, listed by `vfs.playShadowPaths()`, and promoted or discarded on a guarded play-exit. The asset created in play therefore carries the same identity, path and `require` spelling it has in edit, and the session decides whether it stays. A create whose output the world **reproduces** on every load — one made from a component or a scene entrypoint — writes to the copy-on-write runtime store at `/zero/runtime/assets/<identity>.<typeName>/` instead, so the code that rebuilds it each load is its only source and the saved manifest never carries a second copy. ## Placement Four `opts` keys are consumed by the framework before the type's `onCreate` hook runs, and steer where the instance lands: | Key | Effect | |-----|--------| | `folder` | A relative subfolder under the source root: `/zero/source/<folder>/<name>.<typeName>/`. Groups a generator's output instead of accumulating it at the source root. | | `into` | A resolved container ref (`.toolbox` / `.package`) to author INSIDE — lands at `<container>/<name>.<typeName>/` and registers as a member. Edit-mode only. | | `dest` | An absolute destination path, owned by the caller (an importer building a `<name>.bundle/`). | | `overwrite` | Re-author an existing destination in place, keeping its `.meta` guid so every reference stays valid. | The `name` is always the asset's bare identity — the path goes in `folder`: ```lua local rock = asset.create("mesh", "rock", { positions = p, indices = i, folder = "terrain/props" }) -- → rock.path == "/zero/source/terrain/props/rock.mesh" ``` `dest` and `into` both take precedence over `folder`. `folder` decides the asset's identity, so it applies in every context: the runtime store is flat and spells that identity in one folder name. ```lua -- the same call from a component's awake() -- → rock.path == "/zero/runtime/assets/terrain.props.rock.mesh" -- → rock.identity == "terrain.props.rock", as it is from an execute ``` Types without an `onCreate` hook fall back to cloning their verbatim `template/` skeleton to the same destination, so `create` works for every type. Returns the created asset's `AssetRef` (`.path` / `.guid` plus the type's ref methods — the same interned instance `asset.resolve` returns) on success and raises (via `error`) on bad arguments or a failing `onCreate`. Installed onto the FFI `asset` namespace by the prelude (`M.installInto(asset)`). See `docs/specs/runtime-asset-copying.md`.
▲ 0↑ born
▣
module · born here
❒asset
# layers Top-level scene-management global + Scene proxy. § 17 step 9 of `docs/plans/2026-05-01-player-camera-unification.md`. Renamed from the legacy `scene.*` global to match `/runtime/layers/` and to give scene-management state (active root, additives, callback registries) a single anchor distinct from per-scene authoring. ## Global surface | Symbol | Type | Notes | |---|---|---| | `layers.active` | `Scene \| nil` | Current root non-additive scene as a proxy. Live read; updates on every load/unload. | | `layers.list()` | `{ Scene }` | Every loaded scene (root + additives) as proxies. | | `layers.find(ref)` | `Scene \| nil` | Lookup by `AssetRef<scene>` or layer-id string. | | `layers.is_loaded(ref)` | boolean | | | `layers.load(ref, opts?)` | — | Loads ref. `opts.additive = true` layers on top; default = non-additive (replaces root). | | `layers.unload(ref?)` | — | Unloads ref; nil = active root. | | `layers.reload(ref?)` | — | Equivalent to unload + load with same ref. | | `layers.onLoad(cb) -> handle` | function | Subscribe to any scene-load event. Returns handle for `offLoad`. | | `layers.offLoad(handle)` | function | | | `layers.onUnload(cb) -> handle` / `offUnload(h)` | function | Same shape for unload events. | | `layers.observe()` | `SceneObservation` | What every load did and what each loaded scene costs, in one read. | | `layers.lastLoad()` | `SceneLoadReport \| nil` | The last load's report; nil when nothing has loaded. | | `layers.lastUnload()` | `SceneUnloadReport \| nil` | The last unload's, under the name the layer was loaded with. | | `layers.loadHistory()` | `{ SceneLoadReport }` | The completed load reports still held, oldest first. | | `layers.problems(ref?)` | `{ SceneLoadFailure }` | What a layer failed to produce, and why. | | `layers.whyPartial(ref?)` | `(reason?, detail?)` | The nearest cause a layer is not whole, from a closed set. | | `layers.inventory()` | `{ SceneLayerInventory }` | What the engine attributes to each loaded layer. | | `layers.cost()` | `{ SceneLayerCost }` | Each layer's per-frame entrypoint tick, summed across the window. | | `layers.resetCostWindow()` | — | Open a new cost window. | ## Scene proxy surface A `Scene` proxy is a sealed table with fields and `:method` callables. | Field / method | Notes | |---|---| | `s.asset` | `AssetRef<scene>` | | `s.name`, `s.path` | informational (logging, debug) | | `s.guid` | the scene asset's guid — the layer's identity | | `s.sceneIdentity` | the identity of the scene asset the layer was loaded from (e.g. `@builtin::scenes.test_arena`), whichever VM loaded it | | `s.additive` | boolean — additive overlay vs root scene | | `s.parent`, `s.children` | additive ownership chain | | `s:root()` | walks `.parent` to the non-additive root; returns self for roots | | `s.players`, `s.camera` | populated by §17 step 10 (player + camera spawners) | | `s.entrypoint` | `AssetRef<script> \| nil` | | `s.visible` | boolean — read via field, toggle via `s:set_visible(b)` | | `s.state` | `"loading"` / `"loaded"` / `"ready"` / `"partial"` / `"unloading"` — the layer's lifecycle state. Both `"ready"` and `"partial"` are terminal: the load has settled. | | `s.ready`, `s.loaded` | booleans in lock-step with `state`. `ready` is true once the layer has settled, in either terminal state — it is the flag to wait on. | | `s.ok` | boolean — whether everything the scene declared was produced and the layer has run clean since. False whenever `state` is `"partial"`, including when the tick starts raising long after the load settled. | | `s.failures` | `{ SceneLoadFailure }` — every distinct failure the load and the layer's per-frame tick produced, each with the `count` of how often it repeated. | | `s:unload()` | unload this scene; additives use `layers.unload(layerId)`, roots use `layers.active:reload()` | | `s:reload()` | unload + reload same ref | | `s:set_visible(b)` | show/hide without unloading | | `s:load_additive(ref)` | load a sibling additive overlay; returns the new proxy | ## Example ```lua -- Switch root scene layers.load(asset.ref("@builtin::scenes.baseline_visual")) -- Subscribe to all loads local h = layers.onLoad(function(scene) print("loaded:", scene.name) end) -- Layer an HUD overlay on top layers.load(asset.ref("@builtin::scenes.hud"), { additive = true }) -- Iterate every loaded scene for _, scn in ipairs(layers.list()) do print(scn.name, scn.additive and "(additive)" or "(root)") end layers.unload() -- unload the active root layers.offLoad(h) ``` ## What a load did, and what a scene costs Every load writes one record at its own completion point; the readings below compose that record, so a caller that did not make the load can still ask what it did. A load that produced failures settles into `"partial"` rather than `"ready"`, and names the nearest cause from a closed set: `loaderRaised`, `entrypointCompileFailed`, `entrypointBodyRaised`, `entrypointRaised`, `buildRaised`, `entityFailed`, `parentMissing`, `parentRefused`, `parentAbandoned`, `componentUnresolved`, `componentRefused`, `subscriberRaised`, `updateRaised`. ```lua layers.load(asset.ref("scenes.arena", "scene")) -- Did it come up whole? if not layers.active.ok then local reason, detail = layers.whyPartial() print(reason, detail) for _, f in layers.problems() do -- `count` rises when the same failure happens again, so a per-frame -- tick that keeps raising stays one line. print(f.phase, f.reason, f.entity, f.component, f.hook, f.count) end end -- What did the swap do? local r = layers.lastLoad() print(r.name, r.outcome, r.durationMs) print("replaced", r.replaced and r.replaced.name) -- the root that went print("cascaded", #r.cascaded) -- the overlays with it print(r.entities.added, "arrived,", r.entities.removed, "left") print(r.phases.teardown, r.phases.instantiate, r.phases.settle) -- Which loaded scene is expensive? `totalMs` is a SUM across the window, so -- reset it first and read `avgMs` for the per-tick figure. layers.resetCostWindow() task.wait(1) for _, c in layers.cost() do print(c.name, c.avgMs, "ms/tick over", c.calls, "ticks") end -- What does each layer hold, and what does no layer claim? for _, l in layers.inventory() do print(l.name, l.entities, l.ok) end print(layers.observe().totals.unattributed) ``` The `scene` toolbox carries the same two readings as `scene.observe` and `scene.whyPartial`. ## Authoring surface `layers.*` is the sole public scene-management surface. It accepts AssetRefs (not paths), drives a callback registry, and constructs Scene proxies that carry players / camera / hooks. The previous `scene.*` global has been removed — its low-level FFI bindings now live behind `layers.*` and the Scene proxy methods.
▲ 0↑ born
▣
module · born here
❒asset
# presence Editor presence: who else is in this scene, where they are looking from, and what they are working on, for every client of the world in edit mode. People in their editors and agents in their sub-clients appear alike. Each client occupies one entity of its own, the way a player occupies its avatar in play: a temporary `PlayerOwned` root that the edit room relays like a player's subtree and the scene never records. It stands where the client's camera stands, and its `EditorPresence` component carries who the client is and what it is doing: its selection, the entities it is changing, and the call an agent is making. Every other client draws that participant on the entity it receives: a viewpoint marker in the participant's colour, a name label stating the activity, and an outline in the same colour around each entity the participant has selected or is changing. ```lua local EditorPresence = require("@builtin::modules.api.editor.presence") EditorPresence.ensureRegistered() -- the debug-viz provider that draws the others EditorPresence.tick(dt) -- publish this client's presence (the editor's per-frame tick) EditorPresence.noteChanged(entityId) -- this client is changing that entity now for _, p in EditorPresence.participants() do print(p.name, p.kind, p.activity) end local color = EditorPresence.colorOf("agent-1") -- the same colour on every client ``` | Call | Does | |------|------| | `ensureRegistered()` | Registers the provider that draws the other participants. Idempotent. | | `tick(dt)` | Occupies this client's presence entity, moves it to the viewpoint and states the selection, the entities being changed and the agents' activity. Runs from the editor's per-frame tick in edit mode. | | `noteChanged(id)` | Notes that this client changed the entity `id` now, so its presence states it is changing it for the next two seconds. | | `track(id, presence)` / `untrack(id)` | Starts and stops drawing the participant on the presence entity `id`. | | `participants()` | One row per remote participant this client draws: its name, kind and activity. | | `colorOf(name)` | The `{ r, g, b, a }` colour a participant named `name` is drawn in, the same on every client. |
▲ 0↑ born
◇
component · born here
❒asset
# Camera Manages viewport priority, render-to-texture, and capture. State is stored in the native `Camera` ECS component; the Rust camera system handles render scheduling and render targets. Public fields: `fov`, `near`, `far`, `priority`, `textureHandle` (the guid of the texture the camera renders into; empty = main viewport), `renderLayers` (which render layers this camera draws — a space-separated spec of names, e.g. `"all"`, `"all !ui"`, or `"default sky"`; `ui`/`sky`/`debug`/`EditorUI` are built-in layers), `postProcessing` (whether this camera runs the post-process chain), `debugChannel`, plus the behavior slot below. Methods: `:lookAt(target)` (entity id string OR `{x, y, z}` table), `:render()`, `:capture()`, `:setTargetTexture(tex?)` (a `renderer.texture.create` handle to render into, or nil for the viewport). ```luau entity(id).component.add("Camera", { fov = 90, priority = 10 }) entity(id).component.get("Camera"):capture() ``` The scene's play-mode camera is reached as `layers.active.camera`, a handle that reads and writes the fields above on whichever entity currently carries them. `layers.active.camera.entity` is the entity ref for that camera and `layers.active.camera.entityId` its id string, so a script that needs to attach something to the camera — an `AudioListener`, a child entity — goes through the ref: ```luau local cam = layers.active.camera cam.fov = 70 -- the camera's settings cam.entity.component.add("AudioListener") -- the entity carrying them ``` ## How the camera moves: `behavior` and `follow` A `Camera` does not move itself. `behavior` names a component that does, and setting it attaches that component to this entity. Clearing it detaches whatever was attached. ```luau local cam = entity(id).component.get("Camera") cam.behavior = asset.ref("@builtin::controller.orbital_follow", "component") cam.follow = playerBody ``` The attached behavior is an ordinary component on the camera's entity, so it is tuned the way any component is: read it with `component.get` and set its fields there. A `component.add` of the same type configures the instance the slot attached instead of adding a second one: the values it passes are written onto that instance and its proxy is returned. That add is the form a scene `build.luau` tunes the behavior with, because its values are saved with the scene and the loaded Camera's behavior takes them back. A key the component reads only as it is created (one of its `initKeys`, a private field) refuses the add and names the key. ```luau cam.behavior = asset.ref("@builtin::controller.third_person_follow", "component") local rig = entity(id).component.get("third_person_follow") rig.cameraDistance = 6 -- the same, as an add of the type the slot attached entity(id).component.add("third_person_follow", { cameraDistance = 6 }) ``` `follow` is the standard slot every shipped behavior reads. Set the follow target on the **Camera**, not on the behavior, so swapping behaviors keeps it. A behavior that finds its own `follow` field empty falls back to this one, which is what lets a rig keep tracking the player across a behavior swap. `followResolves` answers whether that slot names an entity that is live — `true` while it names a live one or names nothing at all, `false` once the target is despawned or the id names no entity. A rig whose target does not resolve holds its last pose, and this is the field that tells it from a rig posed correctly on a subject that has not moved. `camera.get` carries the same value beside `follow`, and a write naming an id with no entity behind it draws a warning where it lands. ```luau cam.followResolves -- false once the followed entity is gone tools.use("camera", "get", id).followResolves -- the same answer off the tool ``` The shipped behaviors live under `@builtin::controller.*`: `orbital_follow`, `third_person_follow`, `first_person`, `free`, `orbit`, `chase`, `isometric`, `rts`, `birds_eye`, `side_scroller`, `cinematic`, `menu`. ## Writing your own Any component can be a camera behavior. Write one that moves its own entity and attach it the same way: ```luau cam.behavior = asset.ref("MyChaseCam", "component") ``` `follow` lives on the Camera, so a behavior gets no property notification of its own when the target changes. Declare `onFollowChanged(newFollow, oldFollow)` to be told the moment it does — the Camera calls it on the component it attached, which is what lets a rig re-pose on the new subject at once. A behavior that reads `Camera.follow` on its own schedule declares nothing and is attached the same way. ```luau typed function public:onFollowChanged(newFollow: any, oldFollow: any) -- pose this entity against the new target end ``` To make it appear in the discovery catalog alongside the shipped ones, declare the `cameraBehavior` tag in the component's `.metadata`: ```json { "tags": ["cameraBehavior"] } ``` The tag governs **discovery**, not attachment. A tagged component is listed by `layers.active.camera.behaviors` and is what tooling offers when something asks "which camera behaviors exist"; an untagged component attaches just as well and simply stays out of that list. Tag the ones you want other people (and agents) to find. ```luau for name, ref in pairs(layers.active.camera.behaviors) do print(name, ref.identity) end ``` ## Texture colour space `textureColorSpace = "display"` applies the display transform when rendering into a texture. `"linear"` writes scene-linear values instead. `postProcessing` independently controls the effects chain in either mode. Floating-point targets retain values above one; normalized targets clamp to their representable range. The main viewport uses display encoding.
▲ 0↑ born
▣
module · born here
❒asset
# persist.origin Provenance / origin-context layer for the persist (create-flow) system. The problem persist must solve: when the agent freezes live play state into `scene.json`, it must capture **only** the things that would not otherwise be reproduced on the next load — i.e. creations whose stack root is the agent's ad-hoc `execute()` context. Anything created by `onLoad` / the scene loader or by a component callback re-runs on every load, so freezing it would duplicate it. This layer tags each live creation with its origin context (via wrappers installed over the entity API) and exposes the current origin, so the serializer can keep execute-origin entities and drop the rest. See `docs/specs/multiplayer/candidate-c-persist-flow.md`.
▲ 0↑ born
◇
component · born here
❒asset
# Player Identity tag for a player entity. Attaches the Rust `PlayerOwned` marker via `__native` in `awake` and removes it in `onDestroy`. No public state, no update loop, no visuals. ```luau entity(id).component.add("UserIdentity") entity(id).component.has("UserIdentity") -- true ``` Future rules (not yet enforced): - **Non-serialising.** Scene and world saves omit this component. Players are attached at runtime per peer, not inherited from the save file. - **Non-removable.** Once an entity is a player, removing this component is a no-op. A player stays a player for its lifetime outside an explicit identity swap. Visuals, cameras, input, and movement live in separate components (e.g. `PlayerController`, `PlayerTemplate` bundle content) so adding or removing them never affects identity.
▲ 0↑ born
▣
module · born here
❒asset
# persist.serializer Live-state serializer driver for persist — the play-mode half of the scene-save story. `scene_saver.serializeEntity` already turns a live entity into the v6 per-entity body, but it is only ever fed ids from the edit-mode dirty-mark queue (empty in play). This driver supplies the play-mode side: it enumerates the active layer's live entities, filters them by **provenance** (execute-origin only, via `persist.origin`) and **authored-ness** (`scene_saver`'s spawner-managed / temporary filter), and assembles a loadable v6 scene body. Lighting stays entity-primary: it comes from `Light` components on the live entities, not from a separate lighting block.
▲ 0↑ born
▣
module · born here
❒asset
# vfs_async_read Pure-Luau wrapper that grafts a yielding `vfs.read` over the engine's sync `vfs.read` binding. The `vfs` API module (`modules/api/engine/vfs`) calls `M.installInto(vfs)` on itself as it loads, so every VM holding `vfs` (user VMs and the trusted VM alike) reads through it; user code never requires this module directly: it just calls `vfs.read(path)` and the wrapper handles cache misses by yielding the running coroutine until the bytes resolve. ## Exports - `M.installInto(vfs: VfsNamespace)`: replace `vfs.read` (and `vfs.readBounded` and `vfs.list`) with the yielding wrapper. No-op when the target lacks `read` and `readAsync` as functions. - `M.CANNOT_WAIT`: `"VFS_READ_CANNOT_WAIT"`, the code a read raises when it names a known file whose bytes have not arrived and the reading code cannot yield. Types: - `VfsNamespace = { read?, readAsync?, readBounded?, list? }`: the engine's `vfs` global shape. ## Usage ```luau -- The `vfs` API module installs the wrapper onto itself as it loads: require("@builtin::modules.vfs_async_read").installInto(vfs) -- After install, every `vfs.read` call yields on cache miss, and a read -- that finds no bytes answers nil and the reason: local bytes, why = vfs.read("/zero/source/some.asset") ``` ## Where a read can wait - On a miss the wrapper schedules `vfs.readAsync(path, opts)`, which fires `BlobProvider::fetch` under the hood, and `task.await`s the promise. A wait that resolves without bytes answers nil and the reason: the sentence the engine's read gave beside its nil, or, for bytes that were on their way, the one it gives once the wait ends. - Waiting takes a yield, so it happens where `coroutine.isyieldable()` is true: a task, the component hooks the engine runs on a coroutine (`awake`, `start`, `update`, `fixedUpdate`, `onEnable`, `onOwnerChanged`, `onSyncReceived`), a replicated event's handlers, and a world or scene entrypoint's hooks. - Where it is false (`onDisable`, `onDestroy`, `onPropertyChanged`, a received synced-function call, a `vfs.watch` callback, a module's top level while `require` runs it, a metamethod, a `table.sort` comparator, a VM's main thread) a miss the engine's read answers `nil, "pending"` for (a file `vfs.exists` knows that is no directory and whose bytes can still arrive, a render surface being captured, a `/runtime/sync` node whose current reading the next frame assembles) raises `VFS_READ_CANNOT_WAIT: vfs.read("<path>") ...`, naming the path and the places it can be read from. Every other miss answers nil and the reason there as everywhere else. - `vfs.list` answers a directory whose current listing the next frame assembles (a `/runtime/sync` directory nothing has read lately) after waiting that frame where the code can yield, and raises `VFS_READ_CANNOT_WAIT: vfs.list("<path>") ...` where it cannot. - `installInto` is idempotent in the trivial sense: calling it twice re-wraps `vfs.read` around the already-wrapped function, which is fine but pointless.
▲ 0↑ born
▣
module · born here
❒asset
# luau_introspect (module) Parses Luau/asset source TEXT into structured declarations. Pure string/pattern parsing (`string.find` / `string.match` / `string.gmatch`) over the literal source — no compiling, no VM spawn, no runtime state, no engine FFI. Given source text, it extracts what is written in the file. This is the shared parser every per-assetType `M.ref.inspect` hook uses to turn a component/module/tool's own source into the structured record `asset.inspect` returns. ## Exports - `docstrings(src) -> DocMap` — scans `--!desc` / `--!arg` / `--!return` / `--!example` comment runs and binds each run to the name of the declaration on the next non-comment line (the identifier after `function`, `public:`, `local function`, or `M.`). - `publicFields(src) -> { FieldEntry }` — parses `public = { name = Field.<kind>(default, mode), ... }` table-literal entries and module-scope `public.<name> = Field.<kind>(...)` assignments. - `events(src) -> { EventEntry }` — parses `events = { name = Event(payloadSchema?, syncMode?), ... }` table-literal entries. - `methods(src) -> { MethodEntry }` — parses `function public:<name>(...)` / `typed function public:<name>(...)` declarations (params + optional return type). - `lifecycleHooks(src, catalog) -> { string }` — top-level `function <name>(` declarations whose name is in the caller-supplied `catalog` array. - `moduleExports(src) -> { ExportEntry }` — parses `M.<name> = function` assignments, `function M.<name>(...)` declarations, and a trailing `return { foo = foo, ... }` export table. - `forSource(src, computeFn) -> any` — memoises `computeFn(src)` keyed on `src` itself in a module-local table. The same source text returns the cached result without re-running `computeFn`; different source text recomputes. Keyed on the source content (not an asset checksum) because composite/container assets (component folders, scene folders, etc.) all hash to the empty-string checksum — a checksum-keyed cache collapses every such asset's detail onto whichever one was inspected first. ## Usage ```luau local Introspect = require("modules.luau_introspect") local src = self:getInitScript() local detail = Introspect.forSource(src, function(s) return { fields = Introspect.publicFields(s), events = Introspect.events(s), methods = Introspect.methods(s), hooks = Introspect.lifecycleHooks(s, lifecycleCatalog), } end) ``` ## Notes - Every function is a pure string→table transform: same source text in, same structured table out, every time. No reads of live component state, no entity/world queries. - Structural scanning runs over a comment- and string-aware **mask** of the source (a same-length copy where comment bodies and string-literal contents are blanked to spaces, delimiters and newlines preserved). Pattern matches and brace/paren balancing run on the mask — so a brace, `Field.`, `Event(`, or a whole entry that appears inside a comment or a string literal never registers — while captured values are sliced from the original source at the same (aligned) indices. This makes the parser robust to apostrophes in comments, commented-out entries, string defaults containing `}` / `Field.` / `Event(`, and `[[ ]]` long strings. - `default` / `category` are raw trimmed source-text slices (with any trailing comment stripped), not evaluated values. - For a **ref constructor** (`Field.assetRef` / `dataRef` / `resource` / `componentRef`) the FIRST positional argument is the category / contract / componentType selector, captured under `category`; the SECOND argument is captured under `default`. - For every **other** Field kind the first argument is the `default` and `category` is nil. - A trailing `Sync` / `NoSync` identifier is captured as `sync`, tolerating a trailing comma or a trailing comment after the last argument. - Field/Event entries whose key is a computed or indirect expression (`[expr] = Field.number(...)`) are omitted — only literal identifier keys are recognised. - `methods` captures a `...` variadic parameter (as `name = "..."`), with its `: <type>` annotation when present. - A `--!desc` written above a field/event declaration (`<name> = Field.<kind>(...)` / `<name> = Event(...)`) or a `public.<name> =` assignment binds to that name in `docstrings`, and is folded into the corresponding `publicFields` / `events` entry's `desc`. - `lifecycleHooks` never hardcodes the lifecycle-callback catalog; the caller passes the list of names to match against. - `forSource`'s memo is bounded (oldest-key eviction) so a long session touching many distinct asset versions can't grow it without limit.
▲ 0↑ born
▣
module · born here
❒asset
# yaml.module YAML decode + encode for authored engine content. Pure Luau, no engine dependencies — a general parsing library, not data-system plumbing. ```luau local Yaml = require("@builtin::modules.yaml") local doc = Yaml.decode(vfs.read(path)) vfs.write(path, Yaml.encode(doc)) ``` ## Supported subset - Block mappings (`key: value`) and block sequences (`- item`), nested to any depth. - Compact sequence-of-mapping entries (`- path: x` / ` kind: y`). - Flow collections — `{ a: 1, b: 2 }` and `[1, 2, 3]` — single line. - Plain scalars with type inference: `~` / `null` → nil, `true` / `false` → boolean, numeric literals → number, everything else → string. - Single- and double-quoted strings (`''` escapes a literal quote inside a single-quoted string; `\n` `\t` `\r` `\\` `\"` inside a double-quoted one). A quote opens a quoted scalar where a scalar begins — after `key:`, after a `- ` entry marker, or inside a flow collection — so a plain scalar carries an apostrophe as data (`note: the world's rules`). Quoted keys are read in flow mappings. - `#` comments — honored outside quotes, so a `#` inside a quoted string is kept as data. - Literal (`|`) and folded (`>`) block scalars, with a chomping indicator (`-` strips the final newline, `+` keeps every trailing blank line, none keeps one newline) and an indentation indicator (`1`-`9`: the content's indent past the parent's), in either order (`|-`, `>+`, `|2`, `>1-`). A block scalar's content is literal text: quotes (balanced or not), `#`, `key: value` and `---` inside it are data. - An optional leading `---` document marker. ## Loud-error contract Constructs outside the subset above raise instead of misparsing: anchors/aliases (`&`, `*`), tags (`!`), directives (`%`), multi-document streams (a second `---`), a block-scalar header it cannot read (`|x`, `|-+`, `|0`), tab indentation, and inconsistent indentation (both block structure and block-scalar bodies). Every error carries the offending line number (`yaml: line N: ...`), so a bad config points straight at the line to fix. Tab indentation is rejected everywhere — including block-scalar body lines whose leading whitespace contains a tab. A tab after the first non-space character of a line is content and passes through. ## API - `Yaml.decode(text: string): any` — decode a YAML document into a Luau value (table, scalar, or nil for an empty document). Raises on malformed input or an unsupported construct. - `Yaml.decodeWithComments(text: string): (any, boolean)` — decode as `decode` does, and report whether the text carries a comment by the decoder's own rule: a `#` at a line's start or after whitespace, outside a quoted scalar and outside a block scalar. Re-encoding the value drops such comments, so an editor that writes a document back reads this first. - `Yaml.encode(value: table): string` — encode a Luau table as YAML (block style, two-space indent, alphabetically sorted keys). Raises on values YAML can't represent (functions, userdata, non-string mapping keys). A top-level empty table encodes to an empty document, which decodes back to `nil` (the YAML empty-document ambiguity).
▲ 0↑ born
▣
module · born here
❒asset
# assetType runtime The machinery that reads a `<typename>.assetType/behavior.luau` and turns its declarations into live behaviour. A `behavior.luau` is a table of declarations — `ref` methods, `modules` shared code, an `events` schema, a `namePattern`, `refShapes`, and the `onCreate` / `onRegister` / `onChange` / `onDelete` / `validate` / `settingsDefaults` / `settingsCorrections` hooks. None of it runs itself. This is the code that runs it, and it lives here because reading a type's declarations is the **assetType type's own behaviour** — the same way `material.assetType` owns what a `.material` does. ## Sub-modules | Module | Reads | Responsibility | |---|---|---| | `ref.module` | `ref`, `modules` | Builds every `AssetRef` envelope, attaches the shared metatable, and dispatches per-type methods and shared modules onto it. Also owns edit-mode write-behind persistence. | | `create.module` | `onCreate`, `namePattern`, `validate` | Backs `asset.create`: resolves the type, checks the name against its pattern, runs `onCreate` (or clones `template/`), and writes the instance. `validate.module` beside it checks a creation `opts` table against the type's `createSchema`. Before running `onCreate`, resolves the type's settings chain (below) and hands the result to the hook as `opts.settings`. | | `settings.module` | `settings`, `settingsDefaults`, `settingsCorrections` | A type's declared settings schema and where its values live (`type.yaml`'s `settings:` block). `Settings.resolveForCreate` layers the schema's own defaults, the type's own `settingsDefaults(name, opts, asked)` hook (a DEFAULT the schema can't express — a name-derived convention, a fact read off a payload the caller handed it, a value following a field `asked` shows a higher layer naming; any later layer overrides it), the Preset Manager, an importer's settings, the caller's `settings` table, then the type's own `settingsCorrections(values, name, opts)` hook (a CROSS-FIELD CONSTRAINT the schema can't express, applied last over the fully merged values). A correction over a default/preset/importer value lands silently; a correction that would override what the caller's own `settings` table explicitly asked for refuses the creation instead, naming the field and why. Neither hook is ever handed a table to mutate; each returns what it wants changed (`settingsCorrections` may also return a `{ [field]: reason }` table for that refusal message). `Settings.cloneValues` deep-copies a values table — `create.module` hands `onCreate` a copy, never the table it stamps. `Settings.valuesOf` / `writeValues` read and write an asset's own values file. | | `typeYaml.module` | `type.yaml` | The folder a type lives in and its parsed `type.yaml`, decoded once per content version of the file. `settings.module` and `inspector.module` read their blocks through it. `about` / `aboutAt` read a type's `about.yaml` (`intent`, `function`, `usage`), leaving out any key that is empty or still starts with `[[describe]]`; `aboutRows` and `aboutMarkdown` lay the texts out for the Inspector and the `types/<name>` guide. | | `inspector.module` | `type.yaml`'s `inspector:` block | Which inspector a type declares for its assets (`inspector: { type: ... }` or `{ instance: ... }`), and the declaration that file returns — the sections it adds, the generic ones it replaces, and their order — or the problem that kept it from loading. | | `onRegister.module` | `onRegister` | Fires an instance's once-only registration hook — on arrival, on world load, and for `@builtin` library instances. | | `changeDispatch.module` | `onChange`, `onDelete`, `refShapes` | Routes a VFS source write or a folder delete to the enclosing typed asset's type hooks. | | `refShapes.module` | `refShapes`, `ref` | Publishes what every `AssetRef<category>` answers to, so a member read on an asset-typed value is checked against that category's real surface. | | `events.module` | `events` | The per-asset event runtime behind `ref.events`. | | `instantiable.module` | `ref.instantiate` | The instantiation contract an asset type opts into: `root` stands the root entity, `place` applies the base placement opts to one the type adopted, and `result` shapes the `(root, idMap)` every `instantiate` returns. Also registers the `sceneInstantiable` field-constraint validator. | | `declaration.module` | `type.yaml` | The type's decoded declaration, read once and held until a write inside an `.assetType` folder; what every question about a type as a whole reads. | | `previewRecipe.module` | `type.yaml` `preview:` | How an instance's `preview.png` is produced: which of the four recipes (`instantiate`, `image`, `surface`, `custom`) the type declares, and what that recipe needs. | ## Reaching it ```luau local rt = require("@builtin::assetTypes.assetType.shared") rt.ref.loadTypeBehavior("material") ``` Fields resolve lazily. The prelude requires the sub-modules directly, in dependency order (`ref`, then `changeDispatch`, `onRegister.install()`, `refShapes.install()`) — a table that required all six on load would take that ordering away from it.
▲ 0↑ born
backing path · assetTypes/scene.assetType/shared.module

Problems

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

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

Usability ratings

Did the part work as advertised when consumers tried to drop it in. Separate from upvotes: those are taste; this is "did it function".

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

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

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