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

loader

Luau-side scene loader. Reads `scene.json` v6, dispatches to engine FFIs, runs the sibling `entrypoint.luau`.

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

scene.shared.loader

Luau-side scene loader. Reads scene.json v6, dispatches to engine FFIs, runs the sibling entrypoint.luau.

Public surface

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 assumedActual engine API
json.parse(s)require("..json").decode(s) (modules.json)
json.encode(t)require("..json").encode(t)
entity.spawn(n, { layer }).idlayer 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.

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 scene_loader Luau-side scene loader. Reads scene.json v6 and v7, refuses versions outside that range with a typed error, dispatches to entity.spawn / component.add / lights.setup, auto-discovers the sibling entrypoint.luau via vfs.exists. v6 attaches the declarative player + camera blocks to the Scene proxy for procedural resolution; v7 stashes the string player intent and does no procedural player/camera spawn. Replaces the legacy Rust __layers.load FFI path; the Rust FFI remains for one release as a safety net but is no longer invoked by any in-tree caller. Delta-overlay aware: when a `scene_dirty/` directory exists next to canonical scene.json, the loader hands the merge off to `scene_saver.composeMerged` — canonical scene.json + dirty manifest overrides + per-entity overlay files = the assembled body. Single merge point so the load + promote paths can never disagree. See § 10 of the player-camera-unification integration design for the architecture rationale (pure Luau, performance budget ~5 ms per 1k-entity scene, ECS FFI is sufficient without new primitives). require @builtin::assetTypes.scene.shared.loader

applyingRecords( ) → boolean

Whether a scene load is applying its records, or running the work components handed in to run after them, right now. A build that runs inside such a load reruns on every load.

examples

if Loader.applyingRecords() then log.info("inside a load") end

