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

settings

Resolves four questions about an asset's typed settings, all answered from its type's `type.yaml` — nothing here is found by convention.

by◐lumi·posted 1mo ago
What it does

assetType.shared.settings

Resolves four questions about an asset's typed settings, all answered from its type's type.yaml — nothing here is found by convention.

local Settings = require("@builtin::assetTypes.assetType.shared.settings")
-- or, from inside the assetType runtime:
local Settings = require("@builtin::assetTypes.assetType.shared").settings

Where does a type's schema live?

type.yaml names it in a settings: block:

settings:
  values: "settings.yaml"           # where an instance's own values live
  schema: { type: "settings.luau" } # one schema for every asset of this type

or, for a type whose settings differ per instance (an importer):

settings:
  values: "settings.yaml"
  schema: { instance: "settings.luau" }

or, for a type whose schema is a table its instance's own source declares and whose values live elsewhere (a component: its public fields, valued on each entity it is on):

settings:
  schema: { instance: "init.luau", export: "public" }

Whether an instance may lack its schema file is what the type's files: block says of that file. Listed under files.optional, it may be absent, and an instance without it declares no settings — the importer type lists it there, since most importers take none. Listed under files.required, or not listed at all, it must load, and an instance missing it is a broken declaration and is logged.

schema.type is required at the folder relative to the TYPE's own .assetType/ directory (one schema shared by every instance). schema.instance is required relative to each INSTANCE's own folder (init resolves the instance's own identity; anything else is a sibling module under it). Without schema.export, the file is required as a module and its return value IS the schema. With schema.export, the file is run in an environment of its own and export is read from a returned table carrying it, or else from the globals the file assigned — a component's public is such a global. That environment reads through to _G and takes every write itself; its own _G is itself, its declare and computed record into it, and its task records spawned, deferred and delayed work instead of starting it. Every other global is the real one, so a call the file makes through one runs as it does anywhere. The schema is the declared table's Field descriptors. A schema that resolves to nothing says why through Settings.schemaProblemOf(ref): the file could not be read, compiled or run, or declared no such table. An instance schema is read again when its file, its type's type.yaml, or the entry file of any module the asset requires changes. Settings.blockFor(typeName) returns the raw block; Settings.schemaForType(typeName) and Settings.schemaOfInstance(ref) resolve the two schema shapes respectively; Settings.schemaFor(ref) tries the type-level schema first, falling back to the instance-level one. ref naming an assetType asset itself — e.g. asset.resolve("texture", "assetType"), rather than an instance of it — reports that type's own declared schema, the same one every instance of it reports.

Where do an asset's values live?

settings.values names a file living beside the asset's own content — Settings.valuesPathOf(ref) joins it onto the asset's path. Settings.valuesOf(ref) / Settings.writeValues(ref, values) read and write it; this module only names where it is. A type that declares its schema with no settings.values keeps no values in the asset — a component's live on each entity it is on — so valuesOf answers nil for it, asset.create refuses a settings table for it, and asset.setSettings refuses a write.

Settings.recordedWrite(path, text) writes a file the way every values file is written, and an editor uses it for any other file it writes. It writes the whole contents, records the write into the open undo operation when one is open (so undoing it restores what the file held), and raises when the write does not land.

In what order are a schema's fields declared?

Every Field.* constructor stamps its descriptor with declaredOrder, one more than the last. Luau evaluates a table constructor's entries in the order they are written, so Settings.orderedNames(schema) lists a schema's fields — and a struct's subfields — in the order the source writes them.

A values file, or a legacy .metadata settings block, may hold an older spelling — a renamed field, an older enum member. Every read passes what is stored through the type's normalizeSettings (Settings.normalizeFor), so it answers in the fields the schema declares today, and writes nothing. The next local edit of that asset rewrites the file in the declared spelling (Settings.healLegacyIfNeeded).

asset.setSettings(ref, patch) writes a partial patch: Settings.resolvePatch(ref, patch) normalises it, merges it over the current values and applies the type's derived defaults for the fields it changed, and Settings.writeValues(ref, values, patch) applies the corrections, checks the schema and writes the file.

How is a new asset's settings resolved at creation?

asset.create calls Settings.resolveForCreate(typeName, name, destPath, creationOpts, callerSettings, importerSettings) before running the type's onCreate, checks the result against the schema, writes it to the values file, and hands onCreate a COPY of it as opts.settings (Settings. cloneValues) — never the same table the values file gets, so nothing onCreate does to its own copy can reach what was stamped. onCreate reads settings from opts.settings and never writes to it. asset.create also seeds the change baseline with the stamped values (Settings.seedChangeBaseline), so the values file's own first dispatch reports nothing changed and the payload onCreate encoded is the only encode a create runs.

The layers, lowest priority first, each overriding the ones before it field by field:

  1. The schema's own declared defaults (Settings.defaultsOf).
  2. The type's own settingsDefaults(name, opts, asked) hook, when its behavior.luau exports one. asked holds what layers 3 to 5 name, so a default can follow a field one of them sets.
  3. The Preset Manager's matching row (Settings.presetLayerFor).
  4. The creating importer's settings for this type.
  5. The settings table the caller passed to asset.create.
  6. The type's own settingsDerivedDefaults(values, explicit, changed) hook, when its behavior.luau exports one — a field whose default follows another field, set only when no layer from 2 to 5 named it.
  7. The type's own settingsCorrections(values, name, opts) hook, when its behavior.luau exports one — applied last, once every other layer has merged.

Layers 2 to 5 are each read through the type's normalizeSettings, so a layer naming a field in an older spelling sets the field it names today. asset.create's top-level settings alias accepts those older names too (Settings.acceptedFieldNames).

Layer 7 is Settings.applyCorrections(typeName, values, explicit, context), the one corrections path every settings write takes — this create chain, and Settings.writeValues for every later write (asset.setSettings, a type's first-encode seed, the legacy heal). explicit names the fields the writer asked for: the caller's settings table here, the patch for asset.setSettings. A correction lands SILENTLY on a field the writer did not name — nobody asked for that value, so overriding it just states a fact. A correction that contradicts a field the writer named REFUSES the write, naming the field, the value asked for, and why it cannot hold — the same as every other place this codebase refuses an explicit request it cannot satisfy (a Field.checkSchema violation, a BC7 alignment error) rather than silently rewriting it into something else. So asset.setSettings(tex, { compression = "rgba16" }) on a mipped texture stores generateMipmaps = false beside it, while asset.setSettings(tex, { compression = "rgba16", generateMipmaps = true }) is refused.

Field.checkSchema runs once, over the result AFTER the corrections hook has applied — a bad value nothing corrects refuses the creation.

Four hooks, four different jobs

Every hook is an optional export on a type's behavior.luau, alongside onCreate / onChange. None is ever handed a table to mutate — each reads what it's given and RETURNS a table of what it wants changed (or nil); resolveForCreate, resolvePatch, applyDerivedDefaults and applyCorrections are the only places that write to the values, by merging what a hook returns the same way every other layer merges.

  • normalizeSettings(values) -> values maps every older spelling a stored file or a write may carry to the field and member the schema declares now, returning a new table; a table naming both an older field and its replacement keeps the replacement. The companion export normalizedSettingNames = { ... } lists the older field names it accepts beyond the schema, so a write naming one is not refused as an undeclared field. texture.assetType's maps the fields its earlier schema stored to colorSpace + compression, and the older filter keywords to linear / nearest.

  • settingsDerivedDefaults(values, explicit, changed) -> partial? answers the values of fields whose default follows another field. At creation changed holds every field; on a write it holds the fields the write moved. A returned field applies only where explicit — the fields the writer named — does not name it.

  • settingsDefaults(name, opts, asked) -> partial? supplies a DEFAULT the schema itself has no syntax for — something only knowable at creation time, like a naming convention, a fact read off a payload the caller handed in, or a value that follows a field a higher layer sets (asked holds what the Preset Manager, the importer and the caller name, the higher one's value where two name a field). It runs early (layer 2 above), so any later layer — Preset Manager, importer, caller — freely overrides it. texture.assetType's returns the textureType the name suggests (a _normal-suffixed name is a normalMap), compression = "uastc" and maxDimension = 4096, with rgba8 for a textureType of sprite that a higher layer names; for a pre-encoded ZTEX payload it returns the colour space, compression and sampler the payload's own header carries. Either way, an explicit settings = { ... } from the caller still wins.

  • settingsCorrections(values, name, opts) -> (partial?, reasons?) enforces a CROSS-FIELD CONSTRAINT the schema itself has no syntax for — a fact about one field that depends on another field's resolved value, true regardless of which layer produced that value. It runs last (layer 7 above), over the fully merged values, and again on every later write of the values file. Nothing is left unmet in what gets validated and stamped — but a value the caller explicitly asked for is never silently rewritten to satisfy it; applyCorrections refuses instead (see above). The optional second return, { [field]: reason }, supplies the "why" for that refusal message; a field with no reason falls back to a generic one. texture.assetType's returns { generateMipmaps = false, maxDimension = 8192, colorSpace = "linear" } whenever the RESOLVED compression is high-precision (the encoder stores one verbatim, linear, and refuses a mip chain or a downsample for it outright), paired with a reason naming the compression, and nil otherwise.

What does a declarer declare?

Field.settingsOf(identity, mode) embeds another declarer's schema as a struct field without restating it. The identity names one of two kinds of declarer, and Settings.schemaOfDeclarer(identity) tells them apart by what identity resolves to:

  • An assetType (e.g. "@builtin::assetTypes.texture") — embeds the schema every instance of that type carries, resolved via schemaForType. This is the type-level shared schema from the section above, not a per-instance one — an assetType has no settings of its own to declare per instance.
  • Anything else (an importer, or any other asset that declares settings of its own) — embeds that asset's own schema, resolved via schemaOfInstance.

Every schema this module serves has already run its Field.settingsOf fields through this resolution — a caller reading schema.someField.fields never sees an unresolved declarer with no fields. Resolution descends into an already-literal struct's fields and a list's element the same way, so a declarer embedded several fields deep is still reached. A declarer that embeds itself, directly or through another declarer, stops one level short of the loop instead of recursing forever.

What are the defaults?

Settings.defaultsOf(schema) reads every field's declared default into a plain table — a field declared without one is absent from the result rather than holding a nil value.

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 AssetTypeSharedSettings Typed per-asset settings: which schema governs an asset, what its values are, and where both are declared. A type's `type.yaml` names its schema file and its values file; nothing here is found by convention.

blockFor(typeName: string) → any

The `settings:` block a type declares, or nil when it declares none.

argtypedescription
typeNamestringThe asset type's name, e.g. "texture".

examples

local block = Settings.blockFor("texture")

listedOptional(typeName: string, file: string) → boolean

Whether `typeName`'s type.yaml lists `file` under `files.optional` — an instance of the type may then lack it. Read from the parse `TypeYaml.of` holds.

argtypedescription
typeNamestring
filestring

schema_from_module(identity: string?, path: string?, stem: string, export: string?, typeName: string, file: string) → void

Require a type's declared schema module and return the table it declares. `export` names a key inside the module's return value; without one the return value IS the schema. Resolved through `AssetRef.requireTypeModule` — the same resolution `behavior.luau` goes through, reaching a builtin, world-authored, or library-vendored type's module alike by its identity and its folder path together. `typeName` and `file` name the problem: a schema file the type.yaml declares that fails to load, or resolves to something other than a table, is reported by name — the type, the file, and why — and that report is the second return value.

argtypedescription
identitystring?
pathstring?
stemstring
exportstring?
typeNamestring
filestring

inert_computed(fn: any) → string

What `computed(fn)` hands back inside a declaration read: a placeholder string standing where the engine's registered sentinel would stand. It is no Field descriptor, so the schema leaves it out.

argtypedescription
fnany

inert_task(held: { any }) → any

The `task` a declaration read sees: `task` itself for every read and wait, with each call that would start work — `spawn`, `defer`, `delay`, `delayRealtime`, `loop`, `spawnSystem`, `batched` — and `onError`, which installs a handler, recorded into `held` instead. A recorded call runs nothing and returns 0, the handle of no task; `cancel` and `collect` of such a handle do nothing.

argtypedescription
held{ any }

hold(name: string) → void

argtypedescription
namestring

onError(...: any) → void

argtypedescription
...any

cancel(_handle: any) → void

argtypedescription
_handleany

collect(_handle: any) → void

argtypedescription
_handleany

evaluate_declaration(filePath: string, export: string, typeName: string, file: string) → void

A schema declared by `export` is read by running the declaring file in an environment of its own and taking `export` from what it returns (when that is a table carrying it) or else from the globals the chunk assigned. A component's `public` is such a global. The environment is a table whose reads fall through to `_G` and which takes every write itself, the shape of the environment the engine gives each component instance. It holds five names of its own: * `_G` — the environment itself, so `_G.x = v` and `rawset(_G, k, v)` land in it; * `declare` — records its table into the environment (`__declared`); * `computed` — returns `inert_computed`'s placeholder; * `task` — `inert_task`, which records work instead of starting it; * `__heldTasks` — that record. Every other name is the real global. A call the chunk makes through one — a `require`, an engine API — runs as it does anywhere; a module a `require` loads runs once per VM and is shared with every other caller. The schema is the table's Field descriptors; a method, a computed placeholder or any other value beside them is not a setting.

argtypedescription
filePathstring
exportstring
typeNamestring
filestring

declare(meta: any) → void

argtypedescription
metaany

required_module_versions(ref: any) → void

The entry file of each module `ref`'s sources `require` that its reference table has bound, with each file's content version now, and whether some of the modules it requires are not yet known: the table cannot be read, or it still lists a `require` whose target it has not bound. A module asset is a folder whose entry is its `init.luau`; a module written as a single file is its own entry.

argtypedescription
refany

deps_unchanged(deps: { { path: string, version: number } }) → boolean

Whether every recorded module still holds the version it was read at.

argtypedescription
deps{ { path: string, version: number } }

pending_deps_bound(held: any, ref: any) → boolean

Whether an entry read while some required modules were unknown now knows a module it did not: derived again at most once per `PENDING_DEPS_RECHECK_S`, and the entry's pending flag cleared once nothing is unknown.

argtypedescription
heldany
refany

awaiting_keys(block: any, identity: string?, folder: string?, file: string) → void

The require keys a schema module that resolved under none of them waits on: every key `requireTypeModule` tries, when the block requires the file as a module and not one of those keys is registered. A module source is registered after the write or move that lands it, so a read in between finds none. Nil when the block evaluates the file, or a key is registered.

argtypedescription
blockany
identitystring?
folderstring?
filestring

registered_since(awaiting: { string }?) → boolean

Whether a module key an entry waited on is registered now.

argtypedescription
awaiting{ string }?

requiredModulesRecord(ref: any) →

What a read derived from `ref`'s code depends on beyond `ref`'s own files: the entry file of each module its sources `require` (as its reference table has bound them), with the content versions they have now, and whether some module it requires is not yet known. Hold it beside the value read, and ask `requiredModulesCurrent` before serving the value again.

argtypedescription
refanyThe asset.

examples

held.modules = Settings.requiredModulesRecord(ref)

requiredModulesCurrent(record: any, ref: any) → boolean

Whether a value read alongside `record` still stands: every module it listed holds the version it was listed at, and — when some required module was not yet known — none of those has become known since. That last question is asked again at most every quarter second, so a read held while a module was unknown is not read again on every call.

argtypedescription
recordanyWhat `requiredModulesRecord` answered.
refanyThe asset the record was taken for.

examples

if held and Settings.requiredModulesCurrent(held.modules, ref) then return held.value end

requiredModulesStamp(record: any, ref: any) → string

Text that moves when a module a record listed changes, or when a module it required before that module was known becomes known (asked at most every quarter second, as `requiredModulesCurrent` asks it): the content versions of its listed modules now, and whether the read beside it has gone stale. Fold it into a build signature to rebuild what was read from code that requires them.

argtypedescription
recordanyWhat `requiredModulesRecord` answered.
refanyThe asset the record was taken for.

examples

parts[#parts + 1] = Settings.requiredModulesStamp(held.modules, ref)

declared_schema(block: any, identity: string?, folder: string?, file: string, typeName: string) → void

The schema a `schema:` block declares in `file` inside `folder`: evaluated when the block names an `export`, required as a module otherwise.

argtypedescription
blockany
identitystring?
folderstring?
filestring
typeNamestring

resolveDesc(desc: any) → any

Fill in `fields` on an unresolved `Field.settingsOf` descriptor (`kind = "struct"`, `declarer` set, `fields` nil) by resolving its declarer's own schema, and descend into an already-literal struct's `fields` or a list's `element` to reach one nested deeper. Never mutates `desc` — a struct or list descriptor that needs its `fields`/`element` replaced is copied first, so the table a `require` cache holds is untouched.

argtypedescription
descany

resolveSchema(schema: any) → void

argtypedescription
schemaany

schemaForType(typeName: string) → any

The schema governing the settings of assets of `typeName`, when the type declares one at type level (`schema: { type = ... }`).

argtypedescription
typeNamestringThe asset type's name.

examples

local schema = Settings.schemaForType("texture")

schemaOfInstance(ref: any) → any

The schema an individual asset declares for itself, when its type says the schema is per instance (`schema: { instance = ... }`). Whether an instance may lack the file is what the type's `files:` block says of it: a schema file listed under `files.optional` may be absent, and an instance without one declares no settings; one listed under `files.required`, or not listed at all, must load, and a missing one is the instance's declaration broken, and is logged.

argtypedescription
refanyThe asset ref.

examples

local schema = Settings.schemaOfInstance(importerRef)

schemaProblemOf(ref: any) → string

Why `ref`'s settings schema resolved to nothing: the declaring file could not be read, compiled, run, or did not declare its table; or the type refused what it declared — the sentence its `behavior.luau`'s exported `settingsSchemaProblem(schema, ref)` returned. Nil when the schema resolved or `ref`'s type declares none.

argtypedescription
refanyThe asset ref.

examples

local why = Settings.schemaProblemOf(compRef)

schemaFor(ref: any) → any

The schema governing `ref`'s own settings values — the type-level schema when its type declares one, else the schema the asset declares for itself. `ref` naming an assetType asset itself (rather than an instance of one) reports that TYPE's own declared schema — the same schema every instance of it reports.

argtypedescription
refanyThe asset ref.

examples

local schema = Settings.schemaFor(texRef)

whyNoSettings(ref: any) → string

Why `ref` carries no settings, as a sentence naming where they would be declared: the type declares no settings block; or the type declares a schema per instance and this instance ships none, naming the file it would be; or the type's declared schema did not load.

argtypedescription
refanyThe asset ref, one for which `M.schemaFor` answered nil.

examples

error("asset.setSettings: " .. Settings.whyNoSettings(ref))

schemaOfDeclarer(identity: string) → any

The schema a declarer declares, named by its identity. This is what `Field.settingsOf(identity)` resolves to: an assetType's instance-settings schema, or an importer's / component's own declared schema.

argtypedescription
identitystringThe declarer's asset identity.

examples

local schema = Settings.schemaOfDeclarer("@builtin::assetTypes.texture")

defaultsOf(schema: any) →

Every declared default of `schema`, one value per field. A field declared without a default is absent rather than nil-valued.

argtypedescription
schemaanyThe Field schema table.

examples

local values = Settings.defaultsOf(schema)

assetPathOf(ref: any) → string

The folder `ref` names: its own `path`, or — for a ref that carries only its guid or identity, the `{ __ref, type, name }` envelope a saved asset field holds — the path that guid or identity resolves to. Nil when neither names an asset.

argtypedescription
refany

valuesPathOf(ref: any) → string

The path of `ref`'s settings values file, per its type's declared `settings.values`, or nil when its type declares no values file. A ref that carries its guid or identity without its path reaches the same file through what that name resolves to.

argtypedescription
refanyThe asset ref.

examples

local p = Settings.valuesPathOf(texRef)

type_behavior(typeName: string) → void

`typeName`'s own `behavior.luau`, if it ships one — the same registry-driven resolution `asset.create` uses to reach a type's `onCreate`.

argtypedescription
typeNamestring

normalizeHookOf(typeName: string) →

`typeName`'s own normalisation hook — its `behavior.luau`'s exported `normalizeSettings(values, stored?)`, when it ships one — or nil. The hook maps every older spelling a stored file or a write may carry (a renamed field, an older enum member) to the field and member the schema declares now, and returns a new table. `stored`, when given, is the asset's current values, which an older spelling in a patch may need to keep the meaning it had against them.

argtypedescription
typeNamestringThe asset type's name.

examples

local hook = Settings.normalizeHookOf("texture")

normalizeFor(typeName: string?, values: { [string]: any }, stored: { [string]: any }?) →

`values` in the spelling `typeName`'s schema declares: the type's `normalizeSettings` applied, or `values` itself when it ships none. Every settings source passes through here — a values file, a legacy `.metadata` block, a create's preset / importer / caller layers, a `asset.setSettings` patch — so an older spelling reads, creates and writes as the field it names today. The hook is handed copies; neither table passed here is modified.

argtypedescription
typeNamestring?The asset type's name (nil answers `values` unchanged).
values{ [string]: any }A settings table in any spelling the type accepts.
stored{ [string]: any }?The asset's current values, when `values` is a patch over them.

examples

local values = Settings.normalizeFor("texture", { format = "bc7" })

read_values_file_raw(path: string) → void

The values table a settings file holds, decoded exactly as stored. An asset with no values file answers nil without a read: a read of a path the library does not hold waits on a fetch for it, and every asset whose settings are all defaults (most builtin meshes and clips) has none, so a `:handle()` that asks for its settings would otherwise wait a frame for a file that is not there.

argtypedescription
pathstring

read_values_file(path: string, typeName: string?) → void

The values table a settings file holds, in the spelling `typeName`'s schema declares.

argtypedescription
pathstring
typeNamestring?

legacy_values(ref: any) → void

The legacy `.metadata` `settings` block, read in memory: what a type's `onCreate`/`onChange` hooks persist through `asset.set_field(ref, "settings", ...)` for content authored before the values file existed. `M.valuesOf` overlays it exactly as it overlays a values file.

argtypedescription
refany

stored_raw(ref: any) → void

The settings `ref` stores exactly as stored, before any older spelling is read as today's: its values file, or the legacy `.metadata` block for content that predates it.

argtypedescription
refany

settingsHealedHookOf(typeName: string) →

`typeName`'s own settings-heal hook — its `behavior.luau`'s exported `settingsHealed(values, stored)`, when it ships one — or nil. Healing moves an asset's settings out of older storage on a local edit; this hook answers the fields whose value that move changes, for content whose stored settings predate what the type's schema now decides. `values` is what a read of the stored settings reports, `stored` the settings exactly as stored (before an older spelling is read as today's). It returns the fields to change, or nil for none.

argtypedescription
typeNamestringThe asset type's name.

examples

local hook = Settings.settingsHealedHookOf("texture")

apply_heal(typeName: any, values: { [string]: any }, stored: { [string]: any }?, explicit: { [string]: any }?) → void

`values` with `typeName`'s heal applied for settings stored as `stored`: every field its `settingsHealed` hook changes that `explicit` does not name, so a field the writer names keeps what it names. Answers the values and whether any changed.

argtypedescription
typeNameany
values{ [string]: any }
stored{ [string]: any }?
explicit{ [string]: any }?

overlay_stored(schema: any, stored: { [string]: any }?, sourceLabel: string?) → void

The schema's defaults overlaid with `stored` (already in the declared spelling): a field the schema does not declare is dropped, and a value that fails its own field's constraint reads as the declared default with a warning naming `sourceLabel`, the field and the violation.

argtypedescription
schemaany
stored{ [string]: any }?
sourceLabelstring?

stored_values_of(ref: any) → void

The settings `ref` itself records — its values file, else the legacy `.metadata` block — or nil when it records none.

argtypedescription
refany

valuesOf(ref: any) →

This asset's settings values: every declared default, overlaid with what its values file holds — or, for content that predates the values file, with its legacy `.metadata` settings. A field neither sets reads as its declared default, so content written before a field existed still answers for it. A stored field the schema no longer declares is filtered out, so a schema revision that drops a field leaves old content reading as clean rather than carrying a value nothing recognises. A stored value that fails its own field's constraint is dropped the same way — the field falls back to its declared default and a warning names the path, the field and the violation — so a read never answers with a value the schema (and therefore the type's own encode) refused. The values are resolved in memory from what is already on disk. An asset whose type declares no values file holds no settings values of its own — a component's live on each entity it is on — and reads as nil, while its schema still answers through `schemaFor`.

argtypedescription
refanyThe asset ref.

examples

local s = Settings.valuesOf(texRef)

isForeignOrigin(ref: any) → boolean

True when `ref`'s origin is outside this world — installed from a library, or carried by the engine's library by reference, rather than authored here or shipped with the engine. Read through the same envelope `asset.inspect` reports, `origin.kind`: `"installed"` for either, and `"authored"` for a world-authored or builtin asset. An origin `asset.inspect` cannot answer (it raises, or reports a shape these reads don't recognise) resolves foreign: what this guards is that a foreign asset's legacy settings are never dropped or rewritten, so an undetermined origin takes the side that leaves the asset's content as it is.

argtypedescription
refanyThe asset ref.

examples

if not Settings.isForeignOrigin(ref) then Settings.healLegacyIfNeeded(ref, "local") end

contentsOf(path: string) → string

The whole text of `path`, or nil when no file is there.

argtypedescription
pathstring

recordedWrite(path: string, text: string, record: boolean) → void

Write `text` to `path`, raising when the write does not land. When `record` is set and an undo operation is open, the write is recorded into it, so undoing the operation restores what the file held before; the prior contents are read only then.

argtypedescription
pathstring
textstring
recordboolean

recordedWrite(path: string, text: string) → void

Write `text` to `path`, recording the write into the open undo operation when one is open so undoing it restores the file's previous contents. Raises when the write fails.

argtypedescription
pathstringVFS path.
textstringThe whole new contents.

examples

Settings.recordedWrite(ref.path .. "/values.yaml", Yaml.encode(doc))

writeValues(ref: any, values: { [string]: any }, explicit: { [string]: any }?) →

Write this asset's whole settings values file. The values (and `explicit`) are read through the type's `normalizeSettings` first, so an older spelling is stored as the field it names today. They then take the type's cross-field corrections (`M.applyCorrections`, with `explicit` as the fields the writer named — a correction contradicting one of them refuses the write), then are checked against the schema. Every violation is reported in one error naming the field, what it takes, and where the schema is declared. When the asset also carries legacy `.metadata` settings and its origin is authored — this world's own content, or the engine's builtin library — the legacy key is dropped as part of this same write, so the values file above is what a read prefers from here on. A library-installed asset keeps its `.metadata` settings key alongside the values file this call writes. Inside an undo operation, the write is recorded so undoing the operation restores the previous file contents; authored legacy content is first healed into its values file, so undo returns it to the healed file, which reads the same values as the legacy one. When that heal does not complete, the legacy settings stay in `.metadata` and the step records the values file alone, so undo falls back to the legacy values.

argtypedescription
refanyThe asset ref.
values{ [string]: any }The complete values table.
explicit{ [string]: any }?The fields the writer asked for by name (a patch), or nil.

examples

Settings.writeValues(texRef, { filter = "nearest", colorSpace = "srgb" })

write_values(ref: any, values: { [string]: any }, explicit: { [string]: any }?, record: boolean, level: number) → void

`M.writeValues`, recording its writes into an open undo operation only when `record` is set. `level` is the `error` level that names the public caller.

argtypedescription
refany
values{ [string]: any }
explicit{ [string]: any }?
recordboolean
levelnumber

resolvePatch(ref: any, patch: { [string]: any }) →

The complete values a partial settings patch writes — the values `asset.setSettings` hands `M.writeValues`. The patch is read through the type's `normalizeSettings` against the asset's current values, so an older field name lands as the field it names today with the meaning it had for this asset, and is merged over those values, a struct group field by field (`M.mergeValues`); the type's derived defaults (`M.applyDerivedDefaults`) then move each field that follows a field this patch changed, unless the patch names it too. `M.writeValues` applies the corrections with the normalised patch as the explicit fields.

argtypedescription
refanyThe asset ref.
patch{ [string]: any }Any subset of the schema's fields, in the current or an older spelling.

examples

local values, named = Settings.resolvePatch(texRef, { compression = "uastc" })

presetLayerFor(typeName: string, destPath: string) →

The Preset Manager's layer for a new asset of `typeName` at `destPath`: the valid values of the world's first `[[presets]]` row naming the type's assetType whose filter matches the new asset's path (under `/source` for a durable asset, under `/runtime/assets` for a runtime one), and the match. Nil for any other destination, a type with no type-level schema, or no matching row.

argtypedescription
typeNamestringThe asset type being created.
destPathstringWhere the new asset lands.

examples

local layer = Settings.presetLayerFor("texture", "/zero/source/sprites/hero.texture")

type_schema_problem(typeName: string, schema: any, ref: any?) → void

argtypedescription
typeNamestring
schemaany
refany?

settingsDefaultsHookOf(typeName: string) →

`typeName`'s own create-time settings-defaults hook — its `behavior.luau`'s exported `settingsDefaults(name, opts, asked)`, when it ships one — or nil. A type contributes a layer here for whatever it can only compute at creation (a name-derived convention, a fact read off a pre-encoded payload the caller handed it, a default that follows a field another layer sets); `resolveForCreate` calls it once per create, above the schema's own defaults and below every other layer, with `asked` holding what the layers above it (the Preset Manager, an importer, the caller) name, field by field, the higher layer's value where two name one. The hook returns a fresh table of its own opinions; it is never handed anything to mutate, and a field it returns that a layer above it names takes that layer's value.

argtypedescription
typeNamestringThe asset type's name.

examples

local hook = Settings.settingsDefaultsHookOf("texture")

settingsCorrectionsHookOf(typeName: string) →

`typeName`'s own settings-corrections hook — its `behavior.luau`'s exported `settingsCorrections(values, name, opts)`, when it ships one — or nil. Where `settingsDefaults` supplies an opinion a layer below the caller can still override, this hook enforces a cross-field constraint the schema itself has no way to express (a field whose valid range depends on another field's resolved value). `M.applyCorrections` calls it on every settings write — once a create's layers have merged, and on every later write of the values file. Called with the complete values; it READS them and RETURNS a table of the corrections to apply (or nil for none), rather than mutating what it was given. A SECOND return, `{ [field]: reason }`, names why a corrected field cannot hold the value it is being corrected away from — used only when the writer named that field explicitly, to explain the refusal; omitted or missing a field falls back to a generic reason.

argtypedescription
typeNamestringThe asset type's name.

examples

local hook = Settings.settingsCorrectionsHookOf("texture")

explicit_leaves(schema: any, explicit: { [string]: any }) → void

Every leaf field `explicit` names, each as `{ path, keys, value }`: a struct field the schema declares (a `Field.struct` or `Field.settingsOf` group) is descended into, and anything else is a leaf, compared whole.

argtypedescription
schemaany
explicit{ [string]: any }

walk(fields: any, t: { [string]: any }, keys: { string }, depth: number) → void

argtypedescription
fieldsany
t{ [string]: any }
keys{ string }
depthnumber

value_at(t: any, keys: { string }) → any

The value at `keys` inside `t`, or nil where the path runs out.

argtypedescription
tany
keys{ string }

correction_reaches(corrections: any, keys: { string }) → boolean

Whether `corrections` sets the field at `keys`: it names the field itself, or replaces a group above it with something that is not a table.

argtypedescription
correctionsany
keys{ string }

show_value(v: any) → string

A settings value as a reader sees it in a message: a scalar as itself, a table as `{ k = v, ... }` in key order.

argtypedescription
vany

derivedHookOf(typeName: string) →

`typeName`'s own derived-defaults hook — its `behavior.luau`'s exported `settingsDerivedDefaults(values, explicit, changed)`, when it ships one — or nil. It answers the values of fields whose default follows another field (a texture's colour space follows its texture type), given the complete values, the fields the writer named (`explicit`) and the fields this write changed (`changed`). The framework applies a returned field only when the writer did not name it (`M.applyDerivedDefaults`).

argtypedescription
typeNamestringThe asset type's name.

examples

local hook = Settings.derivedHookOf("texture")

creationInputsOf(typeName: string) →

The creation inputs `typeName` declares, and the shape each one belongs to — its `behavior.luau`'s exported `creationInputs` map, when it ships one, or an empty map. A key is a top-level `asset.create` opt the type's `onCreate` reads as what the asset is MADE FROM; its value is the name of the opt that selects the shape the input belongs to, or `true` for an input that belongs to every shape. `soundClip` declares `{ sampleRate = "pcm", channels = "pcm", ext = "bytes", writeSource = "bytes" }`: `sampleRate` and `channels` describe raw PCM as it arrives and mean something only alongside `pcm`; `ext` names the container encoded source bytes are in, and `writeSource` keeps a copy of them, and both mean something only alongside `bytes`. `asset.create` reads it before anything else touches the caller's opts. A declared input given alongside the opt that selects its shape is a creation input and reaches `onCreate` unchanged. A declared input given on any other shape has no meaning there and never reaches `onCreate`; one that names no declared setting refuses the create, naming the input and the opt it belongs with.

argtypedescription
typeNamestringThe asset type's name.

examples

Settings.creationInputsOf("soundClip").sampleRate --> "pcm"

clone_value(v: any) → any

Copy a value for `cloneValues`: a table copies recursively, key by key, to whatever depth it nests; anything else (string, number, boolean, nil) is returned as-is, since a scalar has nothing for two tables to share.

argtypedescription
vany

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

Structural equality for a settings value at any depth: two tables are equal when they hold the same keys and every value is itself equal (recursively), and two scalars (string, number, boolean, nil) are equal by `==`. Table VALUES in a settings table are always freshly built — `defaultsOf` clones a default, `read_values_file` decodes a fresh table from YAML — so comparing them by reference would report a table-valued field as changed on every read even when its contents are identical. The one comparison every settings-value equality check in this module shares — `diffFor`'s own diff and `resolveForCreate`'s caller-conflict check both call this rather than each carrying its own. Takes acyclic settings values — YAML-shaped data, the same invariant `clone_value` relies on — so the recursive walk always terminates.

argtypedescription
aanyA settings value (a scalar or a table, at any nesting depth).
banyA settings value to compare it against.

examples

Settings.valuesEqual({ a = 1, b = { 2, 3 } }, { a = 1, b = { 2, 3 } }) --> true

cloneValues(values: { [string]: any }) →

A deep copy of a settings values table — every table-valued field, and every table nested inside one (a `Field.settingsOf` group, a list of structs), copied at whatever depth it goes. Settings values are YAML-shaped data (tables, strings, numbers, booleans, never a cycle), so a plain recursive table copy is the whole guarantee this makes: nothing a hook or `onCreate` does to what it's handed, at ANY depth, can reach the table `asset.create` goes on to stamp into the values file.

argtypedescription
values{ [string]: any }The values table to copy.

examples

local copy = Settings.cloneValues(resolved)

mergeValues(schema: any, base: { [string]: any }?, overlay: { [string]: any }?) →

Lay `overlay` over `base` under `schema`, the one way settings layers combine: a field `overlay` names replaces the field in `base`, except a struct field (a `Field.struct`, or a `Field.settingsOf` group) that both hold as tables, which merges field by field at whatever depth it nests — so a layer naming one field of a group leaves the group's other fields where the layers below put them. Neither input is modified; the result is a deep copy. depth), or nil to replace every named field.

argtypedescription
schemaanyThe Field schema the values follow (the fields of a struct at
base{ [string]: any }?The values below.
overlay{ [string]: any }?The values laid over them.

examples

Settings.mergeValues(schema, { group = { a = 1, b = 2 } }, { group = { b = 3 } }) --> { group = { a = 1, b = 3 } }

layer(t: { [string]: any }?) → void

argtypedescription
t{ [string]: any }?

diffFor(ref: any, writtenPath: string) →

The settings a write to `writtenPath` produced, and which fields it changed, when that path IS the asset's declared values file. A write to anything else answers `(nil, nil)`. A values file that fails its schema answers `(nil, nil)` too, after reporting the violations — the asset keeps the settings it last had rather than taking an invalid set. `changed` is computed against an in-process baseline (`last_values`, forgotten on delete via `forgetChangeBaseline`) — a fresh process, or an asset diffed for the first time this session, reports every field as `old = nil`.

argtypedescription
refanyThe asset ref.
writtenPathstringThe path that was written.

examples

local values, changed = Settings.diffFor(ref, change.path)

forgetChangeBaseline(assetPath: string) → void

Forget the diff baseline `diffFor` holds for `assetPath` — the settings it last saw for that asset's own folder path. Called when the asset is deleted, so a later create that reuses the same path (a delete-then-recreate) diffs its first write against nothing rather than against what the deleted asset last held, and the baseline map does not grow for assets no longer alive.

argtypedescription
assetPathstringThe asset's own folder path, as `diffFor` keys its baseline.

examples

Settings.forgetChangeBaseline("/zero/source/Rock.texture")

seedChangeBaseline(assetPath: string, values: { [string]: any }) → void

Record `values` as the settings `diffFor` last saw for `assetPath`, so the dispatch of a values file written with exactly these values reports nothing changed. Every writer that has ALREADY done what those values ask for calls it with what it writes: `asset.create` after stamping a new asset (its `onCreate` encoded against them), a type's first-encode seed of a hand-written container, and the legacy heal (which moves values without changing one). A later write that changes a field still diffs against these and reports that field.

argtypedescription
assetPathstringThe asset's own folder path, as `diffFor` keys its baseline.
values{ [string]: any }The complete values table the values file holds.

examples

Settings.seedChangeBaseline(rawget(texRef, "path"), values)

writeActedValues(ref: any, values: { [string]: any }) → void

Write `ref`'s whole values file (`M.writeValues`) with `values`, the settings the caller has already acted on, and seed the change baseline with what was written (`M.seedChangeBaseline`) before that write's dispatch runs, so the dispatch reports nothing changed and no reaction runs a second time.

argtypedescription
refanyThe asset ref.
values{ [string]: any }The complete values table.

examples

Settings.writeActedValues(texRef, values)

write_healed(ref: any, healed: { [string]: any }, before: { [string]: any }) → void

Write `healed` into `ref`'s values file and seed the change baseline with `before`, the values the asset was read as before the heal, so the write's own dispatch reports exactly the fields the type's heal changed (none when healing only relocates storage) and the type reacts to those alone. A heal records nothing into an undo operation that happens to be open. Answers as `pcall` does.

argtypedescription
refany
healed{ [string]: any }
before{ [string]: any }

heal_legacy(ref: any) → void

Move `ref`'s settings out of legacy storage into its values file: write the values a read reports, which drops a legacy `.metadata` key and states every field in the spelling the schema declares. A read that raises is a heal that did not complete. Answers as `pcall` does.

argtypedescription
refany

healLegacyIfNeeded(ref: any, origin: string?) → void

Migrate `ref`'s settings out of legacy storage, when a LOCAL edit just landed on an asset that still carries them there: settings in the legacy `.metadata` block move into its values file, and a values file holding an older spelling (one the type's `normalizeSettings` rewrites) is rewritten in the declared spelling — every existing asset self-heals this way as it is touched, rather than only on an explicit settings write. Called once per dispatched edit, generically, for every registered type (a type that declares no settings block, an asset whose values file its type ships no `normalizeSettings` for or holds only the declared spelling, or one with no values file whose `.metadata` carries no `settings` key, returns without writing — this is a no-op the overwhelming majority of the time, by construction, and convergent: a second call after healing finds the values file in the declared spelling and does nothing). Never runs for a REMOTE-origin dispatch — the peer whose own edit this was heals it there, and the migration reaches every other session as an ordinary synced write once it does. Never runs for installed / foreign-origin content (`isForeignOrigin`, the same check `M.writeValues` already applies to the `.metadata` removal) — a library's own content is not this world's to rewrite. The healed values are what `M.valuesOf` already reports for this asset — the stored settings read through the type's `normalizeSettings` (`M.normalizeFor`), filtered to declared fields, schema-checked — with the fields the type's `settingsHealed` hook changes for settings stored before its schema decided them (a texture whose settings predate `compression` heals to the compression it should have). The diff baseline is seeded with the values read before the heal, so that write's own follow-up dispatch reports only what the hook changed: nothing, when healing only relocates storage — the edit that triggered the heal already got its own reaction from the dispatch that called this — and the changed fields otherwise, which the type reacts to as to any settings change. `AssetChangeDispatch.dispatch`.

argtypedescription
refanyThe asset ref the just-applied edit landed on.
originstring?The dispatch's origin ("local"/nil, or "remote") — see

examples

Settings.healLegacyIfNeeded(ref, change.origin)

orderedNames(schema: any) →

The field names of `schema` in the order they are declared: by each descriptor's `declaredOrder`, a name breaking a tie and a descriptor without one sorting after those that carry one.

argtypedescription
schemaanyThe Field schema table.

examples

for _, name in ipairs(Settings.orderedNames(schema)) do print(name) end

rank(name: string) → number

argtypedescription
namestring

acceptedFieldNames(typeName: string) →

Every field name a write to `typeName` may carry: the fields its schema declares plus the older names its `normalizeSettings` maps (`behavior.luau`'s `normalizedSettingNames`), sorted.

argtypedescription
typeNamestringThe asset type's name.

examples

local names = Settings.acceptedFieldNames("texture")

fieldNames(typeName: string) →

Every field name `typeName`'s settings schema declares, sorted.

argtypedescription
typeNamestringThe asset type's name.

examples

local names = Settings.fieldNames("texture")

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
# assetType.shared.typeYaml A type's `type.yaml`, parsed. Every block a type declares in its `type.yaml` (`settings:`, `inspector:`) is read through this module, so one file read and one YAML decode serve all of them. ```lua local TypeYaml = require("@builtin::assetTypes.assetType.shared.typeYaml") local folder, identity = TypeYaml.folder("material") -- "/zero/source/libs/@builtin/assetTypes/material.assetType", "@builtin::assetTypes.material" local doc = TypeYaml.of("material") print(doc.suffix) -- ".material" print(doc.inspector.type) -- "inspector.luau" ``` - `TypeYaml.folder(typeName)` resolves the assetType and answers its folder path and identity, or `(nil, nil)` when no such type resolves. - `TypeYaml.of(typeName)` answers the decoded document, or nil when the type does not resolve or its `type.yaml` does not decode to a table. The decode is cached per type and read again whenever the file's content version moves, or the type resolves to a different folder. - `TypeYaml.described(typeName)` lists the files a type's assets must describe: each file its `type.yaml` declares with a `described` content check, with the keys and headings the check names and each key's byte limit. `TypeYaml.PLACEHOLDER` is the marker a template puts where a description is yet to be written. - `TypeYaml.describeBlock(typeName)` answers the `describe:` block of the `type.yaml`: the type's own `guidance` on what a description covers and the identities of `examples` whose descriptions show the shape.
▲ 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
·
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/assetType.assetType/shared.module/settings.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.