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

shared

A module script.

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

shared

A module script.

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 ImporterShared The importer SYSTEM — shared by every `.importer/` instance. Owns dispatch, origin-gating, content-gating, the `asset.containing` bundle skip, re-entrancy, output marking, and bundle relocation. The engine emits one generic "a source path was written" signal per write (`onLooseWrite`); this module decides whether any registered importer should claim it and runs the winner. Individual importers implement ONLY `canImport(path, bytes)` + `import(ctx)` — never trigger logic. require @builtin::assetTypes.importer.shared

now( ) → number

record_job(path: string, origin: string?, state: string, fields: { [string]: any }?) → ImportJob

argtypedescription
pathstring
originstring?
statestring
fields{ [string]: any }?

finish_job(job: ImportJob, state: string, fields: { [string]: any }?) → void

argtypedescription
jobImportJob
statestring
fields{ [string]: any }?

stem_of(path: string) → string

argtypedescription
pathstring

asset_name_of(path: string) → string

A valid asset name (`^[A-Za-z][A-Za-z0-9_]*$`) derived from a file stem. Uploaded and OS-authored files carry arbitrary names — spaces, punctuation, non-ASCII (e.g. a screenshot `Näyttökuva 2026-06-08 224404.png`) — that `asset.create` rejects. Collapse every run of non-`[A-Za-z0-9_]` bytes to a single `_`, trim edge underscores, and prefix a letter when the result would start with a digit or be empty, so the derived asset always has a legal name.

argtypedescription
pathstring

dir_of(path: string) → string

argtypedescription
pathstring

ext_of(path: string) → string

argtypedescription
pathstring

own_container_of(path: string) → string

The enclosing container's VFS path when `path` lives inside its own same-named output container, nil otherwise. This is both the gate predicate (non-nil → the write-triggered dispatch skips) and the output root for an explicit in-place re-import (`runImporters` regenerates the container this returns). The names compare as asset names, the form an importer names the container it makes from a source.

argtypedescription
pathstring

already_in_own_bundle(path: string) → boolean

argtypedescription
pathstring

current_checksum(path: string) → string

Content gate. An importer should run only when the source is genuinely new or its bytes changed since the last import. The engine stamps every written file with a `.meta` checksum (`asset.meta(path).checksum`). We record the checksum we last imported in the produced asset's agent `.metadata` (`source_checksum`); a re-write with an unchanged checksum is a no-op. A brand-new source (no prior asset / no recorded checksum) always imports.

argtypedescription
pathstring

recorded_checksum(asset_path: string) → string

argtypedescription
asset_pathstring

record_checksum(asset_path: string, checksum: string?) → void

argtypedescription
asset_pathstring
checksumstring?

own_settings(importer_ref: any) → void

The importer's own resolved values (`asset.settings` over the schema its `settings.luau` declares), or an empty table for an importer that takes none.

argtypedescription
importer_refany

importer_settings(importer_ref: any, row_path: string) → void

An importer's settings for a source whose Preset Manager rows read `row_path`: its own values with the world's first matching row for that importer laid over them. A row lookup that fails leaves the importer's own values, so what the import runs with and fingerprints stays whole.

argtypedescription
importer_refany
row_pathstring

row_path_for(path: string, container: string?) → string

The path a Preset Manager row reads for an import into `container`: the source's path when it was first imported, which the container's import stamp records. A re-import reads the source from inside its container, where a `models/*.glb` row would no longer match it. A container stamped before stamps recorded that path reads the source's name beside the container: an import relocates its source from the container's own folder, so this is the first import's path whenever the source sat beside the container it made. A first import reads `path`.

argtypedescription
pathstring
containerstring?

import_fingerprint(checksum: string?, claimants: { { ref: any, mod: any } }, row_path: string) → string

What an import of `path` would be made from: the source's own checksum, joined with a digest of every claimant's settings, in claim order, when any claimant holds a setting. An importer's settings decide what it stamps onto what it creates, so a settings change re-imports an unchanged source the same way a changed source does. While every claimant's settings are empty the fingerprint is the checksum alone — the value recorded for every import made before importers had settings. Nil when the source carries no checksum.

argtypedescription
checksumstring?
claimants{ { ref: any, mod: any } }
row_pathstring