afterRecordsApplied(fn: () →

Run `fn` once every record of the scene load that is applying records right now has landed: every entity it states spawned, parented and carrying the components and attributes its record states. A component waking as one of those records is applied reads the entities beneath it in whatever state the records before it left them, and a record after it puts back what its own record says; work that reconciles those entities against something else (a placement rebuilding what its module now states) belongs after the last record, where nothing the load applies comes after it. Outside such a load, or once the load's records have all landed, there is nothing to wait for: `fn` runs before this returns, and an error it raises reaches the caller. Work that waits runs after the last record, in the order it was handed in, each function in its own protected call, so one that raises is logged and the rest still run.

argtypedescription
fn(The work to run.

examples

Loader.afterRecordsApplied(function() print(#entity.findAll(), "entities applied") end)

applyingPeerRecords( ) → boolean

Whether the records being applied to a loaded scene right now were written by another session sharing this world: a peer's edit, or what a peer's build placed, arriving as that peer's records. A build is run by the session the change that asks for it was made in, and what it places reaches every other session as the records it writes, so a placement waking while this reads true is one a peer's records put here, holding what that peer already built.

examples

if Loader.applyingPeerRecords() then return end

applyPeerRecords(fn: () → void

Apply records another session wrote: run `fn`, reading `applyingPeerRecords()` as true for as long as it runs. An error `fn` raises reaches the caller once the state is put back.

argtypedescription
fn(The application.

examples

Loader.applyPeerRecords(function() applyBody(eid, body) end)

runAfterRecords(window: RecordsWindow, sceneGuid: any, handBack: () → void

Run what `window` holds, in the order it was handed in. The window reads as running first, so work handed in while these run (a placement one of them builds waking) runs at once, inside the function that placed it. Before each piece of work, `handBack` hands the frame back on the terms it does before each record, so the work a load runs after its records spreads across frames the way its records do.

argtypedescription
windowRecordsWindow
sceneGuidany
handBack(

resolveSceneJsonPath(ref: ?) → void

Turn a scene ref or path into the absolute VFS path of its scene.json. Accepts AssetRef envelope, identity string, or VFS path.

argtypedescription
ref?

attachedByComponent(id: string, kind: string) → boolean

Whether another component's own code attached the `kind` instance entity `id` holds: a Camera's `behavior` slot attaching its controller, an asset composing what it expands into.

argtypedescription
idstring
kindstring

gameplayPaused( ) → boolean

Whether gameplay is paused (`engine.paused`, which edit mode starts with): physics, component `update`s and gameplay tasks stand still until it runs again.

currentTask( ) → number

The scheduler handle of the task the calling code runs in, or nil outside any scheduler task.

inComponentContext( ) → boolean

Whether the calling code runs in a component's context: one of its hooks, or a task one of them spawned. The scheduler holds a wait made there for as long as the engine stays in the state that stops that kind of task (a gameplay task while gameplay is paused, an editor task while play runs), so a load that waited there part way through its records would leave its scene half applied for that long.

handBackHere( ) → boolean

Hand the frame back from inside the scene load the calling code runs in, on the terms the load hands it back between its own records: the code runs on the coroutine of a direct load outside any component's context, gameplay is paused, and this frame's slice (`FrameBudget`) is spent. The load then goes on with the caller on the next frame, reading as partly applied (`M.partlyApplied`) across the frames in between. Work a load runs as one piece (a placement that wakes in it building what its module states, run after the records) calls this between its own units, so it spreads across frames the way the records do. Anywhere else it returns at once. once.

examples

if Loader.handBackHere() then print("this load hands the scene back here") end

partlyApplied( ) → string

The scene a load is applying part way through its records while it has handed the frame back between two of them, or nil when no load is. Such a scene's layer holds only the records applied so far; the load goes on with the next record on a later frame. A load whose task has ended (cancelled with its records part applied) no longer counts.

examples

while Loader.partlyApplied() ~= nil do task.wait() end

checkVersion(body: ?, sourcePath: ?) → void

argtypedescription
body?
sourcePath?

validate(ref: ?) → void

Validate that the scene at `ref` can be loaded without throwing. Reads canonical + dirty overlay, parses, checks version, checks structural shape. Side-effect-free — does NOT spawn entities, does NOT unload the current scene, does NOT touch layer state. Used by `layers.M.load` as a pre-flight check BEFORE unloading the current root scene. Without this, a malformed target (v5, missing canonical, corrupt manifest) would tear down the current scene before discovering the new one can't be loaded, leaving the layer half-loaded. @return { ok = true, canonicalPath = string } OR { ok = false, error = string }

argtypedescription
ref?

spawnEntities(entities: ?, sceneGuid: ?, deferred: ?, playRole: ?, isV7: ?) → void

Each v7 entity record carries an explicit `synced` boolean — the key the entity exposes at runtime via `entity(id).synced` / `entity.spawnSynced` — that decides whether its state replicates: • `synced = true` → relay-authoritative. The room creator (and a peer whose role isn't yet confirmed) spawns it synced; a confirmed joiner receives it from the relay snapshot. • `synced = false` → local. Spawns on every peer, straight from scene.json; a change to it stays on the peer that made it. `playRole` is "creator" | "joiner" | "local" ("local" = edit / offline / additive: every entity spawns locally).

argtypedescription
entities?
sceneGuid?
deferred?
playRole?
isV7?

handBack( ) → boolean

Before each record: while gameplay is paused and this frame's slice is spent, hand the frame back and go on with the next record on the next frame, so a scene whose records cost many frames loads across them. The pause is what makes that safe: physics, component updates and gameplay tasks stand still across the frames in between, so nothing simulates a scene that is half applied (a body falling through a floor whose record comes later). With gameplay running, the load applies every record in the frame it reaches them. A deferred load spreads its work through the queue instead, and a load called from code that cannot yield, or from a component's hook or task, applies every record in the frame it was called in. While the load is suspended, it reads as partly applied (`M.partlyApplied`), the layer spawns are attributed to is the one that was active before it, and its records window is off the stack, so code that runs in the frames between is attributed and windowed as it would be with no load running; all three are back in place before the next record.

spawnRecord(i: ?, ent: ?) → void

Pass 1 for one record: spawn the shell carrying its name, replication, lifecycle axis, scope, render layers, attributes and transform, and register the keys pass 2 resolves parents against.

argtypedescription
i?
ent?

dropRecord(i: ?, id: ?, ent: ?, reason: string, why: string) → void

Drop the record at index `i`, which spawned `id`: the entity goes with the record, the load counts it among the ones it could not complete, and the log and `scene.whyPartial` each name it. An entity kept standing detached is one no record accounts for: the next save writes it at the scene root, and the load after that puts that root copy back beside the nested one the record set still asks for, once more on every load. The index goes out of `idByIndex` with it, so the id list this returns names the entities the load left standing. The caller drains on that list by polling every id until the world holds it, and an id that was despawned here is one the poll spends its whole ceiling on before the load can report itself finished.

argtypedescription
i?
id?
ent?
reasonstring
whystring

recordsUnder(ent: ?, parentId: ?) → void

The records the set puts beneath the record `ent`, which spawned `parentId`. A candidate is a record stating one of `ent`'s two spellings as its `parent`; it belongs to this subtree when that reference resolves to `parentId`, which is the resolution pass 2 itself performs — so a display name two records share reaches only the one it resolves to.

argtypedescription
ent?
parentId?

abandonRecord(i: ?, id: ?, ent: ?, reason: string, why: string) → void

Abandon the record at index `i` and every record the set puts beneath it. A record below one this load did not produce describes an entity under something that is not there, which is the same thing the record above it describes, so it goes the same way and is counted and named the same way. Reading it off the record set rather than off the live tree is what makes the account the load gives independent of the order the records appear in the file: a descendant already parented when its ancestor is abandoned is taken out by the despawn either way, and only the record set says it was there to be taken.

argtypedescription
i?
id?
ent?
reasonstring
whystring

placementAbove(ent: ?) → any

argtypedescription
ent?

takenDuringLoad(i: ?, id: ?, ent: ?, applied: boolean) → void

The record at index `i` spawned `id`, and a component this load applied despawned it: before this record's own components were applied, or after them when `applied` is true. A `SceneModule` placement does that as its build runs from its `awake`: an entity its module no longer places is taken away, and the next save takes the record out of the file. The index goes out of `idByIndex`, so the id list this load returns names only entities still standing.

argtypedescription
i?
id?
ent?
appliedboolean

parentRecord(i: ?, ent: ?) → void

Pass 2 for one record: parent it against the ids pass 1 registered.

argtypedescription
i?
ent?

applyComponents(i: ?, ent: ?) → void

Pass 3 for one record: apply its components. Every record is parented by now, so a component's `awake` finds the whole hierarchy the scene file states beneath its entity, whichever order the records appear in. A `SceneModule` placement reads the entities its build placed off its own descendants, and finding them is what lets it land on them rather than place a second set beside them.

argtypedescription
i?
ent?

instanceKeyOf(comp: ?, kind: string) → string

The component instance an entry names: its kind, and the instance name a named instance carries beside it, so the anonymous instance of a kind and each named one are told apart everywhere below.

argtypedescription
comp?
kindstring

applyRecords( ) → void

pump( ) → void

The records land with a window open for the work components ask to run after them (`M.afterRecordsApplied`), and that work runs once the last record has landed.

prototypesAreCloneSources( ) → void

Whether the live materialisation keeps authored PlayerPrototype subtrees out of the scene. In play each authored prototype is the clone SOURCE a joining player is instantiated from — captured as a template (player_prototype_spawn.captureTemplatesFromEntities) and left out of the spawn set — so the authored prototype is held by the template registry. In edit it materialises as the live authored original the author edits. The single definition of the condition: the loader's own spawn-set filter and anything that resolves a spawn's `prototype` read it to know which of the two holds the authored prototype. @return boolean

withoutPlayModePrototypeSubtrees(entities: ?) → void

The spawn set with each PlayerPrototype root AND its descendants removed while the materialisation keeps them out; otherwise the set is returned unchanged. Spawning the prototypes live as well would place a copy of a player body in the scene for every prototype. The runtime profile boots straight to play, so this is the path that keeps a shipped world's scene free of prototype bodies.

argtypedescription
entities?

isPrototypeRecord(ent: ?) → void

argtypedescription
ent?

markSubtree(key: ?) → void

argtypedescription
key?

asEntrypoint(fn: ?) → void

(Lighting handling lives on the SceneProxy's `settings.lighting` reactive block now. scene_loader's job for lighting collapses to copying `body.lighting` into `settings.lighting` (`M.applySceneFields`); writing fields fires the schema's per-field onWrite hooks, which call the `__lighting.*` primitives. Entity-shaped lighting (directional, ambient, point lights) lives in scene.json's `entities[]` array as regular entities with `Light` components and goes through the standard spawnEntities path — no special-case code here.) Top-level lifecycle functions in a scene entrypoint: function onLoad() — fires on scene load WHEN mode == "play". Gameplay start hook (Step 3k.1). function onEditLoad() — fires on scene load WHEN mode == "edit". Custom per-scene editor / authoring tools. function onUnload() — fires on scene unload, ALWAYS. Extra cleanup hook; engine-managed teardown runs separately. function update(dt) — per-frame in play mode, while the gameplay clock runs. function editorUpdate(dt) — per-frame while the authoring surface holds the cursor: edit mode, and play while paused. `M.tickChannel` is the rule, and it is the one a component hook of the same name follows too. function localPlayerReady(player) — fires once the local player entity is spawned + ready. Canonical place to position the local player at a spawn point, attach the camera, customize per-entity refs. Re-fires after spawner swaps (e.g. on edit→play when the local visual changes). Non-additive root scenes only. function playerJoined(player) — fires when a REMOTE player joins this scene's room. Use for per-player UI nameplates, greetings, etc. Does NOT fire for the local player (use localPlayerReady). Non-additive root scenes only. function playerLeft(eid) — fires when a remote player leaves this scene's room. Receives the entity ID string (the entity is already despawned by the time this fires). Non-additive root scenes only. The loader: 1. Compiles the entrypoint body. 2. Runs it inside a fresh env table so each scene's top-level definitions land on the env (NOT _G) — different scenes can declare the same identifier without clobbering each other. 3. Inspects the env for known lifecycle keys and folds each found function into the matching CANONICAL event dispatch (the same one any other subscriber uses via the public API). The author-facing surface is just `function onXxx()` — the loader handles routing. Adding a new lifecycle event later = add an entry to the discovery map below AND fire the matching canonical dispatch from where the event happens. ZERO Rust changes needed. Mirror of `world_context.rs::ensure_world_entrypoint_loaded`'s onModeChange folding into ENGINE_MODE_WATCHERS — the world entrypoint already proves this pattern works for `onModeChange`. Persist create-flow origin span. A scene entrypoint's POST-load hooks (`update` / `editorUpdate` / the player-events) are dispatched from THIS user-space loader, NOT the Rust frame dispatcher — and they run after the `__scene_load` window has closed, so `__persist_origin.current()` would see "execute" and persist's freeze gate would SAVE the entities they (re)spawn on every load, duplicating them on the next load. Wrapping each callback in an "entrypoint" span makes the gate exclude them (code reproduces them on load). Fully optional + behaviour-preserving: a no-op passthrough when persist isn't loaded; `__persist_origin.with` pcall-brackets so the span always balances and the original error still propagates to the existing pcall handlers. (The on(Edit)Load load-window is already covered by the `__scene_load` gate.)

argtypedescription
fn?

tickChannel(mode: string?, paused: boolean?) → string

Which per-frame hook a scene entrypoint's tick belongs to for the given engine mode and pause flag. An entrypoint that declares that hook fires it this frame; one that does not sits the frame out. `update(dt)` is gameplay: it takes the frame while the gameplay clock runs. `editorUpdate(dt)` is the authoring surface — viewport selection, the transform gizmo, the editor camera — so it takes every frame where the authoring surface holds the cursor: edit mode, and play while paused. That is the rule the engine's own component dispatcher applies to a component's hooks of these names, so an entrypoint and a component answer the pause the same way. @return "update" | "editorUpdate"

argtypedescription
modestring?
pausedboolean?

entrypointCode(source: string?) → string

The code an entrypoint source holds: the source itself, or nil when it holds none (absent, empty, or whitespace and comments alone). Two sources this answers nil for run the same way, which is none at all.

argtypedescription
sourcestring?

entrypointRan(sceneGuid: string) → string

The entrypoint code the most recent load of the layer for `sceneGuid` ran, as `M.entrypointCode` states it: nil when that load ran none.

argtypedescription
sceneGuidstring

runEntrypoint(sceneJsonPath: ?, sceneProxy: ?, isHost: ?, syncSpawned: ?) → void

`isHost` / `syncSpawned` come from `resolvePlaySpawnRole` (the SAME play-mode role decision that gates scene.json instantiation). `isHost` is true on the relay room creator, offline, single-player, and when the role is not yet known (degrade-to-spawn) — false ONLY for a confirmed joiner. `syncSpawned` is true only when host content should actually broadcast (play + connected creator). They drive the `onHostLoad` hook below.

argtypedescription
sceneJsonPath?
sceneProxy?
isHost?
syncSpawned?

runOwned( ) → void

The body and everything it registers run as one task owned by this load of the layer (`sceneProxy._taskOwner`): the loops it starts, and the tasks its lifecycle hooks and callbacks start whenever they fire, carry the load's owner tag, and `layers.fireUnload` cancels them all.

runSceneBuild(canonicalPath: string, sceneProxy: any, trigger: string) → SceneBuildReport

A scene that declares its content in `build.luau` runs that code when it loads in EDIT, so the scene shows what the code says now — including an edit made while it was closed. The build finds the entities it already placed by the build and record each one names, so a load whose code is unchanged lands on exactly the entities `scene.json` just restored and changes nothing. Not saved when it only put back what `scene.json` already holds — that is an unsaved edit for the author to keep or discard like any other. A build that had to CREATE its entities saves itself, because the saved scene did not hold them: a scene whose content is stated only in `build.luau` is what a new one is, and leaving that unsaved gives an author a scene that is right in front of them and empty the moment they press play. A library scene (one under `/libs/`, the `@builtin` library included) saves in neither case. Its load reads it: the build lands in the live scene, and its files stay as the library states them until an author bakes it with `:build()`. A reload (trigger "reload") is the author asking for the build by name, and it saves what it built the way a write to `build.luau` does, so the next play loads it. The build reads that off the trigger; a library scene's reload lands in the live scene alone.

argtypedescription
canonicalPathstring
sceneProxyany
triggerstring

say(report: SceneBuildReport) → SceneBuildReport

Every way out of here answers the same shape, and the answer is recorded on the layer as well as returned: `layers.load` hands its caller the proxy, so a caller that asked for the build reads what it did off the thing it already holds.

argtypedescription
reportSceneBuildReport

ensureModeChangeHandler(lifecycle: ?) → void

Register the edit↔play handler exactly once per VM. `engine.onModeChange` fires `(newMode, oldMode)`; enterPlay deactivates prototypes on the flip to play, enterEdit reactivates them (and despawns runtime clones) on the flip back to edit.

argtypedescription
lifecycle?

wirePrototypeLifecycle( ) → void

Apply the play/edit invariant to what the freshly-spawned scene brought in, and register the mode-change handler once. Runs for every load, additive overlays included: the editor UI layer is an additive load carrying the EditorOnly editor camera, and a load that lands after the flip to play (a boot still loading its world when play is entered, or an engine that boots straight into play) would otherwise leave that camera holding the viewport.

ensureFallbackSky( ) → void

resolvePlayRole(sceneGuid: ?, additive: ?) → void

Resolve this client's role for a root scene load. `spawnEntities` applies the returned role per entity against each record's `synced` flag: "local" — edit / offline / additive: every entity spawns locally. "creator" — play + connected, room creator (or role not yet confirmed): every entity spawns; synced entities spawn synced. "joiner" — play + connected, confirmed joiner: local entities spawn; synced entities arrive from the relay snapshot. Local entities spawn on every peer regardless of role; only synced entities depend on it. The room key is `{worldGuid}/{profile}/{branch}/play/{sceneGuid}` — identical to scene_swap_orchestrator's `roomKeyFor`, which `joinRoom`s it in `onBeforeLoad` just before this load. The creator role arrives from the relay shortly after that join, so poll briefly for it — but only yield when the caller is on a coroutine that can (the play-mode load runs on the world entrypoint's `onWorldLoad` coroutine).

argtypedescription
sceneGuid?
additive?

readRole( ) → void

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

Whether two decoded JSON values state the same thing, compared by content.

argtypedescription
aany
bany

copyBlock(src: any, dst: any, label: string, source: string, onlyDiffering: boolean) → number

Copy each field of `src` into the typed block `dst`, and return how many landed. The blocks are metatable-wrapped (validation + dirty-mark + onWrite on every write), and the `settings` wrapper refuses a bulk replace of a sub-block, so every key goes through the block's own `__newindex`. A field that fails validation (corrupt canonical, hand-edit typo, schema drift between scene.json and this engine build) logs a warning and is skipped; the rest of the block lands. With `onlyDiffering`, a field the block already holds as `src` states it is left as it stands.

argtypedescription
srcany
dstany
labelstring
sourcestring
onlyDifferingboolean

applySceneFields(sceneProxy: any, body: any, opts: any?) →

Take a loaded scene to the scene-level fields a `scene.json` body states. A v7 body carries `player` as the string intent `"spawns"` or `"none"` (a missing or empty one reads `"spawns"`), which lands as `sceneProxy.playerIntent`; a v6 body carries `player` and `camera` as setting blocks instead, which land under `sceneProxy.settings`. A root scene's `lighting` block lands under `sceneProxy.settings.lighting`; an additive one leaves the host scene's lighting alone. A load applies every field. A write to the file of a scene already loaded passes `opts.previous`, the body the file held before it, and a field lands only where the two bodies differ, so a write that edits one field leaves a live change to another standing until the file states it. A write also leaves alone a field the scene already holds as the body states it, so the scene's own save, which writes what the scene holds, lands nothing and reports nothing. whether the scene is an additive layer, the path a warning names, and the body the file held before this one. landed (`"player"`, `"camera"`, `"lighting"`), in that order.

argtypedescription
sceneProxyanyThe loaded scene's proxy.
bodyanyThe decoded `scene.json` body.
optsany?`{ additive: boolean?, source: string?, previous: table? }`:

examples

local Json = require("@builtin::modules.json")
Loader.applySceneFields(layers.active, Json.decode(assert(vfs.read(path))), { previous = before })

changed(key: string) → boolean

argtypedescription
keystring

load(ref: ?, opts: ?) → void

gameplay does NOT save the scene. @param ref AssetRef<scene> | identity string | absolute VFS path @param opts { layer?: string, additive?: boolean, persistent?: boolean, origin?: vec3, deferred?: boolean, rebuild?: boolean } `opts.rebuild = true` marks this load as a reload the author asked for, so the scene's `build.luau` runs against what it resolves right now instead of being answered from the digest the saved scene records. What the build did lands on the returned proxy as `lastBuild`, on every load either way. `opts.deferred` controls how the entity-spawn pump executes. Default `false` runs the pump directly — every entity + component is visible to the very next read after `M.load` returns (`localPlayerReady`, layer activation, scene entrypoint that immediately queries spawned ids) and pass-2's per-entity duplicate guard relies on this. Pass `deferred = true` for thousand-entity scenes where spreading the spawn cost across multiple frames is worth the cross-frame visibility window — children + components arrive in the ECS over the next few frames via the engine's queued mutation drainer. Callers that read entity state back during the same tick MUST leave `deferred` unset. @return sceneProxy table (with `settings` nested table attached: settings.player / settings.camera / settings.lighting) @return spawnedIds array of live entity-id strings spawned for this layer (authoritative drain key for callers)

argtypedescription
ref?
opts?

unload(sceneGuid: ?) → void

Unload a scene layer by guid. Symmetric to M.load. Despawns all entities in the layer. @param sceneGuid string Scene asset GUID (the layer's slot key)

argtypedescription
sceneGuid?
⌬ Types
SceneBuildReport = {
⌬ Metadata
descriptionLuau-side scene loader. Reads scene.json v6, refuses other versions with a typed error, dispatches to entity.spawn / component.add / lights.setup, auto-discovers the sibling entrypoint.luau, fires layers.onLoad callbacks. The canonical v6 layer-load entry point — wrapped by the public layers.load(ref) API.

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.

78+items
·
assettype · born here
❒asset
# Module (asset type) A module is a reusable, stateless (or globally-stateful) Luau library that other code pulls in with `require()`. Modules are the unit of factored-out logic in a world: helpers, math libraries, format parsers, registries, shared algorithms. ## When to use one - You have logic you want to share across multiple components, services, scenes, or tools. - You have a registry, lookup table, or shared cache that callers all read from / write to. - You want a stable API surface (`M.fn`) other code can depend on. If the logic is bound to one entity, use a `.component`. If you want a named UI of fields rather than functions, use a `.preset`. ## Where it lives - Source: `/zero/source/.../<name>.module/` - Identity: the source path with `/` written as `.` and each segment's type suffix dropped — `/zero/source/demo/beats.module` is `demo.beats`, and `/zero/source/kit.package/beats.module` is `kit.beats`, the container's name kept and its `.package` suffix gone. `asset.create` returns this string, `asset.resolve(...).identity` reads it back, and the `require` forms below write it as `<identity>`. - Folder shape: - `init.luau` (or `init.lua`) — module body. **Required.** Returns a table (conventionally named `M`). - `README.md` — instance-level documentation. **Required.** - `.metadata` — agent-editable tags + free-form fields. **Required.** ## How to create one ```luau asset.create("module", "<name>") -- Creates: /zero/source/<name>.module/ -- init.luau (canonical `local M = {} … return M`) -- README.md (instance README template) -- `folder` places it in a subfolder of /source, and that subfolder -- leads the identity: `{ folder = "lib" }` produces `lib.<name>`. -- `into` authors it inside a resolved container (a package, a toolbox), -- whose own identity leads the same way: asset.create("module", "<name>", { folder = "lib" }) asset.create("module", "<name>", { into = asset.resolve("myPkg.package") }) ``` ## How it operates 1. **Registration.** Writing `init.luau` into a `.module/` folder indexes the asset and registers the module path with the resolver. 2. **Loading.** The first `require("<identity>")` runs the file's body and caches the returned table. Subsequent requires from anywhere return the **same table** — this is the shared-state lever for "module-local" registries. The body runs in an environment of the module's own: a name it declares without `local` is readable by the module's own functions and by no other script, so an export reaches its callers through the returned table and nothing else. Requiring a component's folder runs its chunk the same way, once, and its `update`, `start` and `public` stay in that environment; a component runs on an entity through `entity(id).component.add(name)`. 3. **Hot reload.** Editing the file re-runs the module body and folds what it returns into the table already loaded, so that table keeps its identity: a caller that captured it with `require` reads the new source's functions and values through the reference it already holds, and a later `require` returns that same table. A key the new source drops goes away; a key something set at runtime stays. The body's own `local`s start again from their initial values, so state that must outlive an edit lives in `modules.state()` (`guides { path: "core/scripting-and-tasks" }`). 4. **Identity resolution.** A module is reached by its `<identity>`, and where the caller lives decides which spelling of it resolves. For a module in a **world**, from a caller in that same world — another module, a component, a scene entrypoint, or an `execute` chunk: - `require("<identity>")` — the identity on its own, resolved against the caller's own root. It carries every folder segment, so a module created with `{ folder = "demo" }` is `require("demo.beats")`. - `require("@root::<identity>")` — the same root-relative resolution, written out. - `require(".sibling")` — a module in the same folder, by its bare name; `..name` steps up one folder, `...name` two. Logs, stack traces and hot-reload notices name that same module `@local.source.<identity>` — its key under the world source root. The `<identity>` tail of that key is the form above, so a trace reading `@local.source.demo.beats` is `require("demo.beats")`. For a module in a **library** — content under `/zero/source/libs/@<lib>/` — `@<lib>::` addresses that library's root from anywhere: `require("@builtin::modules.transform")`. Mounting a world as a library moves its files under such a root and flips the caller root to `@<lib>::`, which is what keeps the root-relative forms above resolving across the move. ## Discovery - `asset.list("module")` — every registered module. - `asset.inspect("<name>")` — public functions, source path, this type README. - `ls /zero/source/<name>.module` lists the files the folder holds. ## Authoring conventions - Return a single `M` table from `init.luau`. Top-level statements with side effects run on first require — useful for one-time initialization, dangerous if they touch the engine before it's ready. - Write exported functions as `typed function`, not `function`: the argument types are enforced at the call and the checker knows the signature, so a caller's mistake is reported where they made it. - Annotate exported functions with `--!desc` / `--!arg` / `--!return` / `--!example` so the LSP, `tools.list`, and `asset.inspect` surface them. A function with no `--!desc` is reachable only by someone already reading this file. - Declare a VALUE with `Field.<kind>(default, mode, description)`, and a table whose members are reached through a metatable with `--!members <TypeName>` — the latter gives the surface its accepted member set, its type, and its documentation from one table. See `guides { path: "core/authoring" }` for all four rules and `modules/api/engine/entity.module/members.module` for a worked member table. - Keep module state in module-local upvalues or in `modules.state()`. A name the body declares without `local` lives in the module's environment, which every run of the module shares: a function the previous run left in place reads what the reload assigned. Module-locals start again from their initial values with each hot reload; the table `modules.state()` returns is the same table on both sides of every reload. - Prefer focused modules over kitchen-sink modules. If two halves of a module have no shared state, split them. ## Common pitfalls - **Cyclic requires.** A `require` chain that loops will return the partial table (the half built before the cycle was detected). Design for one-way dependencies. - **Engine-time side effects.** Don't `entity.spawn` at module top-level — the engine may not be ready. Expose an `M.init` and call it from a scene entrypoint. - **Hot-reload + module-local cache.** A module that caches expensive computation in upvalues loses that cache on reload — fine for dev, but be aware in performance work. - **`init.lua` vs `init.luau`.** Either works, `.luau` is canonical. - **Writing one while play runs.** A `/source` write made while play is running lands on the play shadow, and a guarded play-exit discards it unless it is kept. One `.module` write shadows `init.luau`, the `README.md` and the `.metadata` together. `vfs.write(path, bytes, { durable = true })` skips the shadow, and `vfs.promotePlayShadow` keeps what is already on it — the `core/vfs` guide has the model and what each route costs. ## Related types - `.component` — for entity-bound state + lifecycle hooks. - `.service` — generates content you don't have yet (a mesh, sound, texture, …) via a metered provider. - `.tool` — for a single agent-callable function with a YAML schema. - `.package` — to group several modules + components + scenes into one shippable folder. ## In the Inspector Exports: what the module exports (name, kind, signature), parsed from its source without running it, with **Check** (the LSP's diagnostics for its entry file) and **Open**.
▲ 0↑ born
▣
module · born here
❒asset
# 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
# 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
# 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
# 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
# `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
# 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
▣
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
·
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
# 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 | Module | Responsibility | |---|---| | `loader.module` | Reads scene.json v6 and v7, refuses versions it does not know, composes canonical + dirty overlay, spawns the entities, and runs the entrypoint. | | `saver.module` | Persists scene state as a delta overlay against the canonical file, promotes that overlay on save, and answers which edits are still pending. | | `build.module` | Runs a `build.luau` inside an entity capture scope and composes what it spawned into scene records. | | `observe.module` | The read side — the per-scene counts and costs `layers` and `loader` write. | | `swapOrchestrator.module` | Drives multiplayer room transitions and the scene-swap gate, so a local swap does not leak despawns to peers in the old room. | ## Reaching it ```luau 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.
▲ 0↑ born
▣
module · born here
❒asset
# ecs Public, typed, discoverable API for native ECS components. Generic verbs (`insert`, `get`, `set`, `has`, `remove`, `query`, ...) operate on any component, while per-component typed constructors (`ecs.Mesh`, `ecs.Material`, `ecs.Transform`, ...) build the Rust-shaped value the verbs apply. Each constructor is minted at module load from a spec under `ecs.components.<Name>`. ## Typed constructors `ecs.<Name>{...}` builds a component value: it runs the compiled conversion plan (asset-handle resolution, camelCase → snake_case field mapping, `vec3` expansion) and raises on an unknown field. The result is a value the upsert verbs accept. ```luau local ecs = require("modules.api.engine.ecs") local value = ecs.Transform{ position = { x = 0, y = 1, z = 0 } } ecs.insertSync(id, value) ``` The constructor also takes every shape the component is read back as, so a read hands straight to the constructor it came from: - the `ecs.get` handle — `ecs.Light(ecs.get(id, ecs.Light))`, - the engine-side field table `handle:read()` and `ecs.snapshot(id).<Name>` give back, - a value the constructor already built (copied, so the two are separately writable), - a table keyed by public field names, engine-side field names, or both. That makes changing one field a read, an assignment and a write back: ```luau local h = ecs.get(id, ecs.Light) h.intensity = 0 ecs.set(id, ecs.Light(h)) -- every other field keeps what it held ``` Each of those shapes names the component it holds, so handing one to another component's constructor says which component it is and which constructor takes it. The `ecs.get` handle writes its own fields as well — `h.intensity = 0` is already the whole write — so reach for the round trip when you want the component's value in hand. ## Verbs Every verb accepts an entity proxy (what `entity.spawn` returns) or a raw id string. - `ecs.insert(id, value) -> promise` — async upsert; await for same-tick visibility. - `ecs.insertSync(id, value)` — upsert visible this tick; raises on failure. - `ecs.insertMany(ids, value) -> number` — insert one value into many entities in a single crossing; returns the count applied. The three insert verbs warn per field a component could not hold the value it was given, naming the component, the entity, the field under its engine-side name and the value; the component holds that field's default and every other field lands. - `ecs.get(id, ecs.<Name>) -> handle?` — retained handle over a present component (`nil` when absent). See `handle`. - `ecs.set(id, value) -> ok, rejected` — patch fields of an already-present component; raises if the component is absent. `ok` is false and `rejected` lists the public field names that did not land when a field cannot hold the value it was given (a string outside an enum field's set, a shape the field's type does not read). Each name appears once and is warned once, with the component, the entity and every value that name refused — under the name you wrote it as, where the insert verbs name the engine-side one. Every field is attempted, so one refusal leaves the rest applied. - `ecs.has(id, ecs.<Name>) -> boolean` - `ecs.len(id, ecs.<Name>, field) -> number?` — element count of a collection-valued field (list/array/map/set), counted without building any element; `nil` when the component is absent or the field is not a collection. Reading the field to measure it converts everything in it — `#h.bones` on a 50-bone `Skeleton` costs ~1ms against one crossing here — so ask this whenever the question is how many, or whether any. - `ecs.remove(id, ecs.<Name>)` - `ecs.components(id) -> {string}?` — public component names present on the entity. - `ecs.snapshot(id) -> table?` — every native component on the entity, nested and keyed by public name, each holding that component's fields under the names the component itself uses. A catalogued component's field table names the component it came from, so it goes straight to that constructor. - `ecs.queryIds(...) -> {string}` — ids holding ALL the given `ecs.<Name>` types. - `ecs.query(...) -> {proxy}` — like `queryIds` but returns entity proxies. - `ecs.bind(id, component, field, mode?)` — retained component-field accessor by rust component name. - `ecs.bindEntities(ids)`. ## Discovery The engine is driven at runtime, so the catalog is introspectable in-engine: - `ecs.types() -> {string}` — public component names available as `ecs.<Name>`. - `ecs.describe() -> { schema, ... }` — the full catalog: every component with its fields. `ecs.describe(name | ecs.<Name>)` returns the schema for one component. - `ecs.<Name>:schema() -> { component, rust, fields = { {name, type, rust}, ... }, methods?, accepts }` — runtime field discovery for a single component; `accepts` lists the calls the name is accepted by, the round trip among them; behavior-bearing components also list their handle `methods`. ```luau for _, schema in ecs.describe() do print(schema.component, #schema.fields) end ``` ## Saved native components A saved record (a scene entity, a bundle `entity_template` entry) lists its native components in an `ecs` array beside `components`: `ecs = { { type = "Mesh", data = { mesh = "<mesh asset guid>" } }, { type = "Material", data = { id = "<material asset guid>" } } }`. `type` is the name under `ecs` and `data` the row `ecs.snapshot` answers, with every handle-typed field written as the guid of the asset the handle came from. The scene loader and `bundle:instantiate` resolve each guid to the handle the component holds (`ecs.handles`, see its README) and insert one value into every entity that states the same entry.
▲ 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
▣
module · born here
❒asset
# environment Module Environment / reflection capture — bake the scene into reflection-probe cube slots from world positions, persist them as `faces6` `.texture` assets, set per-probe blend data so surfaces reflect the probes covering them, and capture the sky into its own slot as the fallback under them. Public Luau surface over the `__environment` Internal FFI namespace, auto-injected as `_G.environment` via the prelude. ## Purpose The generic "render the scene into a cubemap from a point" capability the reflection-probe system is built on. Captures are queued for the render system (which owns the live scene); `captureSlotToAsset` additionally yields a few frames while the GPU readback completes. Persisted cubes are `faces6` `.texture` assets (px/nx/py/ny/pz/nz PNGs + a `cube.yaml` sidecar — see `docs/specs/cubemap-textures.md` §4 for the face convention). For probe authoring use the higher-level `reflectionProbe` module; reach for `environment` when you need the raw per-slot primitives. ## Usage ```luau -- Register probe blend data: index i maps to cube slot i. environment.setProbes({ { x = 0, y = 2, z = 0, radius = 12 } }) -- Bake slot 0 from a point (queued, next frame). environment.captureSlot(0, 0, 2, 0) -- Bake + persist to /source/probe_lobby.texture/ (yields; call from a -- task/coroutine/execute context). local path, err = environment.captureSlotToAsset("probe_lobby", 0, 0, 2, 0) -- Restore a persisted cube into a slot WITHOUT re-rendering. environment.loadSlotFromAsset("probe_lobby", 0) -- Capture the sky alone into the fallback slot: a surface no probe covers -- reflects the sky rather than black. environment.captureSky() ``` ## Exports - `environment.setProbes(probes) -> boolean` — set active probes' blend data; array of `{ x, y, z, radius, priority? }`, index i → cube slot i, gathered highest `priority` first - `environment.captureSky(x?, y?, z?) -> boolean` — render the sky alone into the fallback slot and arm it (queued) - `environment.setSkyFallback(active) -> boolean` — arm/disarm the fallback against the sky already captured (arming is refused while the slot holds none) - `environment.captureSlot(slot, x, y, z) -> boolean` — bake the scene into a slot from a point (queued) - `environment.captureSlotToAsset(name, slot, x, y, z, timeoutFrames?) -> (string?, string?)` — bake + persist as a `faces6` `.texture`; yields - `environment.loadSlotFromAsset(name, slot) -> (boolean, string?)` — upload a persisted cube into a slot without re-rendering Back-compat single-global-reflection helpers (slot 0 + one full-coverage probe): - `environment.capture(x, y, z) -> boolean` - `environment.captureToAsset(name, x, y, z) -> (string?, string?)` - `environment.loadFromAsset(name) -> (boolean, string?)`
▲ 0↑ born
▣
module · born here
❒asset
# assetType runtime The machinery that reads a `<typename>.assetType/behavior.luau` and turns its declarations into live behaviour. A `behavior.luau` is a table of declarations — `ref` methods, `modules` shared code, an `events` schema, a `namePattern`, `refShapes`, and the `onCreate` / `onRegister` / `onChange` / `onDelete` / `validate` / `settingsDefaults` / `settingsCorrections` hooks. None of it runs itself. This is the code that runs it, and it lives here because reading a type's declarations is the **assetType type's own behaviour** — the same way `material.assetType` owns what a `.material` does. ## Sub-modules | Module | Reads | Responsibility | |---|---|---| | `ref.module` | `ref`, `modules` | Builds every `AssetRef` envelope, attaches the shared metatable, and dispatches per-type methods and shared modules onto it. Also owns edit-mode write-behind persistence. | | `create.module` | `onCreate`, `namePattern`, `validate` | Backs `asset.create`: resolves the type, checks the name against its pattern, runs `onCreate` (or clones `template/`), and writes the instance. `validate.module` beside it checks a creation `opts` table against the type's `createSchema`. Before running `onCreate`, resolves the type's settings chain (below) and hands the result to the hook as `opts.settings`. | | `settings.module` | `settings`, `settingsDefaults`, `settingsCorrections` | A type's declared settings schema and where its values live (`type.yaml`'s `settings:` block). `Settings.resolveForCreate` layers the schema's own defaults, the type's own `settingsDefaults(name, opts, asked)` hook (a DEFAULT the schema can't express — a name-derived convention, a fact read off a payload the caller handed it, a value following a field `asked` shows a higher layer naming; any later layer overrides it), the Preset Manager, an importer's settings, the caller's `settings` table, then the type's own `settingsCorrections(values, name, opts)` hook (a CROSS-FIELD CONSTRAINT the schema can't express, applied last over the fully merged values). A correction over a default/preset/importer value lands silently; a correction that would override what the caller's own `settings` table explicitly asked for refuses the creation instead, naming the field and why. Neither hook is ever handed a table to mutate; each returns what it wants changed (`settingsCorrections` may also return a `{ [field]: reason }` table for that refusal message). `Settings.cloneValues` deep-copies a values table — `create.module` hands `onCreate` a copy, never the table it stamps. `Settings.valuesOf` / `writeValues` read and write an asset's own values file. | | `typeYaml.module` | `type.yaml` | The folder a type lives in and its parsed `type.yaml`, decoded once per content version of the file. `settings.module` and `inspector.module` read their blocks through it. `about` / `aboutAt` read a type's `about.yaml` (`intent`, `function`, `usage`), leaving out any key that is empty or still starts with `[[describe]]`; `aboutRows` and `aboutMarkdown` lay the texts out for the Inspector and the `types/<name>` guide. | | `inspector.module` | `type.yaml`'s `inspector:` block | Which inspector a type declares for its assets (`inspector: { type: ... }` or `{ instance: ... }`), and the declaration that file returns — the sections it adds, the generic ones it replaces, and their order — or the problem that kept it from loading. | | `onRegister.module` | `onRegister` | Fires an instance's once-only registration hook — on arrival, on world load, and for `@builtin` library instances. | | `changeDispatch.module` | `onChange`, `onDelete`, `refShapes` | Routes a VFS source write or a folder delete to the enclosing typed asset's type hooks. | | `refShapes.module` | `refShapes`, `ref` | Publishes what every `AssetRef<category>` answers to, so a member read on an asset-typed value is checked against that category's real surface. | | `events.module` | `events` | The per-asset event runtime behind `ref.events`. | | `instantiable.module` | `ref.instantiate` | The instantiation contract an asset type opts into: `root` stands the root entity, `place` applies the base placement opts to one the type adopted, and `result` shapes the `(root, idMap)` every `instantiate` returns. Also registers the `sceneInstantiable` field-constraint validator. | | `declaration.module` | `type.yaml` | The type's decoded declaration, read once and held until a write inside an `.assetType` folder; what every question about a type as a whole reads. | | `previewRecipe.module` | `type.yaml` `preview:` | How an instance's `preview.png` is produced: which of the four recipes (`instantiate`, `image`, `surface`, `custom`) the type declares, and what that recipe needs. | ## Reaching it ```luau local rt = require("@builtin::assetTypes.assetType.shared") rt.ref.loadTypeBehavior("material") ``` Fields resolve lazily. The prelude requires the sub-modules directly, in dependency order (`ref`, then `changeDispatch`, `onRegister.install()`, `refShapes.install()`) — a table that required all six on load would take that ordering away from it.
▲ 0↑ born
▣
module · born here
❒asset
# preset A preset holds typed values for one declarer's settings schema: an assetType's, an importer's, a component's, or any asset that declares its own settings. `preset.capture` saves the settings something has now, `preset.apply` writes a preset's values into something its target governs, `preset.values` reads them checked against the target's current schema, and `preset.setValues` replaces them, checked first. Exposed as the `preset` global via `--!global preset`. A preset's `preset.yaml` names its target as a guid envelope, `target: { __ref: <guid>, type: <type>, name: <name> }`, which the preset's `.refs` pins by guid with the target's checksum. A target written as an identity string is accepted on read, resolves by identity, reads as unpinned, and is rewritten as the envelope on the preset's next local edit. ## Exports - `preset.values(source: AssetRef<preset>) -> ({ [string]: any }, Report)` — the values that pass the target's current schema, and a report naming every one that does not. - `preset.apply(source: AssetRef<preset>, into: AssetRef | ComponentTarget) -> ApplyResult` — write the valid values into an asset the target governs, or into a component on an entity whose component is the target. Struct groups merge field by field. Raises when another declarer governs `into`. - `preset.capture(from: AssetRef | ComponentTarget, name: string, opts?: CaptureOpts) -> AssetRef<preset>` — save an asset's settings, or a component's live values on an entity, as a new preset targeting the declarer that governs them. A bare name lands in `/source/presets/`; an absolute `.preset` path lands where it says. - `preset.setValues(source: AssetRef<preset>, values: { [string]: any })` — replace the whole values table; any violation refuses the write, naming every one. - `preset.defaults() -> { DefaultRow }` — the world's Preset Manager rows, in order, each resolved with its problems. - `preset.setDefaults(rows: { DefaultRowInput })` — replace every row; every row is checked first and any problem refuses the write, naming every one. - `preset.addDefault(source: AssetRef<preset>, opts?: { filter: string?, at: number? }) -> number` — add a row for the declarer the preset targets; returns its index. - `preset.removeDefault(index: number)` — remove one row, keeping every other row as written. - `preset.defaultFor(declarer: AssetRef | string, path: string) -> ({ [string]: any }?, Match?)` — the values a new thing at `path` would take from the rows, and the row that gives them. Types: - `ComponentTarget = { entity: string, component: string }` — a component on an entity. - `Report = { format: string, target: string, targetGuid: string?, pinned: boolean, targetChanged: boolean, rejected: { Violation } }` — `target` is the target's identity; `pinned` is true when `.refs` pins the target's guid; `targetChanged` is true while the pinned checksum differs from the target's current one. - `Violation = { path: string, message: string }` - `ApplyResult = { applied: { string }, rejected: { Violation }, targetChanged: boolean }` - `CaptureOpts = { overwrite: boolean? }` — `overwrite = true` re-authors an existing preset, keeping its guid. - `DefaultRowInput = { preset: any, target: any?, filter: string? }` — a preset, its declarer (the preset's own target when omitted) and a filter (empty matches everything). - `DefaultRow = { index, target, preset, filter, targetGuid, presetGuid, targetName, presetName, problems }` - `Match = { index, target, preset, path, rejected, problem? }` — the row a creation took and the path it read. ## Usage ```luau -- Capture a texture's settings, then apply them to another texture local p = preset.capture("hero_sprite", "pixel_art") preset.apply(p, "enemy_sprite") -- Apply a component preset to a component on an entity preset.apply("synty", { entity = id, component = "Locomotion" }) -- Capture a component's live values local tint = preset.capture({ entity = id, component = "Model" }, "red_tint") -- Read the values and what the target rejects local values, report = preset.values("pixel_art") for _, v in ipairs(report.rejected) do print(v.path, v.message) end -- Replace the values preset.setValues("pixel_art", { filter = "nearest", generateMipmaps = false }) ``` ## Notes - Every read re-checks the values against the target's current schema, so a value a later schema drops or retypes is reported by path rather than applied. - `asset.create("preset", name, { target = <identity or guid>, values = { ... } })` authors a preset directly, with the same checks as `preset.capture`. - The Preset Manager rows are documented in `preset.defaults`; the filter grammar in `preset.glob`. - Submodules: `preset.document` (the `preset.yaml` format), `preset.target` (target resolution and checking), `preset.heal` (rewriting an older preset document in the current form on a local edit).
▲ 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
# 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
backing path · assetTypes/scene.assetType/shared.module/loader.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.