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

baking

Shared utilities for the globalIllumination package's lightmap and probe bakers — light gathering, surface-attribute gathering (albedo + emissive per instance), transform helpers, and the scene-geometry gather that feeds `compute.buildBvh`. The lowest layer of the package; both b…

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

baking

Shared utilities for the globalIllumination package's lightmap and probe bakers — light gathering, surface-attribute gathering (albedo + emissive per instance), transform helpers, and the scene-geometry gather that feeds compute.buildBvh. The lowest layer of the package; both bakers consume the same primitives so the lighting model stays consistent across the lightmap and probe pipelines.

Exports

Constants:

  • Baking.SH_COEFFS = 9 — number of L2 SH basis functions per probe.
  • Baking.SH_FLOATS_PER_PROBE = 36 — std430-padded SH stride.
  • Baking.TRI_FLOATS = 72 — std430-padded triangle stride (matches the BVH builder).
  • Baking.BVH_NODE_FLOATS = 8 — floats per BVH node on the GPU.
  • Baking.LIGHT_FLOATS = 16 — GPU light record stride.

Functions:

  • Baking.vec3 / add / sub / scale / dot / cross / length / normalize — vec3 helpers used everywhere downstream.
  • Baking.gatherLights() -> { Light } — enumerate every Light component in the scene.
  • Baking.packLights(lights) -> FloatArray — pack lights for compute upload.
  • Baking.transformPoint / transformNormal / makeMatrix / entityWorldMatrix — 4x4 matrix helpers.
  • Baking.surfaceAttributes(entityId, cache) -> { albedo, emissive } — the entity's bake-facing surface description: linear albedo (base_color factor × average base-color texture color, clamped below 1) and emissive (color × strength).
  • Baking.gatherMeshInstances(excludeIds?) -> { instances, release } — every mesh-bearing entity as a { guid, transform, attributes } record for compute.buildBvh, CPU mesh items materialised; release() drops them again.
  • Baking.getEntityTriangles(entityId) -> { Triangle } — one entity's mesh triangles in local space (used by the UV rasterizer).

Types:

  • Vec3 = { x: number, y: number, z: number }
  • ColorRGB = { r: number, g: number, b: number }
  • UV = { x: number, y: number }
  • Mat4 = { number } — 16-float row-major.
  • Light = { id, kind, position, direction, color, intensity, radius }
  • Triangle = { v0, v1, v2, n0, n1, n2, uv0, uv1, uv2 }

Usage

local Baking = require("@builtin::systems.globalIllumination.baking")

local lights = Baking.gatherLights()
local gather = Baking.gatherMeshInstances({ entityId })
local bvh = compute.buildBvh(gather.instances)
gather.release()

Notes

  • All vec3 helpers return new tables — none mutate their arguments. Safe to call in hot paths but allocates per call.
  • gatherMeshInstances walks entity.findAll and materialises each mesh-bearing entity's CPU item (ecs.Mesh guid → mesh asset → ref:load()), so the engine-side BVH build can read the geometry — triangles never enter the Luau heap. Call release() after the build; assets whose keepCpu setting holds them stay resident.
  • surfaceAttributes deduplicates the texture averaging through the cache table — pass one table per gather so entities sharing a material average its texture once. Albedo lanes are clamped to 0.96 so multi-bounce transport converges.

Interface

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

conforms to

zero/source-extract/v2

Baking Module Shared utilities for lightmap and probe baking — light gathering, surface-attribute gathering, transform helpers, geometry walks. The lowest layer of the globalIllumination package; has no knowledge of either the lightmap or the probe storage layout. Both bakers consume the same primitives from here so the lighting model stays consistent across systems. Consumers: local Baking = require("@builtin::systems.globalIllumination.baking") local lights = Baking.gatherLights() local gather = Baking.gatherMeshInstances({})

dispatchGrid(itemCount: number, workgroupSize: number) →

Shape a one-item-per-invocation compute dispatch as a 2-D workgroup grid. A pass over N items needs `ceil(N / workgroupSize)` workgroups, which for a large surface is more than the `MAX_DISPATCH_DIM` a single dimension admits — so the grid is laid out near-square, spending both dimensions. The kernel reconstructs each invocation's linear index from its row plus the grid's width: `let i = id.y * (gridWidth * workgroupSize) + id.x;` — so it is handed `gridWidth` (the `x` returned here) alongside the item count. A square grid runs that reconstruction at every size, so the smallest pass covers the same arithmetic as the largest, and a side reaches the dimension limit only past `MAX_DISPATCH_DIM^2` workgroups. The last row is partly past the end whenever the count is not a perfect fit; the kernel's own `i >= itemCount` guard drops those invocations.

argtypedescription
itemCountnumberItems the pass covers — one invocation each.
workgroupSizenumberInvocations per workgroup, matching the kernel's `@workgroup_size`.

examples

local grid = Baking.dispatchGrid(texelCount, 64)
compute.dispatch(SHADER, { buffers = bufs, workgroups = { grid.x, grid.y, 1 } })

vec3(x: number, y: number, z: number) → Vec3 return

Build a Vec3 map from three component numbers.

argtypedescription
xnumberX component.
ynumberY component.
znumberZ component.

examples

local v = Baking.vec3(1, 2, 3)

add(a: Vec3, b: Vec3) → Vec3 return

Component-wise vec3 addition.

argtypedescription
aVec3Left operand.
bVec3Right operand.

examples

local sum = Baking.add(a, b)

sub(a: Vec3, b: Vec3) → Vec3 return

Component-wise vec3 subtraction.

argtypedescription
aVec3Left operand.
bVec3Right operand.

examples

local diff = Baking.sub(a, b)

scale(a: Vec3, s: number) → Vec3 return

Multiply a vec3 by a scalar.

argtypedescription
aVec3Vector operand.
snumberScalar multiplier.

examples

local scaled = Baking.scale(a, 0.5)

dot(a: Vec3, b: Vec3) → number return a

Vec3 dot product.

argtypedescription
aVec3Left operand.
bVec3Right operand.

examples

local d = Baking.dot(a, b)

cross(a: Vec3, b: Vec3) → Vec3

Vec3 cross product.

argtypedescription
aVec3Left operand.
bVec3Right operand.

examples

local n = Baking.cross(edge1, edge2)

length(a: Vec3) → number return math

Euclidean length of a vec3.

argtypedescription
aVec3The vector.

examples

local len = Baking.length(velocity)

normalize(a: Vec3) → Vec3

Normalise a vec3 to unit length. Returns `{0,1,0}` for near-zero input to keep callers safe from divide-by-zero.

argtypedescription
aVec3The vector to normalise.

examples

local n = Baking.normalize({ x = 1, y = 2, z = 3 })

declaredKind(c: any) → string

The light kind a component declares, or nil when it declares no `kind` field at all. A component that shades the whole scene names itself ("directional" / "ambient"); one that occupies a punctual row does not have to, since its row already carries its kind. Read through `fields()` so a component without the field is never asked for it.

argtypedescription
cany

declaresLight(c: any) → boolean

A component declares itself a light to the bake by carrying a `mobility` field and a private `baked` mark — the two pieces of state a bake needs from a light: how much of it to take, and whether it has already been taken. Such a component also answers `lightMobility()`. Field descriptors are read through `fields()`, which answers for any component, so the probe reaches a component that is not a light without touching a name it does not declare.

argtypedescription
cany

lightComponentOf(id: string) → any

The component that owns this entity's light, whatever component authored it. An entity can carry a Model as well as a light (a lamp with a bulb mesh); this picks the light.

argtypedescription
idstringThe entity to look at.

examples

local light = Baking.lightComponentOf(id)

vec3Of(v: any, dx: number, dy: number, dz: number) → Vec3

argtypedescription
vany
dxnumber
dynumber
dznumber

colorOf(v: any) → ColorRGB

argtypedescription
vany

lightsResolved(rows: { any }) → boolean

Whether every light-bearing entity in the scene is accounted for in `rows`. Directional and ambient light shades the whole scene rather than occupying a punctual row, so a component declaring one is already accounted for.

argtypedescription
rows{ any }

gatherLights( ) →

Collect every bakeable light in the current scene into a flat array of records. Punctual lights (point, spot, area) come from the rows the renderer resolved this frame, so their position, axis, cone, and rect basis are world-space and already carry the transform hierarchy — the bake shades the same lights the renderer does. Directional and ambient light come from the components that declare them. A light whose `lightMobility()` is `"dynamic"` (or whose component is disabled) is excluded — it stays realtime-only and contributes to no baked artifact. Static and mixed lights both bake their bounce; `bakeDirect` is true only for static ones, whose direct light the bake owns as well. A row with no light component behind it bakes its bounce and leaves its direct term to the runtime.

examples

local lights = Baking.gatherLights()

signedSolidAngle(ax: ?, ay: ?, az: ?, bx: ?, by: ?, bz: ?, cx: ?, cy: ?, cz: ?) → number

Solid angle the triangle (a, b, c) subtends at the origin, signed by the triangle's winding (Van Oosterom–Strackee). Summed over a closed surface this is ±4π for a point the surface encloses and 0 for one it does not.

argtypedescription
ax?
ay?
az?
bx?
by?
bz?
cx?
cy?
cz?