each_importer(fn: (any) → void

Importers are `.importer/` assets; the engine's AssetIndex already lists them. No Rust-side importer registry exists.

argtypedescription
fn(any

load_importer(ref: any) → any

An importer instance's module table ({ canImport, import }), loaded through the one resolution every asset-folder module goes through (`AssetRef.requireTypeModule`): by the importer's identity, then by its folder path, each guarded by `library.has` so a missing module is never required. Nil when the importer's entry module is missing or fails to load; an entry module that exists and fails to load is logged, naming the importer and the error, once per content version of it.

argtypedescription
refany

extensionsOf(ref: any) →

The file extensions `ref`'s importer declares it claims (`M.extensions` in its init.luau), lower-case without the dot; nil when it declares none.

argtypedescription
refanyThe importer asset.

examples

local exts = ImporterShared.extensionsOf(asset.resolve("@builtin::importers.texture"))

registry_key(refs: { any }) → string

What the loaded set is a snapshot OF: every registered importer's identity paired with the version counter of the files its body is read from.

argtypedescription
refs{ any }

loaded_importers( ) → void

produced_types( ) → void

Every asset type a registered importer declares it makes (`M.produces`).

declared_output(path: string, mod: any) → string

The asset an import of `path` by the importer `mod` makes when no container holds the source yet: `<dir>/<asset name>.<produces>`, beside the source. Nil for an importer that declares no `produces`.

argtypedescription
pathstring
modany

retain_source(path: string, dest: string, opts: { quiet: boolean? }?) → string

An import keeps the source it was made from inside the asset it makes. The first import moves the written file there. A re-import of a source written again beside that asset finds the retained copy already standing at `dest`: the new bytes replace it in place, so the retained file keeps the guid the asset's provenance names, and the written file is removed, leaving the asset as the one home of its source. Raises with the reason when the source cannot be retained, so an import that leaves its source loose is a failed import. `opts.quiet` keeps the destination's write side effects off.

argtypedescription
pathstring
deststring
opts{ quiet: boolean? }?

relocate_into_bundle(path: string) → void

Move the source file INTO its own bundle so the link is never lost: /source/foo.glb → /source/foo.bundle/foo.glb Returns the new in-bundle path. The importer derives mesh/material/etc. alongside it. `asset.containing(newPath)` will then resolve to `foo.bundle`, so subsequent writes are correctly skipped. A source that ALREADY lives inside its own container re-imports in place: the enclosing container is the output root and nothing moves, so the importer regenerates its derived assets next to the retained source.

argtypedescription
pathstring

collect_claimants(path: string, bytes: string, container: string?) → void

Collect every importer whose cheap `canImport` predicate claims `path`'s bytes, in registration order. A single extension can be claimed by more than one importer (e.g. `.glb` by both the model importer and the animation-only importer); they're tried in sequence and the FIRST to actually do the work (return a non-nil result) wins. Each importer's `import` returns nil to defer to the next — that's how a mesh-bearing glb falls through to the model importer while a mesh-free one falls through to the animation importer. `container` names the asset a re-import regenerates when the source is the one it retains. An importer that declares it makes a different type (`M.produces`) takes no part in regenerating it. One that declares it makes that asset's type is asked about the source as the file it was before the import moved it in, `<container's folder>/<leaf>`, since that is the file it claims; a `canImport` that refuses a container's interior keeps refusing every other file there.

argtypedescription
pathstring
bytesstring
containerstring?

retained_source(produced: string, imported_path: string, reported: string?) → string

Every successful import stamps the produced asset's `.metadata` with a single `import` key: which importer ran (by guid — stable across name/identity changes), the retained source (pinned by the source file's guid so a later rename/move never breaks the link), a monotonic iteration (1, then +1 per reimport), and the time. Generic here in the type, so every importer gets it. The retained source path for a produced asset: the file the importer reports keeping (its result's `source`) when that file stands, else `<produced>/<leaf>`, where output-container importers relocate the source under its own name, when that exists, else the imported path when it still stands (non-relocating importers). Nil when the import kept no copy of its source (the model importer with `keepSource = false`).

argtypedescription
producedstring
imported_pathstring
reportedstring?

file_guid(path: string) → string

argtypedescription
pathstring

import_stamp(path: string) → void

The `import` stamp `path` carries now, nil when it carries none.

argtypedescription
pathstring

takes_source_away(path: string, output_root: string) → boolean

Whether an import into `output_root` takes `path` from where it stands: a fresh import relocates its source into the asset it produces, while a re-import regenerates the asset around a source already inside it.

argtypedescription
pathstring
output_rootstring

session_refuses(path: string, output_root: string) → boolean

Whether the lost live session refuses the writes an import of `path` into `output_root` makes. The session refuses every write to authored source, and takes the writes to content this machine keeps to itself (`vfs.isSaveExcluded`: `/source/tmp/`, `/source/local/`), so an import of such a source into such an asset runs while the session is lost.

argtypedescription
pathstring
output_rootstring

relocate(p: string) → void

argtypedescription
pstring

relocate_tracked(p: string) → void

argtypedescription
pstring

retainSource(dest: string, opts: { quiet: boolean? }?) → void

Keep the source inside the asset as `dest`: a first import moves it there, a re-import of a source written again replaces the retained copy with it, and a source already inside the container being regenerated stays where it is. Returns where the source is now; raises when it cannot be kept there.

argtypedescription
deststring
opts{ quiet: boolean? }?

prior_output_of(path: string, claimants: { { ref: any, mod: any } }) → string

The asset an earlier import of `path` made: the container the source sits in, else the first claimant's declared output (`<dir>/<stem>.<produces>`) that carries an import, else the `.bundle` beside the source.

argtypedescription
pathstring
claimants{ { ref: any, mod: any } }

content_gate(path: string, claimants: { { ref: any, mod: any } }) → ContentGate

Whether an import of `path` would be made from exactly what made the asset already standing for it: the source's checksum and every claimant's settings.

argtypedescription
pathstring
claimants{ { ref: any, mod: any } }

retained_of(prior: string) → string

The file inside `prior` that holds the bytes it was imported from, by the guid its provenance pins, else the path it recorded.

argtypedescription
priorstring

fold_into_retained(path: string, prior: string) → string

A source written again with the bytes `prior` already retains: the written copy is removed, since the asset holds the same bytes. Returns the retained file. A written copy whose bytes differ from the retained file stays, and so does one written beside an asset that retains no source, which returns nil.

argtypedescription
pathstring
priorstring

in_flight( ) → number

How many imports are actually in flight. Settled records are dropped as they are seen, and a record still reading in-flight past the stall bound is settled here as failed: the queue is what it holds up, so it is what says so.

owed_count( ) → number

owed_for(reason: string) → boolean

Whether any import is owed for `reason`.

argtypedescription
reasonstring

still_held(path: string, entry: OwedImport) → boolean

Whether what holds `entry` back still holds it.

argtypedescription
pathstring
entryOwedImport

let_go_by(reason: string) → string

What let an owed import of `reason` go, for the log lines that name it.

argtypedescription
reasonstring

stop_watching_for_lock_lift( ) → void

settle_watchers( ) → void

Take the play-lock watchers down once no import play owes is left.

run_owed(path: string, entry: OwedImport) → void

Run one owed import that what held it has let go of, settling its job. The drain marks the job running before this reads anything, so the import is counted in flight from the moment it leaves the owed set.

argtypedescription
pathstring
entryOwedImport

run_owed_imports( ) → void

Run every owed import that what held it no longer holds, one at a time under the import concurrency cap. An import still held (the flip that fired was into play, a pause was lifted, or the session dropped again) stays owed.

watch_for_lock_lift( ) → void

Stand the watchers that run the imports play owes when the lock lifts: the play lock lifts when play ends (a mode flip) or when it pauses.

lifted( ) → void

watch_for_session_return( ) → void

Stand the task that waits for the live session to re-establish and then runs the imports the lost session owes. It ends once none is owed.

supersede_owed(path: string, running_job: ImportJob?) → void

argtypedescription
pathstring
running_jobImportJob?

process_queued(job: ImportJob) → void

Process one queued job to a terminal state: read the bytes (retrying under write-burst contention), probe claimants, apply the containment + content gates, and run the winning importer — transitioning `job` in place (queued -> running -> imported/failed/unclaimed/skipped), never a second record. Clears the per-path dispatch guard when it settles.

argtypedescription
jobImportJob

pump( ) → void

Drain the queue in per-frame slices, one long-lived task. Runs each import in its own child task so the concurrency cap is honoured while every import still awaits its own parse, and starts new jobs only while this frame's slice is unspent. Exits when the queue drains AND no import is in flight; the next enqueue restarts it.

onLooseWrite(path: string, origin: string?) → void

Engine-driven: a source path with no enclosing typed-asset folder was written. Gate on origin + re-entrancy, then ENQUEUE it on the bounded import queue (default concurrency 1) — the pump reads the bytes, decides whether a registered importer claims it, applies the content + containment gates, and runs the winner, one import at a time. peer-synced write. Only "local" writes trigger — peers receive the originator's derived bundle as ordinary synced content.

argtypedescription
pathstringThe written VFS path.
originstring?"local" for a write made on this client, "remote" for a

is_recorded_source(source: { [string]: any }, path: string) → boolean

Whether `path` is the file `source` (an `import` record's `source`) names: the recorded path, or the file that carries the recorded guid after a rename or a move.

argtypedescription
source{ [string]: any }
pathstring

onAssetWrite(assetPath: string, path: string, origin: string?) → string

Engine-driven (through the asset-type change dispatcher): a file inside a typed asset was written. When that asset's `import` record names the file as the source the asset was imported from, the importers run again on it, regenerating the asset in place. The record is the whole link: it follows the source through a rename (by guid), and nothing else is watched. A write of the same bytes under the same importer settings is skipped, and a write made on a peer is left to that peer.

argtypedescription
assetPathstringThe typed asset the written file is inside.
pathstringThe written file.
originstring?"local" for a write made on this client, "remote" for a peer's.

runImporter(importer: any, path: string) → string

Run ONE importer on `path` now and return the produced asset path, or nil when that importer does not claim the file. `runImporters` hands a source to the first claimant that takes it; this names the importer, for a source two importers both claim or an importer being tried out. The import runs exactly as a dispatched one does — synchronously, in the calling task, with the importer's own settings as `ctx.settings` — and is recorded as a job.

argtypedescription
importeranyThe importer: an AssetRef<importer>, or its name or identity.
pathstringThe raw source VFS path to import.

examples

local out = Importers.runImporter("texture", "/zero/source/hero.png")

jobs(filter: { state: string?, path: string?, limit: number? }?) →

Recent import jobs, newest first. Pass a filter to narrow: `state` keeps one state, `path` substring-matches the source path, `limit` caps the count (default 25).

argtypedescription
filter{ state: string?, path: string?, limit: number? }?Optional `{ state?: string, path?: string, limit?: number }`.

jobsVersion( ) → number

A number that moves each time an import job is recorded or its state changes: fold it into a signature to rebuild what lists the jobs.

examples

parts[#parts + 1] = tostring(ImporterShared.jobsVersion())

job(path: string) → ImportJob

The latest import job recorded for an exact source path, or nil when no dispatch has reached a claimant for it.

argtypedescription
pathstringThe source VFS path.

stats( ) →

Live queue counters: `queued` (sources waiting on the pump — the authoritative backlog depth), `running` (imports in flight), `owed` (imports held back until play ends, because the running play session holds their source where it stands, or until the lost live session re-establishes), and `states` (every recorded job tallied by state). `queued`, `running` and `owed` are exact; `states` tallies the job registry, which keeps every in-flight job plus the most recent settled records.

queue( ) →

The live import backlog: queued sources (still waiting behind the concurrency cap, in FIFO order), then the ones importing right now, then the owed ones, held until play ends or the live session re-establishes (sorted by path). The focused "what is the importer doing this instant" view, distinct from `jobs` (the full recent-dispatch log including terminal states).

cancelQueued(path: string) → boolean

Cancel a source before it imports: a QUEUED one is dropped from the pump's queue, an OWED one (waiting for play to end or for the live session to re-establish) is dropped from the owed set, and its job settles as "cancelled". A source already importing is mid-parse and can't be unwound cleanly, so it is left to finish: queued or owed.

argtypedescription
pathstringThe queued or owed source VFS path.

cancelAllQueued( ) → number

Cancel EVERY queued source that hasn't started importing yet, and every owed import, held until play ends or until the live session re-establishes (in-flight imports are left to finish). Use it to abandon a large accidental drop.

awaitJob(path: string, timeoutSecs: number?) → ImportJob

Wait until the latest job for `path` settles: a terminal state (imported / failed / unclaimed / skipped / cancelled), or "owed", which holds until play ends or the live session re-establishes (`reason` says which) and so is returned at once rather than waited out. The in-flight "queued" and "running" are waited through, until the timeout elapses. Returns the job (nil when no job exists for the path at all).

argtypedescription
pathstringThe source VFS path.
timeoutSecsnumber?Max seconds to wait (default 30).

explain(path: string) →

Dry-run the dispatch gates for a path WITHOUT importing: does the file exist, which importers claim it, and which gate (if any) would stop an import right now. The answer to "I wrote this file and nothing happened". "would-import", "blocked", or "owed" (the import waits: `reason` "session-lost" while the live session is lost, until it re-establishes; "play-lock" while the running play session holds the source where it stands, until play ends); when blocked, `reason` names the blocking gate ("missing" | "unreadable" | "no-claimant" | "already-in-own-bundle" | "unchanged-content").

argtypedescription
pathstringThe source VFS path.

bytes_now_at(job: ImportJob, path: string) → string

The file the written bytes are in now, after `job` settled for `path`: the written path while it still holds them, else the retained source inside the asset the import made (or, for an unchanged source, the asset that already held them), else nil when the import kept no copy.

argtypedescription
jobImportJob
pathstring

settled_outcome(job: ImportJob, path: string) → WriteOutcome

argtypedescription
jobImportJob
pathstring

unsettled_outcome(job: ImportJob?, claimant: string?, path: string) → WriteOutcome

The answer when the wait ran out before the dispatch settled. `job` is the dispatch answering for the write when one started; nil when none did, which a write that fired no side effects (a quiet write) never sets off.

argtypedescription
jobImportJob?
claimantstring?
pathstring

owed_outcome(job: ImportJob, path: string) → WriteOutcome

The answer for a write whose import is held back (an "owed" job): no import has finished, the bytes stay where they were written, and the import runs when what holds it lets go: play ending or pausing (reason "play-lock"), or the lost live session re-establishing (reason "session-lost"). The importer named is the first claimant of the bytes as they stand, the one the owed import offers them to first.

argtypedescription
jobImportJob
pathstring

writeOutcome(path: string, sinceFrame: number?, timeoutSecs: number?) → WriteOutcome

Where the bytes a write put at `path` end up. A write outside every typed asset folder is offered to the importers, and one that claims the bytes may move them into the asset it makes. This waits, up to `timeoutSecs`, for the dispatch that write set off to settle, and answers with its outcome: nil when no importer claims the bytes (they stay at `path`), else the import's state, the importer, the asset it made (`output`), the file the bytes are in now (`source`, nil when the import kept no copy) and a `note` stating all of it in a sentence. An import still running when the wait runs out answers `queued` or `running`; an import held back answers `owed` at once, the bytes staying at `path` until it runs: `reason` "play-lock" when the running play session holds them, until play ends or pauses, and "session-lost" while the live session is lost, until it re-establishes; bytes an importer claims that no dispatch reached (a quiet write fires none) answer `not-started`, the bytes staying at `path`. a settled job recorded for `path` before it answers for an earlier write.

argtypedescription
pathstringThe written VFS path, as the engine spells it (`/zero/source/...`).
sinceFramenumber?The engine frame (`time.frameCount()`) read before the write:
timeoutSecsnumber?Max seconds to wait for the import to settle (default 10).

examples

local outcome = ImporterShared.writeOutcome("/zero/source/art/hero.png", time.frameCount() - 1)

writeOutcomes(paths: { string }, sinceFrame: number?, timeoutSecs: number?) →

`writeOutcome` for several paths written together, such as the files of one folder transfer, asked once every one of them has landed. One wait bounds them all: each path is answered as `writeOutcome` answers it, with whatever share of `timeoutSecs` is left when its turn comes, so a path whose import is still running when the wait runs out answers `queued` or `running`. the writes. no importer claims is absent.

argtypedescription
paths{ string }The written VFS paths, as the engine spells them (`/zero/source/...`).
sinceFramenumber?The engine frame (`time.frameCount()`) read before the first of
timeoutSecsnumber?Max seconds to wait for all of the imports to settle (default 10).

examples

local outcomes = ImporterShared.writeOutcomes({ "/zero/source/art/a.png", "/zero/source/art/b.png" }, since)

listImporters( ) → void

Every registered importer: `{ name, identity }` per `.importer` asset.

scan_container_for_source(container: string) → string

Find a source inside a produced container: the first file an importer claims, passing over the container's preview.

argtypedescription
containerstring

resolveImportSource(assetPath: string) → string

Resolve the source file a produced asset was imported from. Prefers the provenance source guid (survives rename/move), falls back to the recorded path, then to scanning the container for an importer-claimed file.

argtypedescription
assetPathstringThe produced asset's path (e.g. a `.bundle`).

reimportAsset(assetPath: string) → string

Reimport a produced asset in place: resolve its source and re-run the importers on it (the containment gate regenerates the container's derived assets from the retained source). Returns the produced path, or nil when no source could be resolved.

argtypedescription
assetPathstringThe produced asset's path.

importedAssets( ) → void

Every asset in the world carrying import provenance, newest `at` first. Each row: `{ asset (path), importer (guid), source ({guid,path}), iteration, at }`. Backed by the asset.list presence filter — one cross-type query.

is_directory(path: string) → boolean

Directory test via the parent listing (a VFS path carries no isDirectory).

argtypedescription
pathstring

has_import(path: string) → boolean

argtypedescription
pathstring

classify_target(t: string) → string

Classify one target: "asset" (has provenance) | "folder" | "source" | "missing".

argtypedescription
tstring

scan_folder(dir: string, recursive: boolean, mode: string, plan: { any }) → void

Walk a folder into a plan of { path, action }. mode filters what is collected: "new" = loose sources only, "existing" = imported assets only, "all" = both.

argtypedescription
dirstring
recursiveboolean
modestring
plan{ any }

runTargets(target: any, opts: { recursive: boolean?, mode: string? }?) →

Import/reimport one target, an array of targets, or a folder. A produced asset (with provenance) reimports in place; a loose source imports; a folder is scanned (recursive by default) and its imported assets reimported + loose sources imported, filtered by `opts.mode` ("all" | "new" | "existing"). A target that produced nothing is `failed` (with `error`) when its importer threw, else `skipped` with a `reason`: "missing", "no-source" (a produced asset whose source is gone), "no-claimant" or "unclaimed".

argtypedescription
targetanyA VFS path string or an array of path strings.
opts{ recursive: boolean?, mode: string? }?`{ recursive?: boolean (default true), mode?: "all"|"new"|"existing" }`.

settle(r: { [string]: any }, source: string, firstJob: number) → void

A target that produced nothing: failed when its importer threw, else skipped with the reason no import ran ("unclaimed" when every claimant deferred, "no-claimant" when no importer claims the source).

argtypedescription
r{ [string]: any }
sourcestring
firstJobnumber
⌬ Types
ImportJob = {WriteOutcome = {

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.

47+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
# yaml.module YAML decode + encode for authored engine content. Pure Luau, no engine dependencies — a general parsing library, not data-system plumbing. ```luau local Yaml = require("@builtin::modules.yaml") local doc = Yaml.decode(vfs.read(path)) vfs.write(path, Yaml.encode(doc)) ``` ## Supported subset - Block mappings (`key: value`) and block sequences (`- item`), nested to any depth. - Compact sequence-of-mapping entries (`- path: x` / ` kind: y`). - Flow collections — `{ a: 1, b: 2 }` and `[1, 2, 3]` — single line. - Plain scalars with type inference: `~` / `null` → nil, `true` / `false` → boolean, numeric literals → number, everything else → string. - Single- and double-quoted strings (`''` escapes a literal quote inside a single-quoted string; `\n` `\t` `\r` `\\` `\"` inside a double-quoted one). A quote opens a quoted scalar where a scalar begins — after `key:`, after a `- ` entry marker, or inside a flow collection — so a plain scalar carries an apostrophe as data (`note: the world's rules`). Quoted keys are read in flow mappings. - `#` comments — honored outside quotes, so a `#` inside a quoted string is kept as data. - Literal (`|`) and folded (`>`) block scalars, with a chomping indicator (`-` strips the final newline, `+` keeps every trailing blank line, none keeps one newline) and an indentation indicator (`1`-`9`: the content's indent past the parent's), in either order (`|-`, `>+`, `|2`, `>1-`). A block scalar's content is literal text: quotes (balanced or not), `#`, `key: value` and `---` inside it are data. - An optional leading `---` document marker. ## Loud-error contract Constructs outside the subset above raise instead of misparsing: anchors/aliases (`&`, `*`), tags (`!`), directives (`%`), multi-document streams (a second `---`), a block-scalar header it cannot read (`|x`, `|-+`, `|0`), tab indentation, and inconsistent indentation (both block structure and block-scalar bodies). Every error carries the offending line number (`yaml: line N: ...`), so a bad config points straight at the line to fix. Tab indentation is rejected everywhere — including block-scalar body lines whose leading whitespace contains a tab. A tab after the first non-space character of a line is content and passes through. ## API - `Yaml.decode(text: string): any` — decode a YAML document into a Luau value (table, scalar, or nil for an empty document). Raises on malformed input or an unsupported construct. - `Yaml.decodeWithComments(text: string): (any, boolean)` — decode as `decode` does, and report whether the text carries a comment by the decoder's own rule: a `#` at a line's start or after whitespace, outside a quoted scalar and outside a block scalar. Re-encoding the value drops such comments, so an editor that writes a document back reads this first. - `Yaml.encode(value: table): string` — encode a Luau table as YAML (block style, two-space indent, alphabetically sorted keys). Raises on values YAML can't represent (functions, userdata, non-string mapping keys). A top-level empty table encodes to an empty document, which decodes back to `nil` (the YAML empty-document ambiguity).
▲ 0↑ born
▣
module · born here
❒asset
# assetType.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
# content_version Per-path content-version counters — a cheap, synchronous "has this file changed?" token. An assetType behavior memoizes its parse in the ref's `runtime` keyed by the counter `get(path)` returned when it parsed, then serves every later read as an integer compare instead of re-reading and re-parsing the file. ## Why it exists A `.data()` behavior that re-reads and re-parses its source on every call is pure overhead when the file hasn't changed. This module gives it a version token to gate the rebuild on: - `get(path)` when the parse ran, stored alongside the parsed value. - On every later call, compare `get(path)` to the stored value — equal means the cache is still valid (no `vfs.read`, no parse); a bump means rebuild. ## Exports - `M.get(path: string) -> number` — the path's current version counter (`0` if never written this VM). - `M.bump(path: string)` — bump `path`'s counter, invalidating every reader memoized against its previous value. Content code rarely calls this directly. ## What bumps a counter Two write surfaces feed it, so the token reflects a change no matter where it originated: - `vfs.write` / `vfs.move` / `vfs.remove` bump **synchronously**, in the same call — so a script that writes a file and reads it back in the same tick sees the new content immediately (the asset-change `onChange` dispatch fires a frame later, too late for a same-tick read). - the generic asset-change dispatcher bumps on every source write it routes, including peer-synced and engine-originated writes that never pass through the Luau `vfs.*` surface — with the engine's normalized path, the canonical form a reader keys on. ## Per-path, not a global epoch Counters are per **path**, not one global epoch. The per-frame dirty-entity writer churns scene-dirty paths every frame during play; a global epoch would let that churn invalidate every unrelated cache. Per-path isolation means only a change to the file a reader depends on rebuilds it. The counters are held once for the process (`__contentVersion`), so a single store is shared across every VM and every copy of this module that a require-cache reset (`vfs.reload`) might create. A bumper and a reader that landed on different VMs or module copies read the same number: a write made in a worker VM, the engine thread's dispatch of it, and a write made on the engine thread advance one counter.
▲ 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
# 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
# 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/importer.assetType/shared.module

Problems

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

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

Usability ratings

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

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

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

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