windingNumber(q: Vec3, tris: { Triangle }, m: Mat4, tick: () → void

Fraction of the sphere around `q` that the world-space triangles enclose — the generalised winding number. It reads +1 where the surface closes around the point with its faces turned away (a bulb inside its glass, a light sunk into a rock: the point is on the material side), -1 where the faces turn toward it (a room's inward walls seen from the open interior), and 0 outside. The sign is the answer: material side, or open side.

argtypedescription
qVec3
tris{ Triangle }
mMat4
tick(

buriedLights(lights: { Light }) →

Lights whose emitting surface sits inside a piece of static geometry — a rect sunk into its own fixture, a bulb inside its shade. The bake traces real geometry, so such a light's shadow rays are blocked the moment they leave it and it bakes black, while realtime shading may still light the scene: a shadow map cannot see an occluder nearer than its near plane, and a traced ray has no near plane. Enclosure is measured against the mesh itself: the geometry's bounding box picks the candidates, then the winding number of its triangles around the light decides. A light in the open interior of a room is inside the room's box and outside its walls, and reads as clear.

argtypedescription
lights{ Light }Light records from `gatherLights`.

examples

for _, b in ipairs(Baking.buriedLights(lights)) do warn(b.id) end

blockerGeometry(id: string) → any

argtypedescription
idstring

newSliceBudget(sliceMs: number?) →

A cooperative slice-yielder for long CPU bakes. The execute-time watchdog aborts any single uninterrupted Luau run that holds the VM past its budget, so a per-texel bake loop over a large mesh must yield periodically to stay under it — and yielding also lets the engine render a frame of progress between slices. `newSliceBudget` returns a `tick` closure: call it inside the hot loop; it counts calls cheaply and, every so often, samples `os.clock` (which advances within a frame, so a run that has yet to yield still measures its own length) — once the current uninterrupted run has spent `sliceMs`, it yields one frame (re-arming the watchdog) and resumes. Between samples it is just an integer increment, and the number of calls between samples adapts to what they cost, so a loop doing seconds of work per call is stopped on time and a loop doing microseconds pays the clock read rarely. The default slice is what a bake running beside a live scene can hold a frame for and still leave it drawing; each yield costs one frame, so a larger slice trades that responsiveness for a shorter pass.

argtypedescription
sliceMsnumber?Wall-clock milliseconds of uninterrupted work before a yield (default 100).

examples

local tick = Baking.newSliceBudget(); for _, t in ipairs(tris) do tick() ... end

packLights(lights: { Light }) → FloatArray

Pack the gathered lights into a flat float array sized for upload to a compute storage buffer. Layout = `Baking.LIGHT_FLOATS` per light.

argtypedescription
lights{ Light }Array of light records from `gatherLights`.

examples

local packed = Baking.packLights(Baking.gatherLights())

transformPoint(m: Mat4, p: Vec3) → Vec3

Apply a 4x4 row-major matrix to a vec3 point (w=1).

argtypedescription
mMat4The 4x4 matrix (16 floats, row-major).
pVec3The point to transform.

examples

local world = Baking.transformPoint(matrix, localPoint)

transformNormal(m: Mat4, n: Vec3) → Vec3

Apply 3x3 (upper-left of 4x4) to a vec3 normal. Does not handle non-uniform scale correctly — callers that need that should pass the inverse-transpose. For uniform scale this is correct.

argtypedescription
mMat4The 4x4 matrix (only the upper-left 3x3 is read).
nVec3The normal to transform.

examples

local n = Baking.transformNormal(matrix, localNormal)

makeMatrix(tx: number, ty: number, tz: number, qx: number, qy: number, qz: number, qw: number, sx: number, sy: number, sz: number) → Mat4

Compose a 4x4 row-major matrix from translation + quaternion + scale.

argtypedescription
txnumberTranslation X.
tynumberTranslation Y.
tznumberTranslation Z.
qxnumberQuaternion X.
qynumberQuaternion Y.
qznumberQuaternion Z.
qwnumberQuaternion W.
sxnumberScale X.
synumberScale Y.
sznumberScale Z.

examples

local m = Baking.makeMatrix(px, py, pz, qx, qy, qz, qw, sx, sy, sz)

entityWorldMatrix(entityId: string) → Mat4

Read the entity's object-to-world placement — its parent chain folded in, the matrix the renderer draws its geometry with — as a 4x4 row-major matrix. Geometry carried through it lands where the scene shows it, at every depth of a hierarchy.

argtypedescription
entityIdstringThe entity to query.

examples

local m = Baking.entityWorldMatrix(entityId)

readMeshAssetTriangles(guid: string) → any

Baking reads geometry the explicit CPU way: an entity's `ecs.Mesh` carries the GPU mesh guid; the guid resolves to its `.mesh` ASSET; `ref:load()` materialises the CPU item; the triangles are read off the CPU handle; the CPU item is dropped again unless the asset's `keepCpu` setting holds it. A runtime mesh with no asset behind its guid has no readable geometry — it contributes nothing to the bake. Read the local-space triangles of the `.mesh` asset behind `guid`. Returns the triangle array, or nil when no asset exists under the guid.

argtypedescription
guidstring

readRuntimeMeshTriangles(guid: string) → any

Read the local-space triangles of a RUNTIME mesh (GPU-resident under `guid` with no `.mesh` asset) by reading its geometry back from the shared vertex pool. The readback yields until the copy lands and carries every per-vertex stream the pool holds, including the lightmap UV set, so a procedurally built mesh bakes from the same triangle shape an asset mesh does. Returns nil when the guid is not pool-resident.

argtypedescription
guidstring

entityMeshGuid(id: string) → string

The GPU mesh guid bound to an entity's ecs.Mesh, or nil.

argtypedescription
idstring

averageTextureLinear(texGuid: string) → void

Linear-space average color of a texture asset, stride-sampled. Transparent texels (alpha < 16) are skipped so alpha-cut foliage averages only its visible surface. Returns nil when unreadable.

argtypedescription
texGuidstring

entityMaterialGuid(id: string) → string

The material a surface draws with, as the guid or registry key naming it. Nil when the entity carries no material-bearing component.

argtypedescription
idstring

materialReader(guid: string?) → void

A material's property reader: a `get(name)` function reading through the material's own surface — asset behavior methods for asset materials, the runtime registry (`renderer.material.describe`) for materials registered at runtime — plus a stable cache key. Both nil when the guid resolves to neither. Keyed by the material rather than by whatever draws with it, so a surface an entity places and a population's copies of one answer alike.

argtypedescription
guidstring?

surfaceAttributes(entityId: string, cache: { [string]: any }) → any

The bake-facing surface description of one entity's material: linear albedo (base_color factor × average base-color texture color, clamped below 1 for transport convergence), emissive (emissive color × average emissive-texture color × `emissive_intensity`, the product a surface shader displays), and the specular parameters `roughness` and `metallic` (each factor × the matching channel of an averaged `roughness_metallic_texture`, glTF's green/blue packing). `cache` deduplicates the texture averaging across entities sharing a material — pass one table per gather.

argtypedescription
entityIdstringThe entity whose surface to describe.
cache{ [string]: any }Per-gather memo table keyed by material identity.

examples

local surf = Baking.surfaceAttributes(entityId, {})

surfaceAttributesForMaterial(materialGuid: string?, cache: { [string]: any }) → any

The same bake-facing surface description, for a material named directly rather than reached through an entity — what a GPU-driven population's copies are described by, since a population names its material and owns no entity to read one off. `cache` deduplicates the texture averaging across everything sharing a material; pass one table per gather. A guid that names no material describes a neutral surface.

argtypedescription
materialGuidstring?The material asset guid or runtime registry key.
cache{ [string]: any }Per-gather memo table keyed by material identity.

examples

local surf = Baking.surfaceAttributesForMaterial(pop.material, {})

textureFactor(name: string) → void

The average color of a texture property, or white when the property names no texture (the `white` default stands for "no texture").

argtypedescription
namestring

isAlphaCutout(entityId: string) → boolean

Whether an entity's material is alpha-cutout — its base-color texture carries a meaningful share of near-transparent texels (foliage, chains, pierced fabric). Such geometry is thin and defined by its transparency, so as an opaque lightmap receiver it self-shadows to black and as an opaque occluder it casts solid shadows it should not. The bake keeps it off both paths and lets it sample the probe field instead. Memoised per material.

argtypedescription
entityIdstringThe entity whose material to classify.

examples

if Baking.isAlphaCutout(id) then continue end

isAlphaCutoutMaterial(materialGuid: string?) → boolean

The same classification for a material named directly — what a population's copies are judged by, since a population names its material and owns no entity to read one off. Memoised per material.

argtypedescription
materialGuidstring?The material asset guid or runtime registry key.

examples

if Baking.isAlphaCutoutMaterial(pop.material) then continue end

alphaCoveragePage(texGuid: string) → void

Downsample a texture's alpha channel into a `res * res` coverage grid by box-averaging, so a mask texel reports the fraction of the surface that survives there rather than a single point sample.

argtypedescription
texGuidstring

newAlphaMaskSet( ) → any

Start an empty alpha-mask set for one bake. Ask it for a page per receiver while gathering instances, then `pack()` the result into the buffer the bake shader samples. `pageForMaterial(materialGuid) -> (page, cutoff)` for geometry that names its material directly, and `pack() -> { number }`.

examples

local masks = Baking.newAlphaMaskSet()

pageFor(entityId: string) → void

The page index (0-based) and alpha cutoff for an entity's surface, or `(-1, 0)` when it is not a masked surface — the tracer treats that as ordinary solid geometry.

argtypedescription
entityIdstring

pageForMaterial(materialGuid: string?) → void

The page for a material named directly — the same answer, for geometry that names its material rather than being reached through an entity.

argtypedescription
materialGuidstring?

pack( ) → void

Flatten to the buffer layout the shader reads: a 4-float header (page count, resolution) followed by every page's coverage values.

isStaticGeometry(id: string) → boolean

Whether an entity's geometry belongs in the baked-lighting scene: static mobility only. A bake precomputes lighting that stays valid only while the geometry stands still — a movable mesh baked as an occluder would freeze its shadows into lightmaps and probes and then walk away from them. A `Model` answers through `resolveMobility()` (explicit field wins, otherwise derived); a `SkinnedModel` deforms, so it is always movable; a bare mesh with neither component is world geometry and counts as static. Invisible meshes are skipped outright — geometry that does not render must not occlude or bounce light. `Model.castsShadows = false` also keeps the surface out: it declares that this geometry blocks no light, which the bake honours the same way the realtime shadow pass does. That is the lever for a light's own decorative shell — the shards around a crystal's glow, a bulb's glass — which would otherwise stand between the light and everything it lights. Such a surface still renders, and still RECEIVES a lightmap.

argtypedescription
idstringThe entity to classify.

examples

if Baking.isStaticGeometry(id) then table.insert(occluders, id) end

isVisibleGeometry(id: string) → boolean

Whether an entity's geometry belongs in a trace of the scene as it stands right now: it exists, is active, and its mesh is visible. Mobility does not enter into it — a moving crate occupies space and blocks light exactly like a wall does, and a tracer rendering the present moment must see it, which is what separates this from `Baking.isStaticGeometry`. A skinned character is such a surface too: it stands somewhere, occludes and shadows, and `Baking.gatherMeshInstances` reads it in the pose it is wearing.

argtypedescription
idstringThe entity to test.

examples

if Baking.isVisibleGeometry(id) then table.insert(traced, id) end

gatherCopyKey(serial: number, guid: string) → string

A key for this gather's own copy of `guid`, distinct from every other gather's copy of the same mesh.

argtypedescription
serialnumber
guidstring

releaseHeldMeshes(held: { any }) → void

The `release()` a gather answers with: drop every CPU item the gather materialised. A runtime mesh (no ref) read back for the build is always dropped; an asset's CPU copy stays only when its `keepCpu` setting holds it.

argtypedescription
held{ any }

admitsPopulation(population: any, includeMovable: boolean?) → boolean

Whether a GPU-driven population's copies belong in a gather of the scene's geometry. A population declares its mobility at registration and its transforms live in a buffer anything may rewrite between frames, so the declaration is the whole answer: a bake, which precomputes lighting meant to outlive the moment, admits only a population that says its copies stand still, and one that also says it blocks light. A trace of the scene as it stands right now admits every population, the way it admits a moving crate.

argtypedescription
populationanyA record from `renderer.mesh.listInstanced()`.
includeMovableboolean?True for a trace of the present moment.

examples

if Baking.admitsPopulation(pop, true) then table.insert(traced, pop) end

beginPopulationRead(population: any) → void

Queue the read of one population's transform buffer. Every read of a gather is queued before any of them is waited on, so the registry is read across one span of frames — which is what makes a gather a picture of the scene as it stands, rather than a sequence of readings each taken after the one before it landed.

argtypedescription
populationany

awaitPopulationReads(reads: { any }) → void

Carry every read in flight to a terminal answer, filling each entry's `values` or the `why` it carried none. Each frame polls all of them, so the set is waited on once however many populations there are, and the wait ends on the reads' own answers: the engine holds every read to a bound of its own and gives one up with a reason once the GPU stops getting anywhere, so a read still in flight is one the GPU is still working towards. A read is polled through the state a buffer's read reports rather than through the readiness it raises on, because the buffer a registration names can go while the registration stands: the read then reaches a terminal answer carrying nothing, on the same frame the renderer stops drawing that population's copies, and a gather serving a bake reports the absence rather than raising through it. The frames waited on are every frame the renderer draws, a frame drawn while pipeline builds are still landing among them, since the render system delivers a read on each of those frames.

argtypedescription
reads{ any }

populationMatrices(population: any, values: { number }) → void

The world matrices a population's copies are placed by, as one row-major 16-float matrix per copy. The buffer holds them column-major — the layout a vertex shader reads an `array<mat4x4<f32>>` as — and every matrix this module carries is row-major, which is the transpose below.

argtypedescription
populationany
values{ number }

populationHandles(named: { any }?) →

Resolve a list of named GPU-driven populations to the set of registry handles it names, keyed for lookup. A caller holds a population either as the numeric `handle` a `renderer.mesh.listInstanced()` record carries or as the `InstancedDraw` it registered with, and both name the same registration, so both are read here — one place defines how a population is named, so every surface taking such a list takes the same forms.

argtypedescription
named{ any }?Handles, `InstancedDraw`s, or a mix of the two.

examples

local skip = Baking.populationHandles(opts.excludePopulations)

gatherPopulationInstances(maskSet: any?, opts: { [string]: any }?) → any

Collect every GPU-driven population's copies as the same `{ guid, transform, attributes }` instance records an entity's geometry produces, so geometry the renderer draws through `renderer.mesh.drawInstanced` reaches the gathers an entity renderable reaches. A population owns no entity and holds no CPU transforms: its members are enumerated from the instanced-draw registry, its mesh is materialised into the guid-keyed CPU store the engine-side build reads, its surface is described from the material it named, and its copies are placed by matrices read back from the GPU buffer that positions them. The read is of that buffer as it stands when the gather runs — a population a compute pass rewrites every frame is reported where it is now, and nothing is carried over between gathers. A copy sitting on a slot nothing has placed carries no basis, lands every vertex on one point and rasterizes nothing, so it is left out the way an invisible mesh is. The per-copy cost is one matrix; the mesh, the surface description and the mask page are held once per population and shared across its copies. population material so a masked population is seen through rather than occluding with its whole triangle. rather than the ones declaring `mobility = "static"`. `{ excludePopulations = { handle, ... } }` leaves the named registrations out, each named by the `handle` its record carries or by the `InstancedDraw` it was registered with — the registry's half of the vocabulary `excludeIds` gives a caller over entities.

argtypedescription
maskSetany?Optional `Baking.newAlphaMaskSet()`, asked for a page per
opts{ [string]: any }?`{ includeMovable = true }` widens the gather to every population

examples

local pops = Baking.gatherPopulationInstances(nil, { includeMovable = true })

gatherMeshInstances(excludeIds: { string }?, maskSet: any?, opts: { [string]: any }?) → any

Collect every static mesh-bearing entity as a `{ guid, transform, attributes }` instance record for `compute.buildBvh`, materialising each mesh's CPU item so the engine-side build can read it — geometry itself never enters Luau. Attributes carry the entity's surface description for the path tracer (floats 0..2 = linear albedo, 4..6 = emissive), which buildBvh stamps onto every triangle. Only `WorldEntity`-participation, static-mobility, visible entities are gathered: a bake computes persistent lighting for the world, so it traces standing world geometry only — `EditorOnly` diagnostics (viz markers, gizmos), `PrototypeOnly` templates, `RuntimeOnly` transients, and movable geometry (per the `Model.mobility` field / its derivation) are skipped. A skinned entity the gather covers contributes the geometry it is POSED in — the vertices the skinning pass wrote for it, read back through `renderer.mesh.readbackPosed`, so a character occludes and shadows where it stands rather than in its bind pose; one nothing posed contributes its source mesh, which is also what its draws read. An entity that has gone away between the walk that listed it and the read that reaches it is left out, so a gather over a scene where anything is despawning returns what still stands. Returns `{ instances, release }`; call `release()` after the build to drop the CPU items again (assets whose `keepCpu` setting holds them stay resident). A GPU-driven population registered with `renderer.mesh.drawInstanced` contributes one record per copy on the same terms — see `Baking.gatherPopulationInstances`, which admits a population into the static set on the `mobility` it declared and reads its copies' placement back from the buffer that positions them. surface contributes its coverage page and carries the page index + alpha cutoff in attribute floats 8/9, so the tracer sees through cut-away texels instead of occluding with the whole triangle. mesh-bearing world entity rather than the standing static set — what a tracer that renders the scene as it is right now needs, as against one computing lighting meant to outlive the moment. `{ excludePopulations = { handle, ... } }` names registrations to leave out the way `excludeIds` names entities — each by the `handle` its `renderer.mesh.listInstanced()` record carries or by the `InstancedDraw` it was registered with — so a caller that covers the geometry it placed narrows the registry the same way it narrows the scene. `{ includePopulations = false }` leaves the instanced-draw registry out altogether, so the gather covers entity-owned geometry only. A record's `guid` is the CPU-store key the build reads its geometry from. An entity-owned record names the mesh asset's guid, a posed copy's key, or, for a runtime mesh with no asset behind it, a key of the gather's own that the geometry was read back under. That copy stays resident until `release()`, whatever the mesh's owner does to the mesh in the meantime (an ocean surface re-registers its mesh on every frame it steps). An entity-owned record also names the entity it stands for in `entity`. A population's record names the mesh its registration draws, as `Baking.gatherPopulationInstances` returns it.

argtypedescription
excludeIds{ string }?Entity ids to skip. Pass `{}` (or nil) to include all.
maskSetany?Optional `Baking.newAlphaMaskSet()`. When given, each masked
opts{ [string]: any }?`{ includeMovable = true }` widens the gather to every visible

examples

local gather = Baking.gatherMeshInstances({ entityBeingBaked }, masks)

release( ) → void

getEntityTriangles(entityId: string) →

Get the triangles of one entity's own mesh in object-local space (not world). Used by lightmap baking, which rasterises in UV space and then evaluates lighting at the world-space point reached via the entity transform.

argtypedescription
entityIdstringThe entity to query.

examples

local tris = Baking.getEntityTriangles(entityId)

containerName( ) → string

Sanitize a scene name into an asset name.

assetSource(ref: any) → string

Where an asset's bytes live, or nil when that cannot be read.

argtypedescription
refany

isSessionScoped(ref: any) → boolean

Whether an asset lives in the copy-on-write layer the running session owns rather than with the world's own content. Baked lighting stored there holds for as long as the engine runs and is absent from the next boot, so this answers "will what I bake into this come back".

argtypedescription
refanyThe asset to locate.

examples

if Baking.isSessionScoped(container) then warn("bake in edit mode") end

reportSessionScoped(ref: any) → void

argtypedescription
refany

lightingContainer( ) → any

The scene's baked-lighting container (`lightmapData` asset) — the single asset every baked entry in the scene persists into. Resolves the existing container by the scene-derived name, creating an empty one when the scene has never baked. All bake output flows through it: lightmap entries keyed by receiver entity id, probe-field entries keyed by volume field id. The container the scene keeps lives with the scene's own content. A session that bakes while it is running its world writes into the copy-on-write layer that session owns instead, so the container it produces lasts as long as the engine does — an edit-mode bake takes the scene's container back, and a bake that can only reach the session's own says so.

examples

local container = Baking.lightingContainer()
⌬ Types
Vec3 = { x: number, y: number, z: number }ColorRGB = { r: number, g: number, b: number }UV = { x: number, y: number }Mat4 = { number }FloatArray = { number }Light = {Triangle = {

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.

49+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
◇
component · born here
❒asset
# Model Loads and displays a 3D mesh on an entity. Disabling the component hides the mesh. Supports procedural meshes (`cube`, `sphere`, ...), model files, and remote URLs. Tint and outline are shader effects applied to the mesh. **Material lives on this component.** There is no standalone `Material` component — a material only renders where there is a mesh to render it on, so the `material` field is part of Model (and SkinnedModel). Set it at add time or assign the field later; properties are registry-wide. Public fields: `model`, `material` (`AssetRef<material>`), `tintR/G/B`, `tintBlend`, `outlineR/G/B`, `outlineIntensity`, `outlineOccluded` (`"hide"`, the default, hides the rim where geometry stands in front of the mesh; `"dashed"` draws it there in dashes, the `occluded` choice of `@builtin::modules.outline`). Methods: `:setTint(color, blend?)` (color: `{r, g, b}` array or `{r=, g=, b=}` map), `:clearTint()`, `:setOutline(color, intensity?)`, `:clearOutline()`, `:setMaterialProperty(prop, value)`, `:getMaterialProperty(prop)`, `:getMaterialPropertyNames()`. ```luau entity(id).component.add("Model", { model = "cube", material = "gold" }) entity(id).component.get("Model").material = "checkerboard" -- swap material entity(id).component.get("Model"):setTint({1, 0, 0}, 0.5) entity(id).component.get("Model"):setMaterialProperty("roughness", 0.2) ``` **Tint is synced.** Every `tint*` field replicates, so `:setTint` is the colour every participant sees. A colour that changes every frame on many entities (a stress map, a heat map, a damage flash, per instance colour) belongs in an instance-data lane instead: wear `@builtin::materials.instance_color` (or `instance_color_unlit`) and write `renderer.instanceData.set(id, 2, r, g, b, coverage)`, which replicates nothing and costs about a twentieth of a tint write. `guides { path = "topics/rendering-instance-data" }` has the lane layout.
▲ 0↑ born
▣
module · born here
❒asset
# future A future is a promise held as a value: store it in a table, return it from a function, hand it to another task, and await it whenever the value is needed. Every promise-returning call (`http.get_json`, `delay`, `asset.load`, ...) already hands back one, a `PromiseHandle`; this module makes new ones, runs work as one, chains them, waits for several at once, bounds one in time and cancels them. ```lua local future = require("@builtin::modules.future") task.spawn(function() -- Start both loads; they run at the same time. local pending: { Future<any> } = {} table.insert(pending, http.get_json("https://example.com/a.json")) table.insert(pending, http.get_json("https://example.com/b.json")) -- Collect them. Each await returns once its load has settled. local results = {} for i, f in pending do results[i] = f:await() end end) ``` ## Members of a future | Member | What it answers | |---|---| | `f:await()` | Yields until the future settles and returns its value; a future that has already settled returns at once, with no yield. A rejection raises its error at this line. The same call as `await(f)` and `task.await(f)`. | | `f:state()` | `"pending"`, `"resolved"`, `"rejected"` or `"cancelled"`, read without taking the value. | | `f:rejection()` | Why the future was rejected: `{ message, origin?, stack? }`, the reason as text, the `chunk:line` the rejection came from and, when Luau rejected it, the stack there. `nil` while it is pending or once it resolved. | | `f:source()` | The `chunk:line` whose call created the promise, for finding what a hung await is waiting on. | | `f.handle` | The promise's id string. `tostring(f)` reads the same. | | `f:andThen(onResolve, onReject?)` | A future of what the handler returns; a future it returns is awaited and its value delivered. Without `onReject` a rejection passes through. A handler that raises rejects it. | | `f:catch(onReject)` | A future of `f`'s value, or of what `onReject` returns given the error. | | `f:finally(fn)` | A future settled the way `f` was, once `fn()` has run, whichever way `f` settled, cancelled included. | | `f:tap(fn)` | A future of `f`'s value, once `fn(value)` has seen it. | | `f:timeout(seconds, reason?)` | A future of `f`'s value that rejects with `reason` (a message naming the time by default) when `seconds` of real time pass first; `f` is then let go of. | | `f:cancel()` | Ends a pending `f` as cancelled: `true`, or `false` and the reason. | The chaining methods come with the module, which every world script VM loads, so a future an engine call hands back chains with no require. A handler runs in a task (it may wait) inside a `scopes.run`: the chained future settles once everything the handler started is over. Every task that awaits a future receives its value: the ones waiting when it settles and any that await it later, for as long as the future is held. ## Module functions | Call | Result | |---|---| | `future.wrap(promise)` | The future naming a promise, from its future or its id string. An id naming no promise the engine keeps raises. | | `future.new(onCancel?)` | A pending future plus `resolve(value)` and `reject(error)`, which settle it once. `error` is any value but nil. `onCancel()` runs when the future is cancelled. | | `future.resolved(value)` | A future already resolved with `value`. | | `future.rejected(err)` | A future already rejected with `err`. | | `future.after(seconds)` | A future resolving with `true` after `seconds` of real time (the promise `delay(seconds)` hands back). | | `future.spawn(fn, ...)` | Runs `fn(...)` as a task; the future resolves with what it returns (awaiting a future it returns) and rejects with what it raises. | | `future.all(futures)` | Every value, in the order given. The first rejection rejects it, the first cancel cancels it, and the rest are let go of. `{}` for none. | | `future.allSettled(futures)` | `{ status, value?, error? }` for each, in order, once all have settled. Never rejects. | | `future.race(futures)` | Settles the way the first to settle did; the rest are let go of. | | `future.any(futures)` | The first value resolved; the rest are let go of. When none resolves it rejects with `{ message, errors }`. | | `future.retry(fn, attempts, delaySeconds?)` | Calls `fn()` until it succeeds, at most `attempts` times, with `delaySeconds` of real time between. | | `future.fromEvent(event, predicate?)` | The first value of the next fire of `event` (a Signal, a component event, anything offering `:Connect(fn)` / `:connect(fn)`) that `predicate` accepts. Disconnects once settled or cancelled, and is cancelled when what started it ends. | ```lua local future = require("@builtin::modules.future") task.spawn(function() -- Both loads at once; the first failure fails the lot. local maps = future.all({ http.get_json(urlA), http.get_json(urlB) }):await() -- Whichever search answers first; the other is cancelled. local nearest = future.race({ future.spawn(searchNear), future.spawn(searchFar) }):await() -- No level within five seconds rejects, and the load is cancelled. local ok, err = pcall(function() return future.spawn(loadLevel, "forest"):timeout(5):await() end) end) ``` ## Cancellation `f:cancel()` ends a pending future as cancelled. Awaiting it raises the error `task.isCancellation(err)` recognises, and `f:state()` reads `"cancelled"`. A cancellation is never written to the error log. - **The work stops.** The task running a `future.spawn` or a handler is cancelled, and so is everything it started; each unwinds, so the `pcall` or cleanup around its wait runs. - **Downstream.** A future chained from a cancelled one (`andThen`, `catch`, `tap`, `timeout`, `all`, `race`, ...) is cancelled too, without calling its handler; `finally` runs its function first. - **Upstream.** A future counts the chains and combinators waiting on it. One whose last such consumer is cancelled, or settled without it (a `race` another input won, a `timeout` that ran out, an `all` another input rejected), is cancelled. A direct `await` is not a consumer. - **What started it.** The task running a handler belongs to what the calling code belongs to: a component instance, a scene load, a task scope. When that ends, the future is cancelled. A future an engine call handed back (`http.get_json`, `delay`) runs to its end whatever waits on it; its `cancel()` answers false and the reason. ## Rejections A rejection is kept apart from any value, so a future resolved with a table of any shape delivers that table. Awaiting a rejected future raises its error: a string at the await's line, any other value (an error table `reject` was given) as itself. Catch it with `pcall`, and read where it came from on the future: ```lua local f, _, reject = future.new() task.delay(1, function() reject({ code = 404, message = "no such level" }) end) local ok, err = pcall(f.await, f) if not ok then print(err.code) -- 404: the error value reject was given local why = f:rejection() print(why.origin) -- the line that called reject end ``` A rejection nothing sees (no await receives it and nothing reads `rejection()`) is written to the error log once the future is gone, so a future you hold and await later reports nothing on its own. A chain or combinator sees every rejection its inputs hold when it settles, so the second rejection of an `all`, or a `race` input already rejected when another won, writes nothing. ## Identity A VM holds one future object per promise. Every call that hands a promise to the VM while its future is alive, `future.wrap` included, hands back that same object: `future.wrap(f) == f`, `rawequal(future.wrap(f.handle), f)`, and a future is one table key. ## Types `Future<T>` is a future whose await delivers a `T`; `PromiseHandle` is a future whose value has no stated type. They name the same value, so either is accepted where the other is declared, and `f:await()` on a `Future<T>` checks as a `T`. `f:andThen(fn)` checks as a `Future` of what `fn` returns (a `Future<V>` it returns reads as `V`), `f:catch(fn)` as the value or what `fn` returns, `finally`, `tap` and `timeout` as `f`'s own type, and `future.all({ Future<T> })` as a `Future<{ T }>`.
▲ 0↑ born
▣
module · born here
❒asset
# lighting Scene-lighting base capability: ambient + directional ("sun") light and procedural-sky setup with modify-or-spawn, read-merge-write semantics, plus clear color, and the per-frame reads of the resolved lights. Identity is the component, never the entity name: the sun is the `Light` the renderer's snapshot names as the directional holder, the ambient is the light-role component of kind "ambient", and the sky is the entity carrying a sky-role component. Name-based lookup, word resolution, and sky-material orchestration (presets, material swap) live in the `lighting` toolbox. `sun` and `ambient` configuration patch the scene's resolved sun / ambient light components, spawning a carrying entity when the scene has none. A partial update (e.g. only `intensity`) reads the component's current fields first and merges the given fields on top, so unspecified fields keep their authored values instead of resetting to a default. `sky` writes the sky entity's ProceduralSky component the same way — any of its fields, plus `enabled = false` to remove the sky component. ## Types - `SunOpts` — `{ direction?, color?, intensity?, castsShadows? }`. - `AmbientOpts` — `{ color?, intensity? }`. - `ProceduralSkyOpts` — ProceduralSky component fields, plus `enabled = false` to remove the sky. - `SetupOpts` — `{ sun?, ambient?, sky?, clearColor? }`. - `SetupResult` — `{ sun?, ambient?, sky? }`, the entity ids each provided section resolved to. - `Sun` — `{ direction, color, intensity, castsShadows, entityId? }`. - `Ambient` — `{ color, intensity, entityId? }`. - `LightRow` — one punctual light as the renderer resolved it. ## Exports Writes — each takes the opts above and answers with the entity the light resolved to: - `M.setSun(opts: SunOpts) -> string` — set the scene's sun, returning its entity id. - `M.setAmbient(opts: AmbientOpts) -> string` — set the scene's ambient term, returning its entity id. - `M.applySetup(opts: SetupOpts) -> SetupResult` — apply a lighting setup in one call. All fields optional — only provided fields change. `clearColor` is `{r, g, b}`. - `M.setProbeVolume(key: string, volume)` / `M.removeProbeVolume(key: string)` — publish or retract a baked irradiance probe volume. Reads — each takes no arguments, and answers from the resolved lighting state at a cost independent of scene size: - `M.sun() -> Sun` — the sun the frame is shaded by. - `M.ambient() -> Ambient` — the ambient term the frame is shaded by. - `M.lightRows() -> { LightRow }` — every punctual light the renderer resolved this frame. Identity: - `M.lightKind(componentType: string, component: any?) -> string?` — the kind a light-role component names. - `M.lightOfKind(entityId: string, kind: string) -> any` — the light-role component of that kind on one entity. ## Usage ```luau local lighting = require("@builtin::modules.api.engine.lighting") lighting.setSun({ direction = { 0.3, -1, 0.2 }, intensity = 2.0 }) lighting.setAmbient({ intensity = 0.3 }) lighting.applySetup({ sun = { direction = { 0.3, -1, 0.2 }, intensity = 2.0 }, ambient = { intensity = 0.3 }, sky = { timeOfDay = 14 }, }) local sun = lighting.sun() print(sun.intensity, sun.entityId) ``` A reader takes no arguments and a setter takes the opts table, so `lighting.sun(opts)` is refused with the name of the call that applies it.
▲ 0↑ born
▣
module · born here
❒asset
# frame_budget The share of a frame that cooperative engine work spends before it hands the frame back. Some engine work is one long sequence of small units run on a task: a scene load applies one record after another, and the world-load `onRegister` sweep fires one instance's hook after another. Run back to back in one frame, a long sequence holds that frame for its whole length, and nothing else the engine does (answering a call, drawing, input) happens until it is through. Asking `due()` before each unit and yielding when it answers true runs the same work across as many frames as it needs, a slice of each. ```luau local FrameBudget = require("@builtin::modules.frame_budget") for _, item in ipairs(items) do FrameBudget.yield() process(item) end ``` - **One slice per frame, shared.** Each caller is charged the time it runs between its readings of the slice in a frame (`task.runTime`), whoever runs it, and the charges of every caller add up to the frame's slice. What the rest of the frame runs (systems, components, other tasks) is not charged, so a busy frame still gives the slice to the work. Two long pieces of work running at once share a frame's slice rather than taking one each. - **A unit is never split.** The first unit of a frame always runs, so a frame holds at most the slice plus the one unit that crossed it. A unit that is itself long stays one piece of work. - **Code that cannot yield runs in its frame.** `due()` answers false outside a coroutine that can yield, so a caller called from such code does all its units in the frame it was called in, as it would without the budget. A caller that does work of its own around the yield asks `due()` and calls `wait()`, which yields to the next frame and opens that frame's slice as the caller resumes; `yield()` is the two together. Work whose unit is a native call that bounds itself by time is told how long it may run: `remainingMs()` answers what is left of the current frame's slice, or nil for code that cannot yield, which then runs the whole of its work in the frame it was called in. The publish gate's script check runs this way: ```luau local block, checking = __spacetime_vcs.scriptPublishBlock(FrameBudget.remainingMs()) while checking do FrameBudget.wait() block, checking = __spacetime_vcs.scriptPublishBlock(FrameBudget.remainingMs()) end ``` ## The background lane Some work is started early so it is ready when asked for, and no picture waits on it, such as the search text an editor reads ahead of the first `tools.search`. `background(fn)` runs `fn` on the background lane: every `yield`, `due` and `wait` its work makes on that coroutine hands the frame back for as long as a hold on the lane stands, and takes its slice as usual once none does. ```luau FrameBudget.background(function() for _, path in ipairs(paths) do FrameBudget.yield() warm(path) end end) ``` Work the picture waits on holds the lane while it runs: `holdBackground(key)` until `releaseBackground(key)`. A world's entry holds it under `"world entry"` from the moment the world is ready (its `onRegister` sweep) until its `onWorldLoad` has returned, so the frames of the entry carry the world's load and the background work runs in the frames before and after it. A hold no one releases lapses after `BACKGROUND_HOLD_SECONDS` (or the seconds it was taken for), with a warning naming its key, so work on the lane always runs in the end. `backgroundHolds()` lists the keys holding the lane now, and `backgroundWaits()` answers whether the calling code's next unit waits for it (a walk with a clock of its own asks it between its pieces). `FrameBudget.DEFAULT_MS` is the slice a call that names none spends. `spent()` answers how much of the current frame's slice is gone. A caller with a budget of its own reads `mark()` where its work starts. `ranMs(mark)` answers how long it has run since, none of the time it spent suspended; `cpuMs(mark)` answers the CPU time of its work since: those stretches and the stretches of every coroutine it resumes, and every one they resume, while it waits on them, which a machine whose cores are taken by other work does not stretch, so a bound that refuses work for running too long refuses the same work on a loaded machine as on an idle one, and work handed to a coroutine as work run in place. A task it starts and waits for runs while it is suspended, which `cpuMs` does not count.
▲ 0↑ born
◇
component · born here
❒asset
# SkinnedModel Component that drives skinned model playback and animation graph integration. Like `Model`, it carries the `material` field (`AssetRef<material>`) — material lives on the model that renders it, not as a standalone component. Set it at add time or assign `entity(id).component.get("SkinnedModel").material = "..."` later; `:setMaterialProperty` / `:getMaterialProperty` / `:getMaterialPropertyNames` operate on the assigned material (registry-wide). **Tint is synced.** Every `tint*` field replicates, so `:setTint` is the colour every participant sees. A colour that changes every frame on many characters (a damage flash, a team colour, a heat map) belongs in an instance-data lane instead: wear `@builtin::materials.instance_color` (or `instance_color_unlit`) and write `renderer.instanceData.set(id, 2, r, g, b, coverage)`, which replicates nothing. `guides { path = "topics/rendering-instance-data" }` has the lane layout. ## Blend model `skinning` chooses how the pass combines a vertex's joint influences. - `"linear"` (default) averages the joint matrices themselves. The average of two rotations is not a rotation, so a strongly twisted joint loses volume toward its axis — at a 180° twist a limb collapses onto the axis entirely. - `"dualQuaternion"` averages the joints' rigid motions as unit dual quaternions and renormalises, so the blend is a rotation at every weight and the cross-section is carried through the twist. Non-uniform joint scale rides along as a separately blended stretch. It costs a quaternion extraction per influence, so it is worth setting on characters whose wrists, shoulders or spine twist far, and leaving off elsewhere. ```lua entity.find("hero").component.get("SkinnedModel").skinning = "dualQuaternion" ``` A rig at rest renders identically under either model. ## Render self-check A few frames after its mesh attaches, a SkinnedModel checks that the mesh names something the engine can draw (on the GPU, or held off the device until this display puts it back) and that the pose it is drawn in has not collapsed it: the posed vertices the skinning pass wrote are measured against the mesh's own bind-pose extent, so a 1 cm part of a prop is judged by its own size. A mesh that fails is swapped for the builtin ERROR marker, drawn un-skinned with the error material, and the reason is logged. Setting `model` again takes the marker down and checks the new mesh. `renderCheck()` answers the verdict: `{ state = "pending" | "passed" | "failed" | "skipped", reason }`. ```lua local v = entity.find("prop_part").component.get("SkinnedModel"):renderCheck() if v.state == "failed" then print(v.reason) end ```
▲ 0↑ born
·
assettype · born here
❒asset
# assetType (asset type) An asset type says what a kind of asset is: the files an asset of the kind is made of, the code that gives it behaviour, the interface a person uses to work with it, and how it is found, pictured and checked. A `<typename>.assetType/` folder declares a type called `<typename>`, and every `<name>.<typename>/` folder is an asset of it. `assetType` is itself a type, so a type is an asset like any other: it is created, versioned, installed and contributed the same way. ## Making a type `asset.create("assetType", "<typename>")` scaffolds a type. The type registers the moment its folder is written, anywhere under `/zero/source/`, and from then on `<name>.<typename>/` folders are its assets. An asset of a type that is not registered yet is not an asset, so make the type first. A type folder is a root: `~.x` in any file inside it names the type's own `x`, wherever the type is installed. Keep the type's whole implementation inside its folder and reach it that way. What a type folder must hold is set by this type's own `type.yaml`, the same way every type's `type.yaml` sets what its assets hold. `asset.validate` on a type reports anything missing, and the scaffold produces a folder that passes. ## What sets your type's schema (`type.yaml`) `type.yaml` is the structural contract every asset of the type is checked against. The keys below are the ones the engine reads; a key not listed here is ignored. | Key | What it controls | |---|---| | `suffix` | The folder suffix of the type's assets. Defaults to `.<typename>`. | | `primary` | The file or files that are the asset's content: what the asset resolves to when it is used. | | `entry_files`, `primary_aliases` | Further files that load as the asset or share its identity. | | `is_container` | Whether the suffix stays in the identities of what the asset holds. | | `is_opaque_walker` | Whether a walk of the tree stops at the asset and registers only its primary. | | `plural_dir`, `classify_exts` | Loose files in a folder of this name, or with these extensions, are assets of the type. | | `is_text_default` | Whether the asset's files are text unless stated otherwise. | | `broadcasts_subassets` | Whether assets nested inside an asset of the type are found by their own short name. | | `root` | `true` makes every asset of the type a root, so `~.x` inside one names that asset's own `x`. | | `contract_ref: { field, category }` | A key of the primary file that names another asset the asset is built on. | | `files: { required, optional }` | The files an asset holds (below). | | `allow_unlisted` | `false` reports every file the type does not declare. | | `aliases_from: [{ file, key }]` | Further names an asset answers to, read from its own files. | | `settings:` | Typed per-asset settings (below). | | `inspector:` | The interface people use for the type and its assets (below). | | `preview:` | How an asset is pictured (below). | | `references:` | Names of other assets the type's files carry (below). | | `indexing:` | What search reads for each asset (below). | | `describe:` | How a missing description is generated (below). | ### The files an asset holds Each entry under `files.required` or `files.optional` is `{ path, kind: file | folder, one_of_group?, content? }`. `*` in a path matches within one segment. Entries that share a `one_of_group` are satisfied by any one of them. `content` lists checks on the file's bytes: | Check | Passes when | |---|---| | `non_empty` | the file has content | | `json_field { key, type?, non_empty?, accept? }` | the JSON holds the key (a dotted path) with that shape | | `yaml_field { key, type?, non_empty?, accept? }` | the same for YAML | | `described { keys?, headings?, message? }` | the file says what the asset is (see "Ask your assets to say what they are") | Each check takes a `message`, which is what the author is told when it fails. ### Settings `settings: { values, schema: { type | instance, export? } }` gives every asset typed settings. `values` names the file an asset's values live in; `schema.type` declares one schema for the whole type, and `schema.instance` names a file each asset declares its own in. `asset.create` writes the resolved values, and a write to the values file reaches `onChange` with what changed. ## The human side (`inspector.luau`) A type is used by people through its Inspector, and without one the type is usable only from code. The Inspector is the type's interface for a person: for a procedural graph it is the graph editor, for a kit it is the tracking view of what the kit holds and what is still missing. Writing it is part of writing the type. `inspector: { type, instance? }` in `type.yaml` names the files. `type` is the interface for the type itself and for its assets; `instance` names a file an asset may ship to add its own. Each returns: ```luau return { sections = { { id = "graph", title = "Graph", build = function(ctx) ... end } }, replace = { contents = { ... } }, -- replace a default section by id order = { "graph", "contents" }, -- section order } ``` `build(ctx)` receives the asset and builds the section. A section's `title`, and the text its rows carry, is a string or an `i18n.text` value read from a catalog (`i18n.text("inspectors.mesh.title")`), which follows the editor's language. `asset.create("assetType", ...)` scaffolds a working `inspector.luau` to start from. `asset.validate` on a type that names no inspector, or names one that does not load, reports it. ## Say what your type is for (`about.yaml`) Every type carries an `about.yaml` that says what the type is for, in three plain-language texts: ```yaml intent: "Sets the typeface of the text in your game: UI, labels, signs and 3D lettering." function: "A font, from a TTF, OTF or WOFF file, made available to all of Zero's text, including 3D text." usage: "You choose it by name for your UI or your text, and the text appears in that typeface." ``` - **`intent`** is what the type is for in someone's game, in the words a game maker uses. Up to 800 bytes. - **`function`** is how it works today: what an asset of it is made of and what the engine does with it. Up to 1500 bytes. - **`usage`** is what a person or an agent does with one. Up to 1200 bytes. Write about the type as a whole, not one asset of it, and say what it does now. Agents read these texts to learn when to reach for the type and how; people searching find the type by them. The scaffold starts each text with `[[describe]]` and a note on what to write; a text that still starts that way counts as not written. `services describe` can write them. They show up in `asset.inspect` as `detail.about`, in `assetTypeRef:getAbout()`, at the end of the type's `types/<typename>` guide, and at the top of the type's Inspector. ## Ask your assets to say what they are A type can require each asset to carry a description: a file, written by the author or generated, saying what the asset is and what it is for. Declare it with a `described` check: ```yaml files: required: - path: "README.md" kind: "file" content: - { check: "described", message: "Say what this widget is for and where it goes." } ``` A file that is missing, empty or still has a line starting with `[[describe]]` fails the check, and so does a YAML file whose named `keys` are missing or over their `max_bytes`, or a Markdown file missing a named heading. `asset.validate` names the asset, and a push that carries it is refused with `message`. `services describe` finds such assets and writes their descriptions. `describe:` steers what is generated: ```yaml describe: guidance: "Say what the widget shows, what input it reacts to, and where it fits in a UI." examples: - "<identity of an asset of this type whose description reads well>" ``` An example is an asset of your type whose description is a true, written one, never a placeholder and never the asset being described; with none, leave `examples` empty. A type whose assets the model cannot perceive (a sound, a motion) says so in `guidance`, and the description is drawn only from what the asset's own files state. Start the file unwritten in your `template/`: a heading and one line starting with `[[describe]]`, never example content, which every new asset would carry verbatim. A type whose assets say what they are through their own content (a mesh, a texture) declares no check. ## The type's code (`behavior.luau`) `behavior.luau` returns one table. These are the keys the engine reads from it; anything else on the table is the type's own. ### What the type's assets can do | Key | Shape | What the engine does with it | |---|---|---| | `ref` | `{ [name] = function(self, ...) }` | Every function becomes a method on every asset of the type: `ref:name(...)`. | | `modules` | `{ [name] = require(".x") }` | Code the type's assets reach with `asset.containing(__FILE__).modules.<name>`. | | `events` | an events schema | Events an asset fires. Readers subscribe through `ref.events.<name>:connect(...)`; the type fires them. | | `refShapes` | `{ [method] = function(self) -> (typeExpr, source?) }` | The result type of a `ref` method for one particular asset (below). | | `namePattern` | a Lua pattern | The names `asset.create` accepts for the type's assets. Default `^[A-Za-z][A-Za-z0-9_]*$`. | | `derive` | `{ output, module, compute, fingerprint, matches?, required?, timeout? }` | A file computed from the asset when it is committed; a `required` one holds the commit until it lands. | Some `ref` names mean the same for every type, and the engine calls them: - **`instantiate(self, target?, opts?) -> (root, idMap)`**: puts the asset in a scene. Defining it is what makes the type scene-instantiable. Its return is a contract (below). - **`inspect(self) -> detail`**: what `asset.inspect` reports for the asset beyond the common record (below). - **`preview(self, opts)`**: renders the asset's picture; it wins over the type's `preview:` recipe. - **`previewMaterial(self) -> { material }`**: the material a `surface` preview paints. - **`saveDefinition(self)`**: writes the asset's in-memory edits back to its files in edit mode. Some names are answered for every asset before the type is asked, so a `ref` entry of the same name is never reached: `getSource`, `getBytes`, `getText`, `exists`, `deps`, `canInstantiate`, `canPreview`, `preview` (which calls yours when you define one), `meta`, `runtime`, `events`, `typeRef`, `modules`, and the residency flags `has_backing_asset`, `has_runtime_changes`, `cpu_resident`, `gpu_resident`. ### When the engine calls the type | Hook | Signature | When it runs | |---|---|---| | `onCreate` | `(name, opts) -> { [path] = contents }` | On `asset.create`. Returns the files of the new asset, laid over the type's `template/`. Annotate `opts`: its type is the schema `asset.create` checks the caller's arguments against. A `""` key writes a single loose file. | | `onReplace` | `(dest, files) -> files` | On an `asset.create` over an asset already at `dest`, after `onCreate`, so what the author added can be carried into the replacement. | | `onRegister` | `(self)` | Once per asset, when it first registers: when the world loads, on a live `asset.create`, and when an asset arrives later (installed, pulled, synced). This is what makes an asset take effect the moment it is written. | | `onChange` | `(ref, change)` | On every write to a file inside an asset of the type. `change` is `{ path, asset, type, kind, origin }`, plus `settings` and `settingsChanged` for a write to the settings values file; `kind` is `edited` or `seeded`, `origin` is `local` or `remote`. Filter on `change.path`. Writes to one asset arrive in order, each after the hook for the one before has finished, and the hook may wait on what it reads. A write the hook makes inside its own asset arrives later like any other, so keep the hook convergent. | | `onDependencyChange` | `(ref, change)` | When a module the asset's code requires is re-run, or a name the asset carries starts resolving. `change.kind` is `dependency`. | | `onDelete` | `(ref)` | When an asset of the type leaves the world: deleted, or the world it is in is swapped away. | | `validate` | `(ref) -> { { code, message, severity?, path? } }` | On `asset.validate`, after the `type.yaml` checks, for the type's own rules. `severity` defaults to `error`. Runs on every push, so a type's rules hold at publish. A hook that fails reports `validate.hook_failed`. | ### Settings hooks | Hook | When it runs | |---|---| | `settingsDefaults(name, opts, asked) -> table` | Once per `asset.create`, for values the schema's defaults do not give. | | `settingsCorrections(values, name, opts) -> (corrections?, reasons?)` | On every settings write. A correction to a field the writer named refuses the write, giving the reason. | | `settingsDerivedDefaults(values, explicit, changed)` | On a settings write, for fields derived from others. | | `normalizeSettings(values, stored?)` | On every read and write, to map an earlier spelling of a field to the current one. | | `settingsHealed(values, stored)` | On a read, to repair stored values. | | `settingsSchemaProblem(schema, ref) -> string?` | When an asset's own schema is read; a returned string refuses the schema. | `creationInputs` (`{ [opt] = true | selectorOpt }`) names `asset.create` options that are inputs to the type rather than settings. ### Reloading An edit to `behavior.luau` reaches existing assets with no restart. ## How an asset is pictured (`preview:`) | `kind` | The picture is | The type provides | |---|---|---| | `instantiate` | the asset placed in the preview studio through its `instantiate` | `ref.instantiate` | | `image` | a file the asset holds, fitted to the frame | `source: { files }`, the candidate files in order | | `surface` | the asset painted on a mesh | `mesh`, and `ref.previewMaterial` | | `custom` | whatever `ref.preview` returns | `ref.preview` | ```yaml preview: kind: surface mesh: sphere ``` `angle: [yaw, pitch]` turns the camera. The studio owns the light, the backdrop and the framing, so an asset pictures the same in every world. A type with no `preview:` that defines `instantiate` still answers `ref:preview()`. A picture is rendered when something asks to view it (the editor showing the asset, `ref:preview()`), when previews are generated on request (`assets.generatePreviews`), and when the asset is staged. An edit alone renders nothing. The picture records what it was made from, so a stale one is told from a current one. ## The names your type's assets hold (`references:`) Where your type's own format or API carries the name of another asset, declare it here: ```yaml references: keys: # a top-level key of the type's files that holds a name, or a table of them - { key: "shader", type: "shader" } args: # an argument of a call, counting from 1 - { call: "g:node", position: 2, type: "procNode" } fields: # a field of the options table a call takes - { call: "fx.beam", field: "material", type: "material" } ``` `type` is the category the name resolves in. `asset.declareReferenceKey`, `asset.declareReferenceArg` and `asset.declareReferenceField` declare the same from a script. ## What search reads (`indexing:`) `indexing:` is how assets are found. Search reaches an asset only through what its type's `indexing:` names, and adds nothing of its own. That includes you: an asset indexed badly is one you cannot find later, when you are making something else and need it. A type whose assets are never looked for says `indexing: none`. ```yaml indexing: data: # text, read from the asset's files - role: identity extractor: verbatim source: { file: "README.md" } - role: interface extractor: symbols source: { files: ["init.luau"] } - role: implementation extractor: verbatim source: { files: ["init.luau"] } content: # the picture - role: identity modality: image source: { file: "preview.png" } facets: # what a query filters and re-ranks by file: ".metadata" rigged: { type: bool, from: { components: { contains: SkinnedModel } } } roughness: { type: number, filter: range, from: { file: "mat.yaml", field: "floats.roughness" } } ``` **Roles.** Each `data` and `content` entry has a `role`, and a query matches in two slots: - **`identity`**: what an asset is. For anything you look at, the picture; for anything else, the text that says what it is. - **`capability`**: what it does and how it is made. `interface` (the signatures or shape a caller uses) and `implementation` (the body) both count as capability, and a type with code usually declares both. Ask what a person would recognise an asset of the type by, and what it does, and point each role at the file that says it. For text, that is the asset's description: the file your template starts with a `[[describe]]` block, which the author writes or `services describe` fills in (see "Ask your assets to say what they are"). **`data`.** `extractor: verbatim` embeds a file's text as it is; `symbols` embeds the declared signatures of code. `source` is `{ file }` or `{ files: [...] }`. Never index a file name (`source: { field: name }`): one or two words carry nothing to match. **`content`.** `modality: image` embeds the picture itself, so a text query matches what the asset looks like. A type whose assets are looked at makes the picture its identity. **`facets`.** What a query narrows and re-ranks the matches by. `file` is embedded whole, so keys nobody declared in it are still found. Each further key is computed for every asset and states a value for every one, including `false`: a file can imply "not rigged" but never say it, and a query separates rigged from unrigged only because the unrigged ones say `rigged: false`. A key is `{ type: bool | number | enum, filter?: range, from }`, where `from` is `{ file, field }` (a field of one of the asset's files, dotted for nesting), `{ metadata: key }`, or `{ components: { contains | any_outside } }` (what the asset's entities carry). ## What blocks a push A push checks every asset it carries against its type. These refuse it: - a required file that is missing, a `content` check that fails, a `described` file not written yet; - an error from the type's `validate`. Unlisted files and warnings do not. A `described` file blocks only a push that changes the asset. When a push is refused, the message names each asset and what it lacks. `world.publishBlockers()` and `zm status` read the same list without pushing. ## Typing a result from the asset (`refShapes`) A `ref` method whose result depends on the asset (one entry per child folder, per row of a config, per control a map declares) can only be annotated as `{ [string]: Thing }`, which accepts any key. `refShapes` states the result for each asset instead: a function returning a Luau type expression for that asset, and the module whose types the expression uses. Read the asset; never run it. ```lua -- inputMap.assetType/behavior.luau M.refShapes = { activate = function(self): (string, string) local names = {} for _, control in ipairs(M.ref.controls(self)) do table.insert(names, control.name .. ": Handle") end if #names == 0 then return "", "" end return "{ " .. table.concat(names, ", ") .. " }", "@builtin::modules.zinput.scheme" end, } ``` With it, `map.jump:onPressed(fn)` is checked and `map.noexisting` is reported. A per-asset type applies where the call site names which asset: a component field whose default names it, or an annotation `AssetRef<"inputMap", "<identity>">`. `asset.resolve(name, category)` carries only the category, and a name computed at runtime carries nothing, so calls on those keep the declared return. The type belongs to the call's result: index it there, or bind what you need from it there, and the names stay checked. `require("@builtin::assetTypes.assetType.shared.refShapes").published()` shows what was published: `categories` (each type's method surface) and `returns` (per-asset results by identity, then method). An identity missing from `returns` was never published. Results are recomputed when an asset is written; at most 64 assets of one type are read. ## Putting an asset in a scene (`ref.instantiate`) A caller writes one piece of code against every instantiable type, so what `instantiate` returns is fixed: ```lua local Instantiable = require("@builtin::assetTypes.assetType.shared.instantiable") M.ref = { instantiate = function(self, target, opts) local root = Instantiable.root(self, target, opts) -- compose the asset under `root`, now return Instantiable.result(self, root, idMap) end, } ``` **In.** `target` is the entity the asset lands under, or onto for a hierarchy type; with none, the type spawns a new root. `position`, `rotation` (three numbers in degrees, or a quaternion), `scale`, `name` and `temporary` mean the same for every type: `Instantiable.root` applies them to a root you make, `Instantiable.place` to one you adopt. Document any options of your own in the hook's `--!arg` docs. **Out.** `(root, idMap)`. `root` is the composed root, live when you return: build synchronously, never defer to a component's `awake`. `idMap` maps each original id to the spawned one, so a component that composes the asset again on every load can pass it back in and keep references into the composition. Every call goes through `Instantiable.result`, which refuses a root that is not live and turns a missing `idMap` into `{}`. ## Inspecting an asset (`ref.inspect`) `asset.inspect(ref)` builds a record every asset shares (`identity`, `name`, `guid`, `source`, `typeName`, `typeDefinitionPath`, `scope`, `origin`, `description`, `tags`), then calls `ref.inspect(self)` for the type's own `detail`: ```lua M.ref = { inspect = function(self) -- read the asset's own files, never runtime state: inspect works on an asset -- that has not been compiled, uploaded or registered return { --[[ what makes this asset what it is ]] } end, } ``` Without it, the record is the shared part alone, and an agent inspecting the asset learns nothing of what it is. A hook that raises leaves `detail` empty and sets `record.warning`. ## Discovery - `asset.list("assetType")`: every registered type. - `asset.inspect("<typename>")`: the type, its README and its `about.yaml` texts. - `asset.resolve("<typename>", "assetType")`: the type itself.
▲ 0↑ born
·
assettype · born here
❒asset
# Component (asset type) A component is a reusable behavior + data unit attached to an entity. The component file declares public fields, methods, and lifecycle callbacks; the engine instantiates one per attachment and drives its hooks every frame. Components are the primary unit of gameplay code — movement, AI, animations, UI panels, network sync, and per-entity state all live here. ## When to use one - You need per-entity state that survives across frames. - You need per-entity behavior driven by engine lifecycle hooks (`start`, `update`, `onDestroy`). - You want to expose configurable fields to designers / `entity.spawn` callers / scenes without code changes. If you need a stateless pure-function library, use a `.module`. If you need to generate content declaratively, use a `.service`; compute work belongs in a `.computeShader`. ## Where it lives - Source: `/zero/source/.../<Name>.component/` - Identity: `<Name>` (the `.component` suffix strips from the identity, but the folder retains the suffix on disk). - Folder shape: - `init.luau` (or `init.lua`) — declares the component. **Required.** - `README.md` — instance-level documentation. **Required.** - `.metadata` — agent-editable tags + free-form fields. **Required.** The structural contract is enforced by `asset.validate` against this type's `type.yaml`. ## How to create one Always start with the scaffold — it guarantees the folder shape matches `type.yaml` from the moment it's on disk: ```luau asset.create("component", "<Name>") -- Creates: /zero/source/<Name>.component/ -- init.luau (canonical declare + public block + hooks stubbed) -- README.md (instance README template) ``` After scaffolding, edit `init.luau` to fill in the actual fields and behaviour. The component registers as soon as the file is written — hot-reload is automatic; no engine restart required. ## How it operates 1. **Registration.** Writing `init.luau` into a `.component/` folder indexes the asset, mints a guid (in the `.meta` sidecar), and surfaces the type to the engine's component registry. Same-frame visible to `entity.component.add`. 2. **Attachment.** `entity(id).component.add(name, data)` (or the batch form `tools.use("entityOps", "addComponents", targets, { [name] = data })`) attaches an instance. The `data` table's fields override the component's declared defaults; omitted fields take the declared default. The `data` values are copied into `public.*` BEFORE `awake()` runs. 3. **Lifecycle.** The hooks run in this order: - `awake()` — same frame as attach, immediately after the data copy. Initialise state, set up native bridges, register with other systems. Other components on the same entity may not have awoken yet. - `start()` — the next frame. Every component on the entity has completed `awake()` by then, so cross-component setup is safe here. - `update(dt)` — same frame as `start()`, then every frame after, for as long as the gameplay clock is running. `fixedUpdate(dt)` runs once per physics step, straight after it, with the step's `dt`, so a frame can run it several times or not at all; `editorUpdate(dt)` runs while the clock is held. Which of them ticks is decided by `engine.mode` AND `engine.paused` together — see **Per-frame hooks and the two axes** below, and `man modes`. - `onDestroy()` — when the component is removed via `component.remove` or when the owning entity is despawned. Release resources, drop native ECS components. For the full list (`onEnable`, `onDisable`, `fixedUpdate`, `editorUpdate`, `onPropertyChanged`, `onAssetReload`, `onModuleReload`, `onBeforeSave`, …) and the timing details, **read `man components` — that is the canonical lifecycle reference. Generic component patterns (declare blocks, public fields, sync, ECS bindings, typed methods) all live there.** 4. **Public surface.** Fields declared in `public` are inspectable, editable in the inspector, and persist with the entity. Methods are declared on that same table with a colon — `typed function public:method(args)` — and every one of them takes the component ref as `self`, so a caller invokes it with a colon too: `entity(id).component.get(name):method(args)`. That is the one calling convention a component ref answers to: the reflection methods `ref:fields()` / `ref:getField(name)` / `ref:setField(name, value)` take the same spelling. A function the chunk declares at file scope (`function helper()`) is the component's own, reachable from its hooks under its bare name; `public` is what the ref carries. 5. **Settings and the Inspector card.** `type.yaml` names the component's settings schema as `settings: { schema: { instance: "init.luau", export: "public" } }`: the `public` table IS the schema, and its values live on each entity the component is on, so `asset.schema(componentRef)` answers the Field descriptors and no values file exists. On an entity the Inspector shows the component as a card whose generic `settings` section edits those fields as typed controls, each edit checked against the schema and written to the live component as one undoable operation. `type.yaml` also names `inspector: { instance: "inspector.luau" }`: a component that ships an `inspector.luau` beside its `init.luau` shapes its card — the file returns `{ sections, replace, order }` (see `assetTypes/README.md`, "`inspector:`"), each section's `build(ctx)` reading `ctx.component` (the live component) and `ctx.selection.id` (the entity). `SceneModule.component/inspector.luau` replaces `settings` with the bound module's declared inputs. 6. **Events.** An `events` block declares typed moments the component fires from inside — `events = { onHit = Event({ dmg = Field.number(0, NoSync) }) }`. The owner fires with `events.onHit:fire({ dmg = 10 })`; outside code subscribes through the proxy's subscribe-only facade, `entity(id).component.get(name).events.onHit:connect(fn)` (`:once` / `:wait` too). Pass `Sync` as the event's second argument to replicate a fire to other peers. Events let one component react to another's moments without polling. Full reference: **`man components`**, Events section. 7. **Hot reload.** Editing `init.luau` reloads the component definition; live instances are reconciled with the new declaration in-place, and each crosses one lifecycle boundary: `onDestroy()` ends the running life, then `awake()` and `start()` construct the one that replaces it, and `update()` resumes on the next frame. `public` and `private` values carry across; module-level `local`s belong to the chunk, so the new life starts with them at their initial values and its `awake`/`start` are what fill them in. Whatever the old life handed elsewhere — a subscription, a shared registration, a spawned entity — is released in `onDestroy`, the call that pairs with the construction about to run. An edit that leaves the source byte-identical crosses no boundary at all. A field carries its value across when something stated it: a key of the `data` table the instance was attached with (a scene record's data is that table), or a write made since. Every other field takes the edited source's declared default, so changing a default reaches every instance that left the field to it. An instance that states its own value for a field whose default the edit changed keeps that value, and the reload logs a `[HotReload]` warning naming the field, the entity, the value kept and both defaults. ## Discovery - `asset.list("component")` — every registered component (engine + world + libraries). - `asset.inspect("<name>")` — identity, scope, public fields, lifecycle methods, source path, and this type README. `detail` carries the component's declared `fields`, `methods`, and `events`, parsed from its source — `tools.use("assets","describe", "<name>")` renders it as markdown, so a component's events are visible without opening its source. - `ls /zero/source/<Name>.component` lists the files the folder holds. - `entity(id).component.list()` — components attached to an entity. ## Per-frame hooks and the two axes `engine.mode` (`"edit"` / `"play"`) and `engine.paused` (the gameplay clock) are independent, and the per-frame hooks read them separately: - `update(dt)` / `fixedUpdate(dt)` tick while **the gameplay clock is running** — whichever mode the engine is in. - `editorUpdate(dt)` ticks while **the clock is held** — because the mode is `edit`, or because play is paused — and also alongside `update` whenever edit is running. Which gives four states, and this table is the contract: | `engine.mode` | `engine.paused` | hooks that tick | |---|---|---| | `edit` | `true` | `editorUpdate` | | `edit` | `false` | `update`, `fixedUpdate`, `editorUpdate` | | `play` | `false` | `update`, `fixedUpdate` | | `play` | `true` | `editorUpdate` | Entering edit sets `paused = true` and entering play sets it back to `false`, so a session that never writes `engine.paused` only ever sees rows 1 and 3 — which is where the shorthand "`update` is the play tick, `editorUpdate` is the edit tick" comes from. It is the two default rows of a four-row table, not the rule. **Row 2 is the one that surprises.** With `engine.paused = false` in edit — set by hand, or by a tool that advances the gameplay clock to sample it, such as a `capture.collage` given a `duration` — `update` and `editorUpdate` both fire, once each, every frame. A component that declares both and routes them to one body therefore runs that body **twice per frame**: ```luau local function drive(dt) ... end function update(dt) drive(dt) end function editorUpdate(dt) drive(dt) end -- twice per frame in row 2 ``` Nothing reports the doubling; it reads as an animation running at twice its intended speed. To get exactly one tick per frame in every row, ask which axis you meant and answer it in the body: ```luau function update(dt) drive(dt) end function editorUpdate(dt) if engine.paused then drive(dt) end end ``` A scene `entrypoint.luau` declaring the same two hook names is dispatched by the scene loader, not by this table: there `update` needs play AND running, `editorUpdate` needs edit, and play-paused ticks neither. Read `man scenes` before carrying a component's rule to an entrypoint. ## Authoring conventions - Annotate public fields with `--!desc` so the inspector + LSP show documentation alongside the field name. - Declare lifecycle hooks (`start`, `update`, `onDestroy`) explicitly rather than relying on engine defaults — readers can see at a glance what runs when. - Keep `update(dt)` cheap — it runs every frame per instance. Move heavy work to `start`, to a `.computeShader`, or behind a job (`man jobs`). - For multi-entity batching, prefer `tools.use("entityOps", "addComponents", targets, components)` over a loop of `entity(id).component.add` — it takes many targets and many components in one call. ## Common pitfalls - **Naming.** The component identity is the folder stem with `.component` stripped (e.g. `<Spinner>.component/` → identity `Spinner`). Don't repeat the suffix in the identity passed to `component.add`. - **`init.lua` vs `init.luau`.** Either is accepted (it's a `one_of_group: "entrypoint"`), but `.luau` is canonical. Mixing both in one folder is invalid. - **`update` in edit mode.** It runs whenever the gameplay clock is running, and entering edit stops that clock — so `update` is idle in a freshly-entered edit session and ticks again the moment anything sets `engine.paused = false`. Use `tools.use("wld", "play")` to test update logic under the mode it ships in; `tools.use("wld", "edit")` to return. See **Per-frame hooks and the two axes** above. - **Renaming.** Renaming the folder changes the identity. References to the component are recorded against the component itself, so renaming or moving it does not break them. ## Related types - `.module` — pure-function library, no per-entity state. - `.service`: a declarative content generator, no per-entity state. - `.preset` — a captured component configuration, replayable into `component.add` without re-typing fields. - `.bundle` — entity hierarchies that may carry component attachments as part of the bundle. ## In the Inspector Fields: its execution order, hooks, and how many methods and events it declares, then the fields its `public` table declares as read-only typed controls holding their defaults, with **Check** and **Open** for its entry file. Instances: a link to every entity carrying it. What its card shows on an entity comes from the component's own `inspector.luau`.
▲ 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
# 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
# yaml.module YAML decode + encode for authored engine content. Pure Luau, no engine dependencies — a general parsing library, not data-system plumbing. ```luau local Yaml = require("@builtin::modules.yaml") local doc = Yaml.decode(vfs.read(path)) vfs.write(path, Yaml.encode(doc)) ``` ## Supported subset - Block mappings (`key: value`) and block sequences (`- item`), nested to any depth. - Compact sequence-of-mapping entries (`- path: x` / ` kind: y`). - Flow collections — `{ a: 1, b: 2 }` and `[1, 2, 3]` — single line. - Plain scalars with type inference: `~` / `null` → nil, `true` / `false` → boolean, numeric literals → number, everything else → string. - Single- and double-quoted strings (`''` escapes a literal quote inside a single-quoted string; `\n` `\t` `\r` `\\` `\"` inside a double-quoted one). A quote opens a quoted scalar where a scalar begins — after `key:`, after a `- ` entry marker, or inside a flow collection — so a plain scalar carries an apostrophe as data (`note: the world's rules`). Quoted keys are read in flow mappings. - `#` comments — honored outside quotes, so a `#` inside a quoted string is kept as data. - Literal (`|`) and folded (`>`) block scalars, with a chomping indicator (`-` strips the final newline, `+` keeps every trailing blank line, none keeps one newline) and an indentation indicator (`1`-`9`: the content's indent past the parent's), in either order (`|-`, `>+`, `|2`, `>1-`). A block scalar's content is literal text: quotes (balanced or not), `#`, `key: value` and `---` inside it are data. - An optional leading `---` document marker. ## Loud-error contract Constructs outside the subset above raise instead of misparsing: anchors/aliases (`&`, `*`), tags (`!`), directives (`%`), multi-document streams (a second `---`), a block-scalar header it cannot read (`|x`, `|-+`, `|0`), tab indentation, and inconsistent indentation (both block structure and block-scalar bodies). Every error carries the offending line number (`yaml: line N: ...`), so a bad config points straight at the line to fix. Tab indentation is rejected everywhere — including block-scalar body lines whose leading whitespace contains a tab. A tab after the first non-space character of a line is content and passes through. ## API - `Yaml.decode(text: string): any` — decode a YAML document into a Luau value (table, scalar, or nil for an empty document). Raises on malformed input or an unsupported construct. - `Yaml.decodeWithComments(text: string): (any, boolean)` — decode as `decode` does, and report whether the text carries a comment by the decoder's own rule: a `#` at a line's start or after whitespace, outside a quoted scalar and outside a block scalar. Re-encoding the value drops such comments, so an editor that writes a document back reads this first. - `Yaml.encode(value: table): string` — encode a Luau table as YAML (block style, two-space indent, alphabetically sorted keys). Raises on values YAML can't represent (functions, userdata, non-string mapping keys). A top-level empty table encodes to an empty document, which decodes back to `nil` (the YAML empty-document ambiguity).
▲ 0↑ born
▣
module · born here
❒asset
# json JSON encode/decode library for Luau. Encodes Lua values to JSON strings and decodes JSON strings back to Lua values. Used for communication with the Rust side of the engine, the VFS read/write bridge, and any wire-format that needs JSON. Pure Luau, no engine dependencies. Compact and pretty-printed encoders, plus a hand-rolled decoder that streams the input by position so it works under WASM as well as native. ## Exports - `Json.encode(value: any, indent?: string, currentIndent?: string) -> string` — compact encode. Functions / unknown types and NaN/Inf encode as `null`. - `Json.encodePretty(value: any, indentStr?: string) -> string` — pretty-printed encode with sorted object keys (diff-friendly). - `Json.encodeArgs(...: any) -> string` — encode varargs as a JSON array. - `Json.decode(str: string) -> any` — decode a JSON string. Returns the decoded value, or `nil` + error message on failure. ## Usage ```luau local Json = require("@builtin::modules.json") local widget = { type = "button", text = "Click Me" } local compact = Json.encode(widget) -- '{"text":"Click Me","type":"button"}' local pretty = Json.encodePretty(widget, " ") local decoded = Json.decode(compact) local v, err = Json.decode("oops") -- v = nil, err = error message ``` ## Notes - Object keys are sorted alphabetically in both encoders for consistent output across runs. - Numeric keys on objects are stringified at encode time (JSON has no numeric keys). Pure-integer key sets get detected as arrays via `isArray` and encoded with brackets. - NaN, +Inf, -Inf encode as `null` — JSON has no representation. Round trips through `decode` recover `null` (Lua `nil`), so they don't preserve. - Unicode `\uXXXX` escapes decode to UTF-8 by hand to stay WASM-safe. Only the BMP is covered; supplementary planes via surrogate pairs are not. - Functions encode as `null`. - Decode is character-streamed — no regex, no `string.match` patterns on the whole input — so the line-and-column information needs to be reconstructed from the position offset.
▲ 0↑ born
▣
module · born here
❒asset
# assetType runtime The machinery that reads a `<typename>.assetType/behavior.luau` and turns its declarations into live behaviour. A `behavior.luau` is a table of declarations — `ref` methods, `modules` shared code, an `events` schema, a `namePattern`, `refShapes`, and the `onCreate` / `onRegister` / `onChange` / `onDelete` / `validate` / `settingsDefaults` / `settingsCorrections` hooks. None of it runs itself. This is the code that runs it, and it lives here because reading a type's declarations is the **assetType type's own behaviour** — the same way `material.assetType` owns what a `.material` does. ## Sub-modules | Module | Reads | Responsibility | |---|---|---| | `ref.module` | `ref`, `modules` | Builds every `AssetRef` envelope, attaches the shared metatable, and dispatches per-type methods and shared modules onto it. Also owns edit-mode write-behind persistence. | | `create.module` | `onCreate`, `namePattern`, `validate` | Backs `asset.create`: resolves the type, checks the name against its pattern, runs `onCreate` (or clones `template/`), and writes the instance. `validate.module` beside it checks a creation `opts` table against the type's `createSchema`. Before running `onCreate`, resolves the type's settings chain (below) and hands the result to the hook as `opts.settings`. | | `settings.module` | `settings`, `settingsDefaults`, `settingsCorrections` | A type's declared settings schema and where its values live (`type.yaml`'s `settings:` block). `Settings.resolveForCreate` layers the schema's own defaults, the type's own `settingsDefaults(name, opts, asked)` hook (a DEFAULT the schema can't express — a name-derived convention, a fact read off a payload the caller handed it, a value following a field `asked` shows a higher layer naming; any later layer overrides it), the Preset Manager, an importer's settings, the caller's `settings` table, then the type's own `settingsCorrections(values, name, opts)` hook (a CROSS-FIELD CONSTRAINT the schema can't express, applied last over the fully merged values). A correction over a default/preset/importer value lands silently; a correction that would override what the caller's own `settings` table explicitly asked for refuses the creation instead, naming the field and why. Neither hook is ever handed a table to mutate; each returns what it wants changed (`settingsCorrections` may also return a `{ [field]: reason }` table for that refusal message). `Settings.cloneValues` deep-copies a values table — `create.module` hands `onCreate` a copy, never the table it stamps. `Settings.valuesOf` / `writeValues` read and write an asset's own values file. | | `typeYaml.module` | `type.yaml` | The folder a type lives in and its parsed `type.yaml`, decoded once per content version of the file. `settings.module` and `inspector.module` read their blocks through it. `about` / `aboutAt` read a type's `about.yaml` (`intent`, `function`, `usage`), leaving out any key that is empty or still starts with `[[describe]]`; `aboutRows` and `aboutMarkdown` lay the texts out for the Inspector and the `types/<name>` guide. | | `inspector.module` | `type.yaml`'s `inspector:` block | Which inspector a type declares for its assets (`inspector: { type: ... }` or `{ instance: ... }`), and the declaration that file returns — the sections it adds, the generic ones it replaces, and their order — or the problem that kept it from loading. | | `onRegister.module` | `onRegister` | Fires an instance's once-only registration hook — on arrival, on world load, and for `@builtin` library instances. | | `changeDispatch.module` | `onChange`, `onDelete`, `refShapes` | Routes a VFS source write or a folder delete to the enclosing typed asset's type hooks. | | `refShapes.module` | `refShapes`, `ref` | Publishes what every `AssetRef<category>` answers to, so a member read on an asset-typed value is checked against that category's real surface. | | `events.module` | `events` | The per-asset event runtime behind `ref.events`. | | `instantiable.module` | `ref.instantiate` | The instantiation contract an asset type opts into: `root` stands the root entity, `place` applies the base placement opts to one the type adopted, and `result` shapes the `(root, idMap)` every `instantiate` returns. Also registers the `sceneInstantiable` field-constraint validator. | | `declaration.module` | `type.yaml` | The type's decoded declaration, read once and held until a write inside an `.assetType` folder; what every question about a type as a whole reads. | | `previewRecipe.module` | `type.yaml` `preview:` | How an instance's `preview.png` is produced: which of the four recipes (`instantiate`, `image`, `surface`, `custom`) the type declares, and what that recipe needs. | ## Reaching it ```luau local rt = require("@builtin::assetTypes.assetType.shared") rt.ref.loadTypeBehavior("material") ``` Fields resolve lazily. The prelude requires the sub-modules directly, in dependency order (`ref`, then `changeDispatch`, `onRegister.install()`, `refShapes.install()`) — a table that required all six on load would take that ordering away from it.
▲ 0↑ born
backing path · systems/globalIllumination.package/baking.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.