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

shared

Cross-tool helpers for the `capture` toolbox. Every tool inside this toolbox can pull these in with `require(".shared")`.

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

shared Module

Cross-tool helpers for the capture toolbox. Every tool inside this toolbox can pull these in with require(".shared").

Purpose

This module holds the small set of helpers that more than one tool in the toolbox needs — typically the ok(value, formatted?) / fail(message, exitCode?) constructors that produce the canonical captureToolResult shape, plus any toolbox-wide parsers, validators, or shared state. Keep it focused: per-tool implementation stays inside each <x>.tool/init.luau (with its own --!desc / --!arg / --!return / --!example annotations).

Usage

local shared = require(".shared")

function M.someTool(...)
    if not ok then
        return shared.fail("reason", 1)
    end
    return shared.ok(value, "")
end

Exports

See init.luau for the full export surface. Typical exports include shared.ok(value, formatted?) and shared.fail(message, exitCode?) for building the toolbox's standard result envelope.

Interface

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

conforms to

zero/source-extract/v2

capture.toolbox/shared.module/init.luau Cross-tool sharing for the `capture.*` toolbox: the monotonic capture-ID counter (so fromPosition / fromEntity / viewport / oneshot all draw from the same sequence and never collide on the spawned camera entity names or render-target handles), the `Transform` module import every capture tool needs for the look-at quaternion math, and the core implementations that multiple tools compose: `fromPosition` (backs `fromEntity` and `viewport`) and `oneshot` (backs `proc.preview` cross-toolbox via `require("@builtin::tools.capture.shared")`). Tools are thin wrappers over these functions — tools call shared module functions, and shared module functions call engine APIs. Also exposes optional `ok` / `fail` result-envelope constructors for any future tool that wants a structured return shape. Existing tools return raw values (output paths, handle tables) for backward compatibility.

drawnPose(id: string) → void

Where the frame draws an entity: its world position and rotation. A camera riding on a body the simulation moves draws from where it sits on the body as the body is drawn, between physics ticks, while its transform (`entity.position`) holds the last tick, so a capture standing where a camera stands reads this to draw the picture that camera draws.

argtypedescription
idstring

landed(path: string?) → Durability

Where the bytes a capture just wrote stand: `durable`, and, when the play shadow took them or they are in `/source/tmp/` scratch, the state, and for the shadow the routes that keep them. A shot taken while play runs, or saved into scratch, succeeds and reads back from the path it names, which is what makes either easy to walk past, so every capture that wrote a file says which happened. Read from `vfs.durability`, so the answer is the one `write_file` and `asset.create` give for the same destination.

argtypedescription
pathstring?

withCaptureDevice(where: string, take: () → void

Preserve the device identity of the requested image through readback. `where` is the call the caller made, which the failure names.

argtypedescription
wherestring
take(

defaultRenderLayers(source: string?) → string

The render-layer include spec a capture uses when the caller gives none. Every default drops `EditorUI` and `debug`: the human editor's chrome and the debug-visualisation overlays (gizmos, light and probe icons, frustums, collider and bounds wireframes) are authoring aids rather than scene content, and several of those categories are on by default in edit mode. What separates the two defaults is which KIND of source aimed the shot, read from `M.CAMERA_SOURCES` and `M.FRAMING_SOURCES` — the one vocabulary that says what each spelling means. A camera source (`M.isCameraSource`) names a camera the scene already holds, so the spec this returns for one keeps content `ui`: a camera that draws a HUD draws it here, and an agent looking through the scene's own view sees the UI it is building. A framing source names a subject to build a view of, so the spec this returns for one drops `ui` as well, since a screen-space overlay is unrelated to the thing being framed. Every spelling of one view therefore resolves one spec: `main`, `viewport` and `gameplay` name the same scene camera and are the same picture. The four camera sources that reach here are `viewport`, `main`, `gameplay` and `editor`. `screen` and `camera` are camera sources too, but a capture aimed with either carries the spec of the camera it mirrors — resolved by `M.screenLayers` / `M.cameraSceneLayers` before this is consulted — so each holds content `ui` exactly when that camera's own spec holds it. And a `ui_window` capture paints one Window into a target of its own, which `M.oneshot` answers before a camera is built. Passing an explicit `renderLayers` (e.g. `"all"`) overrides this for the one call — which is also how to capture the overlays deliberately, without mutating the engine-wide debug state every other viewer of this engine shares.

argtypedescription
sourcestring?

environmentFields(opts: any) → void

The lighting-environment fields this capture's camera carries, read off the opts that named them. A capture stating nothing renders under the scene's own lighting, which is what every capture did before an isolated one could be asked for. One stating `"isolated"` carries the background and ambient it named, and the camera is then lit by the lights its render layers admit and by nothing else. Both camera-building paths below read this, so a frame photographed through either is lit the same way.

argtypedescription
optsany

diagnosticRenderLayers(channel: number?) → string

The render-layer include spec a DIAGNOSTIC capture uses when the caller gives none and the pass names no view of its own. A pass that replaces the shaded image with a buffer is read flat, so the sky that would paint its own colour behind that buffer comes off alongside the UI and the authoring overlays every capture default drops. The post-process chain comes off too, through `M.diagnosticPostProcessing` — it is a camera property rather than a layer, so this spec cannot name it. A capture view that declares its own `renderLayers` states a stronger requirement than this and is used instead.

argtypedescription
channelnumber?

diagnosticPostProcessing(channel: number?) → boolean

Whether a capture rendering the diagnostic channel `channel` runs the post-process chain, for a caller who stated nothing about it. A diagnostic buffer's RGB is the reading — a normal is `xyz * 0.5 + 0.5`, a shadow factor is the share of light that survived — so a chain that grades, tone-maps or blooms it hands back a picture of the reading instead of the reading. Two normals ninety degrees apart both blown to white are the same pixel. The lit frame keeps the chain, since a final frame graded is what the frame is.

argtypedescription
channelnumber?

cameraSceneLayers(spec: any) → string

A specific camera's own include spec, with the editor's overlay layers taken off the end. `EditorUI` and `debug` are drawn for whoever is authoring — the menu bar, the gizmos, the light and probe icons, the frustum and collider wireframes — rather than by a camera into the world, so mirroring a camera renders what it draws of the scene and leaves those out. Every other layer the camera names is kept, including content `ui`: a camera that draws a HUD draws it here too. The exclusions go last because the spec applies left to right, so they come off whatever the camera's own tokens had put on. An empty spec means every layer, and `!name` on its own has nothing to subtract from, so it is spelled out first.

argtypedescription
specany

screenLayers(spec: any) → string

The include spec the on-screen image is drawn under: the camera holding the viewport, spelled exactly as it carries it. The viewport admits geometry AND screens by that one mask — the editor's chrome sits on `EditorUI` and authored screens on `ui`, and each paints only where the mask keeps its layer. Reproducing the screen is therefore reproducing this spec verbatim: an editor camera drawing `"all !ui"` puts the menu bar in the image and leaves the authored screens out, exactly as the human sees it. An empty spec means every layer, and the tokens are read left to right, so it is spelled out as `all`.

argtypedescription
specany

mirrorCamera(srcCam: any, opts: any, role: string) → void

Carries what a scene camera draws onto the options of a capture that renders through it, in place, wherever the caller left a property unstated, and returns which lens properties came from the camera. `srcCam` is the camera's `Camera` component, `opts` the capture's options, and `role` how the capture reached that camera: `"camera"` for one named by ref, `"active"` for the one holding the viewport, anything else for the scene camera or the editor fly-cam. The lens is the camera's whole lens: `fov`, `near`, `far`, and the `projection` it builds with the `orthoHeight` an orthographic one covers, so the capture of an orthographic camera covers the world-space height that camera's own frame covers. The lighting environment is the camera's too: an `isolated` camera is lit by the lights its layers admit over the background and ambient it states, so the capture carries those. A camera named by ref or holding the viewport also decides which layers are drawn and which buffer is shown, so its render-layer spec and its `debugChannel` are carried as well; the screen takes its spec verbatim, because the viewport's mask is what admits the editor chrome, and a named camera takes it with the authoring overlays off, since those are drawn for whoever is editing rather than by that camera into the world. The returned table names, for each of `fov`, `near`, `far`, `projection` and `orthoHeight`, whether the value is the camera's. A time collage re-reads the camera each cell and takes those, while a value the caller stated is theirs for the whole sheet.

argtypedescription
srcCamany
optsany
rolestring

renderLayerSpecError(spec: any) → string

The reason a render-layer include spec cannot be resolved, or `nil` when every token in it does resolve. The interner refuses some names and caps the rest at 32 layers per world, and a Camera resolves its spec inside `awake()` — where a raise disables the component and leaves the entity carrying a camera the renderer never received. Resolving the spec here, before a capture spawns anything, turns that into this call's error, carrying the interner's own account of the name and what to write in its place. The token grammar matches the Camera component's: a bare `all` seeds every layer and names none, `!name` drops the layer `name`, and any other token names a layer to add.

argtypedescription
specany

cameraReachedRenderer(entityId: string) → boolean

Whether the Camera on `entityId` reached the renderer. The renderer draws from the `ecs.Camera` value a Camera component writes in `awake()`. A component whose `awake()` raised keeps its attachment and reads its public fields back unchanged, so the entity answers every question about itself as a camera while that value is absent — and a capture that renders through it reads its target back as the untouched clear colour, a frame that looks like a scene lit to one flat tone.

argtypedescription
entityIdstring

cameraRenderError(entityId: string, where: string) → string

The reason the camera on `entityId` cannot render, or `nil` when it can. Every capture that builds a camera asks this before it reads a frame back, so a camera that could not initialise ends the capture with this message instead of handing over the picture of an untouched render target. `where` names the capture entry point, and the component's own error is read back out of the engine log so the caller gets the account the log carries.

argtypedescription
entityIdstring
wherestring

stillness( ) → Stillness

moved(clock: Stillness) → void

The work moved: the clock starts over.

argtypedescription
clockStillness

stood(clock: Stillness) → void

One more frame passed with the work standing still.

argtypedescription
clockStillness

spent(clock: Stillness, budget: number) → boolean

Whether `budget` frames, and the seconds they stand for, have passed with the work standing still.

argtypedescription
clockStillness
budgetnumber

buildPool( ) → void

Where the build pool stands, as `renderer.pipelineCache()` reports it: the builds it has finished since the engine started, refused ones included, and the builds it has been handed and not yet finished. The finished count rises whenever any build lands, which is the pool moving even while the number in flight stands still because new requests replaced the finished ones. A build handed to the pool and not finished is compiling, or queued behind one that is, and ends in a pipeline or a refusal however long the host takes to compile it, so a wait spends no patience while one runs.

renderMark( ) → number

The observation frame a render issued now will be reported after. Read immediately BEFORE a render is queued, and handed to `M.renderRefusal` afterwards, so the answer that capture accepts comes from a frame drawn after the request rather than from the snapshot that was already published when it was made.

renderedFrame(camId: string, rtHandle: string, mark: number, where: string) → void

Which renderer frame the target a capture is about to read back was drawn on, or the reason there is no such frame. A capture renders through an offscreen camera and then copies that camera's render target to the CPU. The copy answers whether the texture exists, not whether anything was drawn into it: a render the engine dropped — a request whose camera it could not resolve, a submission the device refused — leaves the target holding what it held before, and the copy hands that back as the picture of the scene. `camera.observe` carries the renderer's own answer for each camera on the frame it drew: whether it rendered, into which target, and which one cause applied when it did not. Asking it here is what makes a capture that has no frame say so instead of returning one. The frame number this returns is that same answer read forwards: the observation that cleared the guard names the frame the picture came from, so a caller holding two captures can tell one frame drawn twice from two frames that happen to look alike. `mark` is strictly below it, so consecutive captures carry strictly increasing frames. `mark` is the frame counter read by `M.renderMark` before the render was queued, so the render this waits for is the one the caller asked for: a receipt into `rtHandle` taken after that mark. A camera that drew into some other target is not read as having filled this one. The wait spends frames on the states that are a moment — the render queued and not yet run, and the render the engine is holding behind pipeline builds — and ends at once on a cause no amount of waiting changes. Which frame the render lands on is the engine's to decide and nobody else's: a shader compiling on a cold engine puts it a frame or several later than one on an engine that has drawn that material before, and a capture that took the next frame for the only acceptable answer made every caller retry through that difference. Pending builds remain part of the captured frame and its receipt.

argtypedescription
camIdstring
rtHandlestring
marknumber
wherestring

reportNow( ) → any

This camera on the newest observation, or nil while the renderer has published none or has published one without it.

pendingBuildsOn(camId: string, frame: number) → number

The pipeline builds the frame `frame` of camera `camId` was drawn without, read off that frame's own render receipt. Zero when the receipt names none, or when the camera holds no receipt for that frame.

argtypedescription
camIdstring
framenumber

frameWithBuildsInPlace(camId: string, rtHandle: string, frame: number, where: string) → void

The frame a capture's render landed on, retaken until it is a frame drawn with every pipeline build in place, or the reason no such frame came. A capture's render is drawn on the frame that asks for it, around every pipeline still building, and what those pipelines draw is absent from the picture: a material whose shader is compiling, the sky, a post-process pass. On a cold engine, and on the frames after a scene build or a mode flip brings new materials in, that picture is near black and reads, in every other respect, as complete. The render's receipt names how many builds it was drawn without. While it names any, the capture waits for the renderer's own count of builds in flight (`renderer.pendingWork().pipelineBuilds`) to reach zero, renders the camera into the same target again, and reads that render's receipt, so the frame this answers with is one whose receipt names no build pending. The third return is `getTime()` read as the last retake was queued, which is when the returned frame was taken; it is nil when the first frame already named no build pending. The wait is bounded on what the renderer reports. It goes on while the count comes down, the build pool lands builds or the pool holds a build compiling, ends with a refusal naming the builds still pending once `PIPELINE_BUILD_PATIENCE_FRAMES` frames, and the seconds they stand for, pass in which none of those happened, and ends the same way after `PIPELINE_WAIT_CEILING_FRAMES` frames, and their seconds, in all.

argtypedescription
camIdstring
rtHandlestring
framenumber
wherestring

renderRefusal(camId: string, rtHandle: string, mark: number, where: string) → string

The reason the frame a capture is about to read back was not rendered, or `nil` once the renderer reports it drew. `M.renderedFrame` read for its refusal alone, for a caller that wants the guard without the frame the guard cleared on.

argtypedescription
camIdstring
rtHandlestring
marknumber
wherestring

postEffectsInChain( ) → void

The post-process effects that ran over the frame just drawn, in the order the renderer runs them. Read from `postprocess.status`, which is the chain the renderer draws with: an effect is named here when it is registered, enabled, and past the frame its registration was queued for. An effect that is registered but switched off, or still pending, did not touch this frame and is not named.

frameReport(camId: string, frame: number?, sceneTime: number, cpu: any?) → CaptureFrame

What one captured frame IS, read off the camera that drew it and the chain it was drawn through rather than off the request that asked for it. `frame` is the renderer frame the readback was answered by — the identity of the picture. Two captures taken in a row carry strictly increasing frames, so a caller holding two files that match byte for byte can tell a scene in which nothing moved from one frame handed back twice, which the pixels alone cannot say. `sceneTime` is the gameplay clock that frame saw, which the caller reads at the instant it sampled the frame and hands in here: the readback between the two blocks for as long as the copy takes, so the clock standing after it is the one the copy finished under. The rest is what the frame was made under: where the camera stood (`eye`), the lens it framed through (`fov`, or `projection` + `orthoHeight` for an orthographic frame), the render layers it drew (`renderLayers`), whether the post-process chain ran over it (`postProcessing`), and which effects that chain ran (`postEffects`). The last is what separates a subject the light never reached from a lit subject whose frame a lens pass drove to black: every other channel a capture offers describes geometry and materials, and the chain that decided the pixels is otherwise unnamed. `pipelinesPending` is how many pipeline builds the renderer was still waiting on when it drew the frame. A frame is drawn around a pipeline that has not finished building, and what that pipeline would have drawn is absent from it: a subject whose material is still compiling is missing from a picture that reads, in every other respect, as complete. `M.readFrame` retakes such a frame once the builds land, so a frame it hands back reads zero here. `luma` is the tone of those pixels, taken from `cpu` — the frame the caller is about to be handed. A picture can be drawn, shaded and correct and still arrive inside a handful of code values, and neither the image nor any other field here says so: the subject is present, it is simply not separable from what is behind it. `span` and `spread` are the numbers that say it, and a capture carries them because the alternative is that nobody reads them.

argtypedescription
camIdstring
framenumber?
sceneTimenumber
cpuany?

nextId( ) → number

Bump the counter and return the new value. Centralises the increment so individual tools don't need to know the counter's current shape.

publishFrame(rec: any) → void

Hand the frame a capture just made to the feed every watcher reads. `src` is what a viewer draws: a render target's guid when the frame is still on the GPU, the written path when the capture produced a file. The feed holds the newest GPU frame for as long as a viewer is drawing it.

argtypedescription
recany

releaseFrame(camId: any, rtHandle: any) → void

Give up a oneshot's camera and render target. The camera goes; the target goes unless the feed is holding it as the newest frame, in which case it is destroyed on the release of whichever frame supersedes it. This is the one place a oneshot's owner hands its frame back, so the question of who still needs that target is asked once.

argtypedescription
camIdany
rtHandleany

fromPositionImpl(path: (string | CapturePositionOpts) → void

Core implementation behind `capture.fromPosition` — render the scene from a world-space position and return the picture as an image value, writing the PNG to `path` as well when one is named. Spawns an ephemeral camera entity (`__capture_cam_<id>`), triggers one render and reads the render target back before returning; a failed readback or write returns `(nil, reason)` instead. Backs `capture.fromEntity`, which computes a camera position/rotation and delegates here.

argtypedescription
path(string | CapturePositionOpts

fromPosition(path: (string | CapturePositionOpts) → void

`capture.fromPosition` as a caller sees it: the render above, taken under a pinned frame clock when `opts.deterministic` asks for one so two shots of a scene that has not moved come back the same image, and through the share of the air `opts.clearAir` asks for so a surface can be read in its own colour.

argtypedescription
path(string | CapturePositionOpts

subtreeIds(target: any) → void

Whether the engine holds anything to draw for an entity or for something under it. Read on the framing-refusal path: a subject the renderer has yet to measure and a subject with nothing to draw both reach that path with no bounds, and only this tells them apart. Two readings, because they answer at different moments. `ecs.Mesh` is the engine's own record of geometry attached to an entity, so it covers every component that puts geometry there: a Model, a SkinnedModel, the quad a Text3D sizes to its content. It is there on the frame the component lands, before the renderer has measured a bound from it. A Model whose asset reference has yet to register holds no mesh yet, and the component sitting on the entity is what says geometry is on its way. The ids of an entity and everything under it.

argtypedescription
targetany

instancedUnder(target: any) → void

The instanced populations standing in an entity's space or in a descendant's: copies a procedural graph or a script draws by instancing are the subject's geometry as much as a Model under it is.

argtypedescription
targetany

instancedBoxUnder(target: any) → any

The world box of the instanced populations under an entity that are being drawn, read back from where the engine composed them; nil when none are.

argtypedescription
targetany

holdsSomethingToDraw(target: any) → boolean

argtypedescription
targetany

hasOne(e: any) → boolean

argtypedescription
eany

frameBounds(targets: any, opts: { fov: number?, angle: any?, margin: number?, aspect: number?, viewpoint: string?, basis: string?, projection: string?, positionWhenEmpty: boolean? }?) → void

Resolve one OR many targets (ids, names, or entity proxies — in any mix) to their union world-space AABB, then derive an orbit camera that frames the whole thing. The bounding SPHERE of the union AABB is fit to the vertical FOV (plus a small margin), so the subject is fully in frame from ANY orbit angle and at ANY scale — a 1cm prop and a 100m building both fill the shot. Only the orbit direction (`angle` = {yaw, pitch} degrees) is caller-controlled; distance, look-at, near and far come from the geometry. Returns the camera params, or `nil, reason, refusal` when none of the targets have renderable bounds. The third value says WHICH state produced that: "unresolved", "ambiguous", "noGeometry", or "boundsPending", the one a caller can retry, because the subject carries geometry the renderer has yet to measure. `M.frameBoundsWhenReady` waits that one out. This is the data the auto-framing capture stands on.

argtypedescription
targetsany
opts{ fov: number?, angle: any?, margin: number?, aspect: number?, viewpoint: string?, basis: string?, projection: string?, positionWhenEmpty: boolean? }?

frameBoundsWhenReady(targets: any, opts: any, frames: number?) → void

Frame the target(s) the way `M.frameBounds` does, spending frames on the one refusal that is a moment rather than a fault: a subject the engine holds geometry for and whose renderable bounds the renderer has yet to measure. That is the state on the frame the component is added, and a capture spends frames drawing anyway, so the picture waits for the geometry instead of refusing the subject that carries it. Returns what `M.frameBounds` returns. A refusal the waiting cannot change, an unresolved or ambiguous name or a subject with nothing to draw, comes back on the first read, and a subject still without bounds after the wait comes back naming how many frames went by.

argtypedescription
targetsany
optsany
framesnumber?

isPresentedSource(name: any) → boolean

Whether `name` reads a presented frame rather than rendering one.

argtypedescription
nameany

isSource(name: any) → boolean

Whether `name` is one of `M.SOURCES`.

argtypedescription
nameany

isCameraSource(name: any) → boolean

Whether `name` aims at a camera the scene already holds, rather than building one to frame a subject.

argtypedescription
nameany

renderTargetSizeError(width: number, height: number) → string

The message for a raster the engine will not allocate a render target for, or `nil` when the size fits. `renderer.renderTargetLimits()` reports the device's largest 2D texture dimension and how many pixels one render target may hold; a raster past either is refused where the caller named it, with a size it may ask for instead. Every number here is printed with `tostring`, which reads a whole number back as that whole number and a value past the integer range back as itself — so the message names the size the caller asked for.

argtypedescription
widthnumber
heightnumber

viewportPixelSize( ) → void

The viewport's size in PIXELS, which is the size a frame mirroring the screen is rastered at. `ui.screenSize()` measures a different space: the UI layout canvas, in logical points. The engine holds that canvas near a fixed logical width whatever the surface measures and carries the rest in the scale factor, so it reads 1280x720 on a 2560x1440 viewport. `getViewportSize()` reports the pixels the viewport is drawn with, which is what a written file is measured in. A viewport that has not reported a size yet — before the first frame is drawn — falls back to the UI canvas, and then to a 720p frame, so a capture taken that early has a raster to render into.

mirrorsScreen(source: string?) → boolean

Whether a frame from `source` mirrors a camera already drawing the screen, which is what makes the viewport's own pixel size the size that matches it. The camera sources are exactly those frames, so this reads `M.CAMERA_SOURCES` rather than spelling the list a second time: a source added there is a source this answers for. An unstated source mirrors the viewport, which is what `M.oneshot` infers for one.

argtypedescription
sourcestring?

frameSize(source: string?, width: number?, height: number?) → void

The pixel size a frame from `source` is rastered at, given whichever of `width` / `height` the caller pinned. A frame mirroring the screen takes the viewport's own pixels for the dimension left unstated; every other frame takes the offscreen default. One rule, read in two places: the oneshot that allocates the render target, and the collage that has to know how big its sheet will be before it builds the first camera — a cell is rendered at the size the grid gives it, and that size is a division of the sheet's.

argtypedescription
sourcestring?
widthnumber?
heightnumber?

unknownSource(source: any) → string

The message for a `source` that is not in `M.SOURCES`. A source and the option that completes it are separate keys, so `source = "camera=ent_1"` fuses two arguments into one string. When the rejected spelling has that shape and its left side names a real source, say which two keys it splits into rather than only listing the vocabulary again.

argtypedescription
sourceany

resolvePass(name: any) → void

Resolve a pass name to what a camera needs to render it: a built-in debug channel, or the name of a content-registered capture view. The one resolver behind every `pass = <name>` a capture takes — the single frame and every cell of a pass collage alike — so a name means the same thing whichever produced it.

argtypedescription
nameany

awaitView(name: string, v: any) → string

Hold a capture of the view registered as `name` until the view can be drawn, or return why it cannot. `ensure` puts a view's parts in place, and several of them land over the frames after it: an entity spawned for the draw, a render feature that reads the state `ensure` built on its next frame, a material whose shader is still compiling. The render a capture requests is drawn on the frame it is asked for, so a view the capture did not wait for is drawn from what stood before `ensure` ran, which for a view that draws its own geometry is an empty frame. The view's own `ready` says when its draw is in place; the wait is on it, and is bounded on what it waits for moving: while the reason the view gives changes, or the renderer's outstanding work comes down below the least it has stood at under that reason, it keeps waiting, and a reason that stands for `PIPELINE_PATIENCE_FRAMES` frames with no such progress is the answer the capture returns. Only work coming down counts as progress, so a view that never reads ready is refused on that bound in a scene that keeps queueing work. Once ready, the view's declared `warmup` frames are spent, drawn, before the render.

argtypedescription
namestring
vany

passRenderLayers(pass: any) → string

The render-layer include spec the pass named `pass` reads best under: a registered capture view's own declared spec, else the diagnostic default for any other pass than the lit frame. Nil for `final` and for a name that resolves to nothing, which leaves the source's ordinary default in place.

argtypedescription
passany

passSetup(opts: any) → void

Turn the pass a capture names into the settings its camera carries: the channel the frame holds, the layers that channel is read under, and how many frames the pass must already have been live for. Reads `pass` (the shared vocabulary — `"final"`, a built-in diagnostic channel, or a content-registered capture view), `view` (a view named outright), `debugChannel` (the channel by number, for a caller that already holds one), `renderLayers` (a stated spec, which stands over the layers the pass would have chosen) and `postProcessing` (a stated chain state, which stands over the one the pass would have chosen) off `opts`, and returns the settings without changing it. Every capture core resolves a pass here, so a name means the same frame whichever surface was asked for it. A view is made live before it is rendered: its `ensure` builds the feature that draws the channel, and a capture that skipped it would read an empty one. The view is then waited on until it says its draw is in place (`awaitView`), and a view that never does is refused with its reason rather than rendered empty.

argtypedescription
optsany

oneshot(opts: CaptureOneshotOpts?) → void

Core implementation behind `capture.oneshot` — spawn an ephemeral offscreen camera configured from `opts`, trigger one render, and return the handles so the caller can read the render target back synchronously and clean up. Returns immediately (no readback task), making it usable from MCP in edit mode where the task scheduler does not tick. Backs the `capture` MCP tool and `proc.preview` (cross-toolbox, via this shared module).

argtypedescription
optsCaptureOneshotOpts?

__index(_: ?, key: ?) → void

`requestedFrame` reads the render's record: the engine frame the render was scheduled on, absent until a camera whose row was still landing has scheduled it.

argtypedescription
_?
key?

extensionFormat(path: string?) → string

The encoding a file extension asks for, or nil when the path names neither of the two this toolbox encodes.

argtypedescription
pathstring?

parseGrid(s: string?) → void

Parse a `"COLSxROWS"` grid string (e.g. `"3x3"`, `"4x2"`) into (cols, rows). A malformed string returns 1, 1.

argtypedescription
sstring?

viewpointList(value: any) → void

Read a viewpoint list stated as an array, a space-separated string ("front top left", the convention layer names already use), or the keyword "sides" — the six axis views.

argtypedescription
valueany

setupList(value: any) → void

The stations a `setups` collage varies across: one whole camera set-up per cell, in the order given. A key outside `M.SETUP_FIELDS` (plus `label`, the name that goes on the cell) is refused where it was written. A set-up is the shape a single capture takes, and a misspelling read as an absence renders a shot the caller never asked for and reports it as the one they did.

argtypedescription
valueany

collageCells(opts: any) → void

The cells a collage renders, in row-major order. Each cell carries what makes it differ from its siblings, and the label that goes on the result. A cell's station is a viewpoint name (`viewpoints`) or a whole camera set-up (`setups`); station x `passes` is a 2D grid: a row per station, a column per pass.

argtypedescription
optsany

aimCameraAtEntity(camId: string, targets: any, opts: CaptureOneshotOpts) → boolean

Point the capture camera `camId` at the union bounds of `targets` — auto-fit when `opts.distance` is nil, else orbit at the fixed distance. Returns true when the camera was repositioned, false when `targets` have no bounds.

argtypedescription
camIdstring
targetsany
optsCaptureOneshotOpts

presentedCaptureImpl(opts: any) → void

A capture of the frames the engine presented: `source = "presented"` (the game view as finished for the player) or `source = "window"` (the whole presented surface). Read through `renderer.presentedFrames`, so nothing is rendered for it and the frame carries the viewport's real temporal history, camera motion, exposure and render scale. `frames` (1-32, default 1) takes that many presented frames, one every `interval` frames (default 1: consecutive), and lays them out as a grid in the order they were presented. A single frame comes back at the size it was presented at; `width` / `height` resample it, or size the sheet a grid is laid into. Each cell reports what its frame was drawn with.

argtypedescription
optsany

captureImpl(opts: CaptureOpts?) → void

Render one image, or a `mode = "collage"` grid. A collage varies ONE axis across its cells, and says which: `setups` for a cell per whole camera set-up, `viewpoints` for a cell per named view of one subject, `passes` for a cell per render pass, `duration` for a cell per sample over time. `setups` and `viewpoints` are one axis — both say where the camera stands — so a request names one of them, and either crossed with `passes` makes a 2D grid: a row per station, a column per pass. A collage with no axis is refused rather than defaulted to time, which is what taught callers that a collage could only ever be time. Viewport collages create a fresh offscreen oneshot for every cell so each frame resolves the live camera state; so does a cell naming a content-registered capture view, since resolving one also makes that view's render feature live, and so does one whose pass is read under other layers than the camera standing there renders under. A cell asking to stand somewhere the standing camera was not built for — its own set-up, or its own viewpoint — is built a camera of its own through `M.oneshot`, the same path a single capture of that set-up takes, so a shot in a contact sheet is the picture that shot taken alone is. Orbiting one entity is the exception: aiming the standing camera at the cell's viewpoint (and, orthographic, re-fitting it) is the whole of that set-up, so it happens in place. Other cells re-render the camera already standing there. Each frame is read back to the CPU (`renderer.texture.readback`) and, for a collage, blitted into a cell of a `renderer.texture.cpuCreate` canvas. The result is encoded to `format` and returned as an image value: base64 in `data`, its type in `mime_type`. With a `path` — or `save_path`, the name the `capture` MCP tool's schema gives the same destination — the bytes are written there and the path comes back on the result as `path` and as `savedTo`; an unstated `format` then follows the file extension, and `jpeg` when there is no path to read one from. The write fires no write side effects, so the file stays at the name it was given and reads back from it. Returns `(result, nil)` or `(nil, reason)` — a write that failed is the reason, so a result in hand is a file on the path it names.

argtypedescription
optsCaptureOpts?

cellSetup(cell: any) → any

argtypedescription
cellany

cellSource(cell: any) → CaptureSource

Which source a cell's set-up asks for: the one it names, else the one the thing it names implies, else the capture's own. It is the same inference a single capture makes from the same options.

argtypedescription
cellany

cellIsolateTargets(cell: any) → void

The subject a set-up cell shows alone, or nil when the cell is drawn with the rest of the scene. A cell's own `isolate` stands over the collage's, and its subject is the entity it frames: its own `entity` / `entities`, else the collage's when the cell orbits an entity.

argtypedescription
cellany

cellRenderLayers(cell: any) → string

The render layers a cell is drawn under: the capture's, or under isolation the isolate layer over the layers the cell would have been drawn under.

argtypedescription
cellany

isolateCell(cell: any) → string

argtypedescription
cellany

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

Whether two cells ask the camera to stand somewhere different: the viewpoint each names, and each field of the set-up each states. A field holding a table — a position, an angle — is compared by identity, so two set-ups written as separate tables read as separate stations wherever either states one.

argtypedescription
aany
bany

cellTargets(cell: any) → any

The subject a cell aimed at an entity frames: what the cell's set-up names, else what the capture names, read in the order `M.oneshot` reads `entities` and `entity`.

argtypedescription
cellany

makeOneshot(frameWidth: number?, frameHeight: number?, cell: any?) → void

argtypedescription
frameWidthnumber?
frameHeightnumber?
cellany?

cleanupHandle( ) → void

restoreClock( ) → void

withSettledPipelines(shoot: () → void

Take a picture with `shoot`, and take it again when the frame it read back was drawn while pipeline builds were still pending: what such a frame is missing is whatever those pipelines draw, a whole post-process pass among them, which leaves the frame black. The second shot is taken once a frame has been drawn with every pipeline in place (`task.waitDrawnFrames`). When the builds stop coming down, the first picture stands and its `note` names them.

argtypedescription
shoot(

capture(opts: CaptureOpts?) → void

`capture.capture` as a caller sees it: the render above, taken under a pinned frame clock when `opts.deterministic` asks for one so two shots of a scene that has not moved come back the same image, through the share of the air `opts.clearAir` asks for so a surface can be read in its own colour, and again once its pipelines are built when the first frame was drawn without them.

argtypedescription
optsCaptureOpts?

ok(value: any?, formatted: string?) → CaptureToolResult

Build a success result.

argtypedescription
valueany?
formattedstring?

fail(message: string, exitCode: number?) → CaptureToolResult

Build a failure result.

argtypedescription
messagestring
exitCodenumber?
⌬ Types
Durability = Vfs.DurabilityCaptureFrame = {CaptureImage = {CapturePositionOpts = {FramedCamera = {FrameRefusal = "unresolved" | "ambiguous" | "noGeometry" | "boundsPending"CaptureSourceCaptureFrameSourceCaptureOneshotOpts = {CaptureHandle = {PassSetup = {CaptureSetup = {CaptureOpts = {CaptureResult = {CaptureToolResult = {

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.

71+items
·
assettype · born here
❒asset
# Module (asset type) A module is a reusable, stateless (or globally-stateful) Luau library that other code pulls in with `require()`. Modules are the unit of factored-out logic in a world: helpers, math libraries, format parsers, registries, shared algorithms. ## When to use one - You have logic you want to share across multiple components, services, scenes, or tools. - You have a registry, lookup table, or shared cache that callers all read from / write to. - You want a stable API surface (`M.fn`) other code can depend on. If the logic is bound to one entity, use a `.component`. If you want a named UI of fields rather than functions, use a `.preset`. ## Where it lives - Source: `/zero/source/.../<name>.module/` - Identity: the source path with `/` written as `.` and each segment's type suffix dropped — `/zero/source/demo/beats.module` is `demo.beats`, and `/zero/source/kit.package/beats.module` is `kit.beats`, the container's name kept and its `.package` suffix gone. `asset.create` returns this string, `asset.resolve(...).identity` reads it back, and the `require` forms below write it as `<identity>`. - Folder shape: - `init.luau` (or `init.lua`) — module body. **Required.** Returns a table (conventionally named `M`). - `README.md` — instance-level documentation. **Required.** - `.metadata` — agent-editable tags + free-form fields. **Required.** ## How to create one ```luau asset.create("module", "<name>") -- Creates: /zero/source/<name>.module/ -- init.luau (canonical `local M = {} … return M`) -- README.md (instance README template) -- `folder` places it in a subfolder of /source, and that subfolder -- leads the identity: `{ folder = "lib" }` produces `lib.<name>`. -- `into` authors it inside a resolved container (a package, a toolbox), -- whose own identity leads the same way: asset.create("module", "<name>", { folder = "lib" }) asset.create("module", "<name>", { into = asset.resolve("myPkg.package") }) ``` ## How it operates 1. **Registration.** Writing `init.luau` into a `.module/` folder indexes the asset and registers the module path with the resolver. 2. **Loading.** The first `require("<identity>")` runs the file's body and caches the returned table. Subsequent requires from anywhere return the **same table** — this is the shared-state lever for "module-local" registries. The body runs in an environment of the module's own: a name it declares without `local` is readable by the module's own functions and by no other script, so an export reaches its callers through the returned table and nothing else. Requiring a component's folder runs its chunk the same way, once, and its `update`, `start` and `public` stay in that environment; a component runs on an entity through `entity(id).component.add(name)`. 3. **Hot reload.** Editing the file re-runs the module body and folds what it returns into the table already loaded, so that table keeps its identity: a caller that captured it with `require` reads the new source's functions and values through the reference it already holds, and a later `require` returns that same table. A key the new source drops goes away; a key something set at runtime stays. The body's own `local`s start again from their initial values, so state that must outlive an edit lives in `modules.state()` (`guides { path: "core/scripting-and-tasks" }`). 4. **Identity resolution.** A module is reached by its `<identity>`, and where the caller lives decides which spelling of it resolves. For a module in a **world**, from a caller in that same world — another module, a component, a scene entrypoint, or an `execute` chunk: - `require("<identity>")` — the identity on its own, resolved against the caller's own root. It carries every folder segment, so a module created with `{ folder = "demo" }` is `require("demo.beats")`. - `require("@root::<identity>")` — the same root-relative resolution, written out. - `require(".sibling")` — a module in the same folder, by its bare name; `..name` steps up one folder, `...name` two. Logs, stack traces and hot-reload notices name that same module `@local.source.<identity>` — its key under the world source root. The `<identity>` tail of that key is the form above, so a trace reading `@local.source.demo.beats` is `require("demo.beats")`. For a module in a **library** — content under `/zero/source/libs/@<lib>/` — `@<lib>::` addresses that library's root from anywhere: `require("@builtin::modules.transform")`. Mounting a world as a library moves its files under such a root and flips the caller root to `@<lib>::`, which is what keeps the root-relative forms above resolving across the move. ## Discovery - `asset.list("module")` — every registered module. - `asset.inspect("<name>")` — public functions, source path, this type README. - `ls /zero/source/<name>.module` lists the files the folder holds. ## Authoring conventions - Return a single `M` table from `init.luau`. Top-level statements with side effects run on first require — useful for one-time initialization, dangerous if they touch the engine before it's ready. - Write exported functions as `typed function`, not `function`: the argument types are enforced at the call and the checker knows the signature, so a caller's mistake is reported where they made it. - Annotate exported functions with `--!desc` / `--!arg` / `--!return` / `--!example` so the LSP, `tools.list`, and `asset.inspect` surface them. A function with no `--!desc` is reachable only by someone already reading this file. - Declare a VALUE with `Field.<kind>(default, mode, description)`, and a table whose members are reached through a metatable with `--!members <TypeName>` — the latter gives the surface its accepted member set, its type, and its documentation from one table. See `guides { path: "core/authoring" }` for all four rules and `modules/api/engine/entity.module/members.module` for a worked member table. - Keep module state in module-local upvalues or in `modules.state()`. A name the body declares without `local` lives in the module's environment, which every run of the module shares: a function the previous run left in place reads what the reload assigned. Module-locals start again from their initial values with each hot reload; the table `modules.state()` returns is the same table on both sides of every reload. - Prefer focused modules over kitchen-sink modules. If two halves of a module have no shared state, split them. ## Common pitfalls - **Cyclic requires.** A `require` chain that loops will return the partial table (the half built before the cycle was detected). Design for one-way dependencies. - **Engine-time side effects.** Don't `entity.spawn` at module top-level — the engine may not be ready. Expose an `M.init` and call it from a scene entrypoint. - **Hot-reload + module-local cache.** A module that caches expensive computation in upvalues loses that cache on reload — fine for dev, but be aware in performance work. - **`init.lua` vs `init.luau`.** Either works, `.luau` is canonical. - **Writing one while play runs.** A `/source` write made while play is running lands on the play shadow, and a guarded play-exit discards it unless it is kept. One `.module` write shadows `init.luau`, the `README.md` and the `.metadata` together. `vfs.write(path, bytes, { durable = true })` skips the shadow, and `vfs.promotePlayShadow` keeps what is already on it — the `core/vfs` guide has the model and what each route costs. ## Related types - `.component` — for entity-bound state + lifecycle hooks. - `.service` — generates content you don't have yet (a mesh, sound, texture, …) via a metered provider. - `.tool` — for a single agent-callable function with a YAML schema. - `.package` — to group several modules + components + scenes into one shippable folder. ## In the Inspector Exports: what the module exports (name, kind, signature), parsed from its source without running it, with **Check** (the LSP's diagnostics for its entry file) and **Open**.
▲ 0↑ born
▣
module · born here
❒asset
# vfs Module Public Luau surface over the `__vfs` Internal FFI namespace — the engine's virtual filesystem. ## Purpose Wrap the raw `__vfs.*` FFI namespace in a typed Luau table that gets auto-injected as `_G.vfs` via the prelude. The standard read / write / move / remove / mkdir / list / exists / readAsync / reload / evict surface, plus trusted-only `watch` / `unwatch` for the bootstrap VM. `vfs.read` yields on a byte-cache miss: the module's last step installs the `vfs_async_read` fallback over the synchronous read, so every VM that holds this namespace, the trusted VM included, reads a path through the same two steps and gets the same bytes for it. ## Usage ```luau -- Read / write local src = vfs.read("@builtin/components/Camera.luau") vfs.write("/zero/source/notes.md", body) -- What a write landed: where the bytes went, and what the static passes -- read in the Luau among them local ok, report = vfs.write("/zero/source/game/Vent.component/init.luau", code) if report.diagnostics then for _, d in report.diagnostics do print(d.severity, d.path, d.line, d.message) end end if not report.durable then log.warn(report.warning) end -- Listing for _, e in ipairs(vfs.list("/zero/source")) do print(e.isDirectory and "[d] " or " ", e.name) end -- Async fetch local png = task.await(vfs.readAsync("/zero/runtime/screenshots/last.png")) -- Reclaim RAM after processing a big binary vfs.evict("/zero/source/textures/imported_huge.png") -- Reload a module after editing its source on disk if vfs.reload("@mylib/utils.helpers") then local m = require("@mylib/utils.helpers") -- sees the new source end ``` `vfs.reload(identity)` answers whether a module was cached under that name and has now been dropped. A `false` says the name matched nothing — either a misspelled identity or a module this VM never required — so the next `require()` returns whatever it would have returned anyway. A module that caches state derived from OTHER files keeps serving the old value when those files are rewritten, since only its own source is watched. Reload it by identity to make the next `require()` recompute. ## How a write reaches disk A native engine's `vfs.write` returns once the engine holds the bytes. The blob a binary write stores by content and the journal record of the mutation are written by a worker thread (`vfs-io`) in the order the writes were made, so the blob is on disk before the record that names it, and a script that writes a thousand files pays for handing them over, not for the flush of each. A read of a blob still waiting for its file answers from memory, so a write reads back the moment it returns. A queue holding more than its byte budget (256 MiB) makes the next write wait for it and write inline, which bounds the memory the queue pins. The queue is flushed when the engine exits normally; a process killed in the milliseconds between a write and its flush loses that write. `world.syncStatus()` reports nothing owed once the writes have also reached the world. ## Exports - `vfs.read(path, opts?) -> string?` - `vfs.write(path, content, opts?) -> (boolean, WriteReport | string)` - `vfs.move(src, dst, opts?) -> (boolean, WriteReport | string)` - `vfs.copy(src, dst) -> (boolean, WriteReport | string)` - `vfs.remove(path, opts?) -> (boolean, string?)` - `vfs.mkdir(path, opts?) -> boolean` - `vfs.list(path?) -> { VfsListEntry }` - `vfs.exists(path, opts?) -> boolean` - `vfs.readAsync(path, opts?) -> promiseId` - `vfs.reload(modulePath?) -> boolean` - `vfs.evict(path, opts?) -> boolean` - `vfs.mutationSeq() -> number` - Trusted-only: `vfs.watch(path, callback) -> number` / `vfs.unwatch(watcherId) -> boolean`.
▲ 0↑ born
▣
module · born here
❒asset
# feed The newest frame a capture produced on this engine, and who is watching for it. Every capture core publishes here. `latest()` is that frame: a `src` an image widget draws (the render target's guid while the engine still holds it, the written path when the capture produced a file), with the size, the source and the pass beside it. `watch(fn)` calls `fn` as each new frame arrives, and `unwatch(token)` drops the subscription. `shown()` says a viewer is drawing frames from the feed. From then on the feed holds the newest capture's render target so the picture stays up after the capture that made it is finished with it, and lets it go when a later frame replaces it; `shown(false)` stops. With nobody drawing, a capture's target is released the moment its capture is done. The release path asks `retains(rtHandle)` before destroying a target, which is how a held frame survives its own capture. `capture.shared.releaseFrame` is the one place that asks.
▲ 0↑ born
▣
module · born here
❒asset
# isolate Show the subject without the other geometry drawn, then put everything back. A prop inside a built scene is behind whatever stands in front of it. The render-layer system already expresses "draw only these" — an entity is a member of layers, a camera renders a filter over them — but it does not remember what it displaced, so every caller wanting one clean shot of one thing hand-rolls the same record, swap and restore. This is that, once, with the restore guaranteed. ## What it changes Exactly one thing: the other geometry is not drawn. Sky, post-process and UI are left exactly as the capture's own render-layer spec stated them, so a final frame stays a final frame. A caller who wants the geometry read flat — no lighting, no atmosphere — asks for a **pass** (`pass = "albedo"`, `pass = "normal"`), which is what passes are for. ## What it does not change Excluded geometry still **casts shadows** onto the subject and still bounces light into it. Lights are not filtered by render layer at all, and the layer mask drives object culling and the geometry passes rather than the shadow passes. This is the render-layer system's deliberate behaviour — a wall stays out of the shot while it still exists for lighting, shadows and physics — so a shadow with no visible caster in an isolated capture is the system working, not a bug. ## The layer One reserved layer name, `captureIsolate`, reused by every isolated capture. Membership is a 32-bit mask with six reserved bits. A layer minted per call would exhaust the namespace in twenty-six captures and leave a trail of empty layers that `renderLayer.list` would show forever. ## Restoring `begin` records each affected entity's membership before moving anything, so the token describes the whole subtree even if the move fails part-way. `restore` puts every entity back to the layers it carried — and an entity that carried **no** explicit membership ends with none, rather than an explicit `default` that looks identical in a picture and different in the data. `restore` is safe to call twice and safe on a token whose subjects have since despawned, which is what lets a caller restore unconditionally on every exit path: success, failure, and once around a whole collage grid rather than between its cells.
▲ 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
# viewpoints The named camera stations a capture can be taken from, and the rule that decides what a name like `front` means. A **viewpoint** is a direction with an image-up: where the camera stands relative to what it is looking at, and which way is up in the resulting picture. Naming one replaces reverse-engineering a `{yaw, pitch}` pair, and names the seven stations that answer "is this built correctly" — the six sides and the corner. | Viewpoint | Sees | |-----------|------| | `front` | the side the subject faces | | `back` | the opposite side | | `right` | the subject's right | | `left` | the subject's left | | `top` | plan view, the subject's front toward the top of the image | | `bottom` | the underside | | `iso` | the corner view where all three axes project equally | An entity faces its local -Z, so the camera that sees its front sits on its +Z. `top` and `bottom` take their image-up from the subject's forward axis, because world up is undefined when you are looking straight down it — that is what puts the subject's front at the top of a plan view instead of leaving the roll to whatever the yaw happened to be. ## Basis `basis` says which axes the name is measured against, and it has **no default**: - **`"local"`** — the subject's own axes. `front` is the side the subject faces, whichever way it is turned, and the frame is fitted to the subject's own extents (`entity:orientedBounds()`). - **`"world"`** — the world axes. `front` is the side facing world +Z, whatever the subject is doing. For a crate turned 40 degrees these are different pictures, so the caller states which one it wants. A default would mean one call site's `front` is the crate's front and another's is the world's, and the difference only shows up in the image. With no subject to take axes from — a capture framed on a world position rather than an entity — both values mean the world axes, and both are accepted. ## Orthographic size `orthoHeightFor` answers the question an orthographic frame asks that a perspective one does not: how big is the frame? A perspective camera backs off until the subject fits; an orthographic camera does not converge, so its size is decided by the subject alone — project the bounds' eight corners onto the camera's up and right axes and take whichever needs more room. Its `half` extents and `axes` must be stated in the same frame. A resolved viewpoint carries both: `frame` axes to use with local-frame extents, and its world axes to use with world extents.
▲ 0↑ born
▣
module · born here
❒asset
# frame_bounds Bounds union and exact frustum fitting — the math behind "put this subject in frame". `fit` solves for the camera distance that keeps every corner of a box inside the frustum at a given orbit angle. That is exact for any shape at any angle, which a circumscribed sphere is not: a sphere frames the DIAGONAL of the box from every direction, so a 14 x 0.5 x 14 plate backs the camera off nearly 1.4x further than its silhouette needs. Two consumers share this one implementation: the capture toolbox's framed shots and editor frame-selection. Toolboxes are self-contained and never cross-require, so the math lives here as a module rather than inside either. ```lua local FrameBounds = require("@builtin::modules.frame_bounds") local box = FrameBounds.union({ FrameBounds.ofEntity(entity.find("player")), FrameBounds.ofEntity(entity.find("prop")), }) local framed = FrameBounds.fit(box, { fov = 60, aspect = 16 / 9, angle = { 0, 20 } }) -- framed.px/py/pz is where the camera goes, framed.cx/cy/cz is what it looks at. ``` ## Exports - `FrameBounds.union(boxes) -> Aabb?` — the AABB enclosing every box in the list. `nil` when the list is empty (or holds nothing with `min`/`max`), which is the signal that there is nothing to frame. - `FrameBounds.ofEntity(target) -> Aabb?` — world-space bounds of an entity and its descendants (`hierarchyBounds`, covering a character root plus its skinned mesh and bones), falling back to the entity's own mesh `bounds`. `nil` when the target has no renderable geometry. - `FrameBounds.fit(box, opts?) -> Framed` — a camera pose that frames `box`. `opts` is `{ fov = 60, aspect = 16/9, margin = 1.15, angle = { yawDeg, pitchDeg } }`; `angle` also accepts `{ yaw = , pitch = }`. Returns `{ px, py, pz, cx, cy, cz, distance, radius, fov, near, far, center, size }` — camera position, look-at point (the box centre), the fitted distance, the bounding-sphere radius, geometry-derived near/far clip planes, and the box's centre and full size. A degenerate (point) box gets a short fixed distance so the camera is not sitting inside the subject. - `FrameBounds.fitDistance(hx, hy, hz, dx, dy, dz, tanH, tanV) -> number` — the corner projection itself: the smallest distance along the orbit direction `(dx, dy, dz)` (subject toward camera, unit length) that keeps all eight corners of the half-extent box inside a frustum with half-angle tangents `tanH` / `tanV`. `fit` applies `margin` to this; call it directly when you already have a direction and want the raw fit.
▲ 0↑ born
▣
module · born here
❒asset
# transform Math helpers for positions, rotations, and directions on transforms. Exposed as the global `Transform` table via `--!global Transform` — no explicit require needed in user code. Functions that take an entity accept either an entity ID string or an entity proxy table from `entity("id")`. ## Exports Look-at and entity-aware helpers: - `Transform.lookAtQuat(fx, fy, fz, tx, ty, tz) -> (qx?, qy?, qz?, qw?)` — quaternion from origin toward target. Nil when degenerate. - `Transform.lookAt(entity, txOrTarget, ty?, tz?) -> (boolean, string?)` — make an entity face a world position or another entity. Both slots read world space: the subject and an entity target are read as `entity(id).position` and the aim is written as `entity(id).rotation`, so a parent under either one still leaves the aim on the point named. Returns whether the rotation was written, and the reason when it was not. - `Transform.distance(x1, y1, z1, x2, y2, z2) -> number` — Euclidean distance between two points. - `Transform.distanceBetween(entityA, entityB) -> number?` — distance between two entities' world positions. Nil when either is unresolvable. - `Transform.direction(fromX, fromY, fromZ, toX, toY, toZ) -> (dx, dy, dz)` — unit direction vector. - `Transform.directionBetween(entityA, entityB) -> (dx, dy, dz)` — unit world-space direction between two entities' world positions. Rotation shapes: A quaternion **constructor** here returns the four components as four separate values, so a caller either names them or braces the call to make one table: ```lua local qx, qy, qz, qw = Transform.quatFromAxisAngle(0, 1, 0, math.rad(90)) entity("cam").localRotation = { Transform.quatFromAxisAngle(0, 1, 0, math.rad(90)) } ``` A rotation-taking **surface** reads that table through `Transform.toQuaternion`, which also takes euler DEGREES — so `{ qx, qy, qz, qw }`, `{ x =, y =, z =, w = }`, `{ pitch, yaw, roll }` and `{ pitch =, yaw =, roll = }` all mean the same thing wherever a rotation is assigned: `entity(id).rotation` / `.localRotation`, `entityOps.spawn`, `entityOps.transform`, and the capture viewpoints. - `Transform.toQuaternion(rotation, label?) -> { qx, qy, qz, qw }` — the shared reading of a rotation a caller wrote. Raises when the value matches no form, naming what arrived; a value that is one of the shapes a quaternion helper returns is named as such along with the packing it goes in as. - `Transform.tryQuaternion(rotation, label?) -> ({ qx, qy, qz, qw } | nil, message?)` — the same reading without raising, for a surface that wants to raise the message at its own caller's line. - `Transform.readVec3(value, label?) -> { x, y, z }` — the same for a vector. - `Transform.snapVec3(v, step) -> { x, y, z }` — quantize a vector to a step grid. Quaternion construction / conversion: - `Transform.quatFromYaw(yaw)`, `Transform.quatFromYawPitch(yaw, pitch)`, `Transform.quatFromAxisAngle(ax, ay, az, angle)` — quaternion constructors. - `Transform.quatIdentity()` — identity quaternion. - `Transform.euler(qx, qy, qz, qw) -> (yaw, pitch, roll)` and the named alias `Transform.quatToEuler`. - `Transform.eulerToQuat(yaw, pitch?, roll?)` — euler-to-quaternion in YXZ order. Lerps and interpolation: - `Transform.lerp(ax, ay, az, bx, by, bz, t) -> (x, y, z)` — vec3 lerp. - `Transform.lerp1(a, b, t) -> number` — scalar lerp. - `Transform.normalizeAngle(a) -> number` — wrap angle into `[-pi, pi]`. - `Transform.lerpAngle(a, b, t) -> number` — shortest-arc angle lerp. - `Transform.slerp(ax, ay, az, aw, bx, by, bz, bw, t) -> (qx, qy, qz, qw)` — quaternion slerp with shortest-path and near-parallel fallback. Quaternion operations: - `Transform.quatMul(...) -> (qx, qy, qz, qw)` — `qa * qb` composition. - `Transform.quatInverse(qx, qy, qz, qw) -> (qx, qy, qz, qw)` — inverse (= conjugate for unit quats). - `Transform.quatRotateVec(qx, qy, qz, qw, vx, vy, vz) -> (x, y, z)` — rotate a vec3 by a quaternion. Pose helpers: - `Transform.orbit(centerX, centerY, centerZ, radius, height, angle) -> (x, y, z, qx, qy, qz, qw)` — orbital pose facing the center. - `Transform.worldToLocal(...)` / `Transform.localToWorld(...)` — pose-space conversions. Nested `Transform.vec.*` namespace (component-wise vec3): - `Transform.vec.add`, `sub`, `scale`, `dot`, `cross`, `length`, `normalize`. Types: - `Vec3 = { x: number, y: number, z: number }` - `EntityRef = string | { entityId: string }` ## Usage ```luau -- Look-at by coordinates or by target entity: Transform.lookAt("cam", 0, 1, 0) -- an entity target resolves to that entity's world position local aimed, why = Transform.lookAt("cam", "box") -- Orbit pose around a point: local x, y, z, qx, qy, qz, qw = Transform.orbit(0, 1, 0, 5, 2, t) entity.find("cam").localPosition = { x, y, z } entity.find("cam").localRotation = { qx, qy, qz, qw } -- Quaternion math: local qx, qy, qz, qw = Transform.quatFromYawPitch(math.pi / 4, 0) local sx, sy, sz, sw = Transform.slerp(0, 0, 0, 1, qx, qy, qz, qw, 0.5) -- Component-wise vec3 helpers: local nx, ny, nz = Transform.vec.normalize(1, 1, 0) ``` ## Notes - The `--!global Transform` directive promotes the module's typed functions onto the runtime universe's globals bucket, so `Transform.*` is available without any per-source `require`. - Entity-aware functions (`lookAt`, `distanceBetween`, `directionBetween`) report a missing entity or a missing transform in their return value rather than raising: `lookAt` answers `false, "unresolved"` / `"no-transform"` / `"incomplete-target"` / `"degenerate"`, `distanceBetween` answers `nil`, and `directionBetween` answers zeros. - Quaternion APIs operate on raw `(qx, qy, qz, qw)` tuples for parity with the entity proxy's `localRotation.get`/`set`. Use `Transform.quatIdentity()` rather than hand-rolling `(0, 0, 0, 1)`. - `Transform.slerp` flips the second quaternion if `dot < 0` to take the shortest path, and falls back to lerp+normalize when the inputs are within `dot > 0.9995` to avoid `1/0` near-parallel issues.
▲ 0↑ born
◇
component · born here
❒asset
# Camera Manages viewport priority, render-to-texture, and capture. State is stored in the native `Camera` ECS component; the Rust camera system handles render scheduling and render targets. Public fields: `fov`, `near`, `far`, `priority`, `textureHandle` (the guid of the texture the camera renders into; empty = main viewport), `renderLayers` (which render layers this camera draws — a space-separated spec of names, e.g. `"all"`, `"all !ui"`, or `"default sky"`; `ui`/`sky`/`debug`/`EditorUI` are built-in layers), `postProcessing` (whether this camera runs the post-process chain), `debugChannel`, plus the behavior slot below. Methods: `:lookAt(target)` (entity id string OR `{x, y, z}` table), `:render()`, `:capture()`, `:setTargetTexture(tex?)` (a `renderer.texture.create` handle to render into, or nil for the viewport). ```luau entity(id).component.add("Camera", { fov = 90, priority = 10 }) entity(id).component.get("Camera"):capture() ``` The scene's play-mode camera is reached as `layers.active.camera`, a handle that reads and writes the fields above on whichever entity currently carries them. `layers.active.camera.entity` is the entity ref for that camera and `layers.active.camera.entityId` its id string, so a script that needs to attach something to the camera — an `AudioListener`, a child entity — goes through the ref: ```luau local cam = layers.active.camera cam.fov = 70 -- the camera's settings cam.entity.component.add("AudioListener") -- the entity carrying them ``` ## How the camera moves: `behavior` and `follow` A `Camera` does not move itself. `behavior` names a component that does, and setting it attaches that component to this entity. Clearing it detaches whatever was attached. ```luau local cam = entity(id).component.get("Camera") cam.behavior = asset.ref("@builtin::controller.orbital_follow", "component") cam.follow = playerBody ``` The attached behavior is an ordinary component on the camera's entity, so it is tuned the way any component is: read it with `component.get` and set its fields there. A `component.add` of the same type configures the instance the slot attached instead of adding a second one: the values it passes are written onto that instance and its proxy is returned. That add is the form a scene `build.luau` tunes the behavior with, because its values are saved with the scene and the loaded Camera's behavior takes them back. A key the component reads only as it is created (one of its `initKeys`, a private field) refuses the add and names the key. ```luau cam.behavior = asset.ref("@builtin::controller.third_person_follow", "component") local rig = entity(id).component.get("third_person_follow") rig.cameraDistance = 6 -- the same, as an add of the type the slot attached entity(id).component.add("third_person_follow", { cameraDistance = 6 }) ``` `follow` is the standard slot every shipped behavior reads. Set the follow target on the **Camera**, not on the behavior, so swapping behaviors keeps it. A behavior that finds its own `follow` field empty falls back to this one, which is what lets a rig keep tracking the player across a behavior swap. `followResolves` answers whether that slot names an entity that is live — `true` while it names a live one or names nothing at all, `false` once the target is despawned or the id names no entity. A rig whose target does not resolve holds its last pose, and this is the field that tells it from a rig posed correctly on a subject that has not moved. `camera.get` carries the same value beside `follow`, and a write naming an id with no entity behind it draws a warning where it lands. ```luau cam.followResolves -- false once the followed entity is gone tools.use("camera", "get", id).followResolves -- the same answer off the tool ``` The shipped behaviors live under `@builtin::controller.*`: `orbital_follow`, `third_person_follow`, `first_person`, `free`, `orbit`, `chase`, `isometric`, `rts`, `birds_eye`, `side_scroller`, `cinematic`, `menu`. ## Writing your own Any component can be a camera behavior. Write one that moves its own entity and attach it the same way: ```luau cam.behavior = asset.ref("MyChaseCam", "component") ``` `follow` lives on the Camera, so a behavior gets no property notification of its own when the target changes. Declare `onFollowChanged(newFollow, oldFollow)` to be told the moment it does — the Camera calls it on the component it attached, which is what lets a rig re-pose on the new subject at once. A behavior that reads `Camera.follow` on its own schedule declares nothing and is attached the same way. ```luau typed function public:onFollowChanged(newFollow: any, oldFollow: any) -- pose this entity against the new target end ``` To make it appear in the discovery catalog alongside the shipped ones, declare the `cameraBehavior` tag in the component's `.metadata`: ```json { "tags": ["cameraBehavior"] } ``` The tag governs **discovery**, not attachment. A tagged component is listed by `layers.active.camera.behaviors` and is what tooling offers when something asks "which camera behaviors exist"; an untagged component attaches just as well and simply stays out of that list. Tag the ones you want other people (and agents) to find. ```luau for name, ref in pairs(layers.active.camera.behaviors) do print(name, ref.identity) end ``` ## Texture colour space `textureColorSpace = "display"` applies the display transform when rendering into a texture. `"linear"` writes scene-linear values instead. `postProcessing` independently controls the effects chain in either mode. Floating-point targets retain values above one; normalized targets clamp to their representable range. The main viewport uses display encoding.
▲ 0↑ born
▣
module · born here
❒asset
# subject What a capture of an entity is a picture of. Every path that frames or isolates an entity (`fromEntity`, `oneshot`, a `setups` or `viewpoints` collage, `isolate`) resolves the name, id or proxy it was given here, so they agree on which entity a name means. ## A player is drawn as its body A player identity (an entity carrying `UserIdentity`) is the registry anchor a connected user is known by. The player is drawn as the body its `avatar` names, a standalone entity at the scene root, so a capture of an identity frames and isolates that body. In play, a player prototype's spawn turns the prototype's copy into the joining user's identity under the prototype's own name and stands the body it names at the spawn point. A capture of the name an author gave their player prototype therefore frames the player's body in play, and the prototype's subtree in edit. ## What a refusal names `describe(target, via)` is the phrase a framing refusal uses for each subject it looked at: the entity's name and id with the number of descendants it holds, and the player identity it is the body of when it was reached through one, or, for a player identity with no live body bound, that the body is missing. | Function | Returns | |----------|---------| | `resolve(t)` | the entity a capture pictures for a name, id or proxy (nil when none matches), and the player identity it was reached through | | `bodyOf(target)` | the live body a player identity is drawn as, or nil | | `isPlayerIdentity(target)` | whether the entity carries `UserIdentity` | | `describe(target, via)` | the refusal phrase for one resolved subject |
▲ 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
▣
module · born here
❒asset
# physics Convenience wrapper around the `__physics` FFI namespace. Covers raycasting, force / impulse / torque application, velocity reads and writes, body-property mutators (mass, damping, body type, locks), collision groups, joints, constraints, colliders, wheel-collider helpers, and the observation reads that report what the solver holds for a body and why it is not moving it, in one consistent surface. Exposed as the `Physics` global via `--!global Physics`. ## Exports Queries: - `Physics.raycast(origin, direction, maxDistance?, exclude?) -> table?` - `Physics.raycastAll(origin, direction, maxDistance?, maxHits?) -> table` - `Physics.overlapSphere(center, radius) -> table` - `Physics.sphereCast(origin, radius, direction, maxDistance?, exclude?) -> table?` - `Physics.capsuleCast(origin, radius, halfHeight, direction, maxDistance?, exclude?) -> table?` - `Physics.boxCast(origin, halfExtents, direction, maxDistance?, exclude?) -> table?` - `Physics.getGravity() -> vec3` / `Physics.setGravity(g)` - `Physics.getVelocity(entityId?) -> vec3?` / `Physics.getAngularVelocity(entityId?) -> vec3?` Forces / impulses (each accepts either `(vec3)` for the script-context entity or `(entityId, vec3)`; a vec3 may be an `{x, y, z}` table or three loose numbers): - `Physics.applyForce` / `Physics.applyForceAtPoint` / `Physics.applyTorque`: from code that runs inside a step (`Physics.onBeforeStep` / `onAfterStep`, a contact listener, `fixedUpdate`) they act on the next step alone (call once per step); from anywhere else they act over the next frame's simulated time (call once per frame). A continuous force integrates to force times time at any frame rate and tick rate - `Physics.applyImpulse` — one-shot velocity change - `Physics.setVelocity` / `Physics.addVelocity` / `Physics.setAngularVelocity` Step hooks (at the physics tick rate, however many steps a frame runs): - `Physics.onBeforeStep(fn) -> off`: `fn(dt, step)` at the start of every step, after its force reset; a force written there acts on that step, and a read sees the state it starts from (springs, fields, thrusters, controllers) - `Physics.onAfterStep(fn) -> off`: `fn(dt, step)` once the step has run, after its contact events and before `fixedUpdate`; a read sees what that step left - One engine call runs every hook of a side, and a hook ends with `off()` or with the component that registered it Body properties: - `Physics.setGravityScale`, `Physics.setMass`, `Physics.setLinearDamping`, `Physics.setAngularDamping`, `Physics.setCcdEnabled` - `Physics.setBodyType(entityId, "dynamic" | "kinematic" | "static")` - `Physics.setRotationLocks(entityId, x, y, z)` / `Physics.setTranslationLocks(entityId, x, y, z)` Surfaces (what colliders are made of): - `Physics.defineSurface(name, { friction?, restitution?, rollingResistance?, spinningResistance?, tags? })` / `Physics.removeSurface(name)` / `Physics.getSurface(name) -> PhysicsSurface?` / `Physics.surfaces()`: a named material a collider takes by naming it in its `surface` field, and a heightfield per sample through `surfaceLayers` / `surfaceMap` (a terrain's painted layers each collide as their own surface) - `rollingResistance` c: a body rolling on the surface slows at c times gravity on level ground, stopping after v^2 / (2 c g), whatever its mass and shape; `spinningResistance` does the same for a body spinning about the contact normal. Both act through contacts only, so a ball in flight keeps its spin - Per contact friction and restitution combine as they always have (the average), and the two sides' rolling and spinning resistances add, so a ball of none on a floor of c rolls against c - Ray and shape cast hits carry `surface`; contacts, contact points, contact events and `Physics.contactPeak` carry `surface` and `otherSurface`; `Physics.groundContact(entityId, maxSlope?) -> PhysicsGroundContact?` names what a body stands on and the surface under it Surfaces that act on what touches them (collider fields, read by the physics step itself, no script per contact): - `oneWay = { x, y, z }`: the direction, in the collider's own frame, bodies pass through it along; a body meeting it from that side stands on it (a jump-through platform is `{ 0, 1, 0 }`). `Physics.passThrough(entityId, throughId?)` drops a standing rigid body through - `surfaceVelocity = { x, y, z }`: the velocity, m/s in the collider's own frame, its surface moves at along itself while the collider stays put; friction carries what rests on it (conveyor belts, treadmills, escalators). Write the field at runtime to change it - `contactTag = "name"` with `Physics.setContactFilter(tagA, tagB, "ignore" | "sensor" | "solid")` / `Physics.contactFilters()`: a pair of tags passes through each other ("ignore"), reports contacts and pushes nothing ("sensor"), or collides ("solid", every pair the filter does not name) Collision groups & filtering: - `Physics.setCollisionGroups(entityId, membership, filter)` - `Physics.ignoreCollision(entityIdA, entityIdB, ignore?)` Joints / constraints / colliders: - `Physics.addJoint(a, b, opts?)` / `Physics.removeJoint(id)` / `Physics.setJointMotor(id, vel, maxForce)`: joints with limits (`limitMin` / `limitMax`, `swingLimit` / `twistLimit`, `axisLimits`), motors (`motorMode` "velocity" / "position", capped by `motorMaxForce`), joint frames (`axis`, `remoteAxis`), `collideConnected`, and a 6-DOF `kind = "generic"` with `lockedAxes` - `Physics.jointState(id)`: a joint's angle / travel / swing and twist, velocity, whether it is at a limit, and the force its limit and motor applied - `Physics.jointReaction(id)`: the load (the stress) a joint carries as signed vectors, read along the member it holds (`axial` tension positive, compression negative, `shear`, `bending`, `torsion`, a rope's `tension`) and as `load`, the share of the break thresholds it is measured against - `Physics.jointReactions(targets?, opts?)` / `Physics.listenJointLoads(targets, listen?)`: many joints' loads in one call as arrays, and the peak each carried between two reads - `Physics.addConstraint(id, opts?)` / `Physics.removeConstraint(id, index?)` - `Physics.addCollider(id, config)` / `Physics.removeCollider(id)` - `Physics.addWheelCollider(id, config?)` / `Physics.removeWheelCollider(id)` / `Physics.getWheelState(id)` / `Physics.vehicleState(chassisId)`: the wheels under one rigid body make up that body's ray-cast vehicle; the `WheelCollider` component README covers the fields - `Physics.detachWheel(id)` / `Physics.attachWheel(id)`: a wheel comes off its vehicle as a dynamic body of its own (rolling and bouncing with its spin, the vehicle driving on the wheels it has left) and goes back on its mount; a `breakLoad` takes it off by itself, a `solid` wheel is a volume other bodies strike, and `vehicleState` lists the wheels that came off under `detachedWheels` Observation (read off the solver, not off the `Physics` component): - `Physics.observe(entityId?, opts?) -> PhysicsObservation?` — one read of the world, or of one body; `bodies` is an array whose entries each name their own entity - `Physics.worldState() -> PhysicsWorldState` — bodies by type, awake / asleep, colliders, soft bodies, joints, contact pairs and points, gravity, timestep, and the last step's cost - `Physics.softBodyState(entityId, opts?) -> PhysicsSoftBodyState?` — a soft body's particle and cell counts, volume against rest, frame, bounds, sleep state and contacts, the solver simulating it (`solver`: `"constraints"` or `"fem"`), its particles' positions with `{ positions = true }`, the cage a `shape = "mesh"` body was filled with (`cage`: cell size, whether it came from the cache, build time, parts filled and left out), and where the body stands: `status` is `"built"`, `"pending"` (the component stands and the body is built at the start of the next frame, so a read in the call that added it answers this; `waitingFor` names what the build waits on), `"refused"` (`refusal` says why the component was not built) or `"none"` - `Physics.debugLines(opts?) -> PhysicsDebugLines?`: what the physics world simulates beyond collider surfaces, as world-space lines with the data behind them: a soft body's elements coloured by load (`cage`), its free, pinned and attached particles (`particles`), soft-soft contacts (`contacts`), and each `WheelCollider` wheel's suspension ray, travel, tyre and ground contact (`wheels`). `capture { pass = "physics" }` and the edit-mode collider overlay draw these lines; `Physics.softBodyState(id).diagnostics` reads a soft body's inverted cells, self-crossings, element loads (`maxLoad`, `loadedElements`), pinned and attached particles as numbers - `Physics.drawnPose(entityId) -> PhysicsDrawnPose?`: where an entity is drawn this frame (`position`, `rotation`) beside the pose its transform holds (`simulatedPosition`, `simulatedRotation`, what `entity.position` reports). A dynamic body with `Physics.interpolation` on is drawn blended between its last two physics ticks, and so is everything parented under it: `interpolated`, `interpolatedBy` (the body whose blend places it) and `alpha` (how far into the current tick the frame sits) say so. A camera or anything else that has to stay with a moving body on screen reads this - `Physics.bodyState(entityId) -> PhysicsBodyState?` — the mass, inertia, gravity scale, damping, locks, CCD, collision groups, sleep timers, velocities, queued force and torque, colliders, contacts, joints and transform constraints the solver holds - `Physics.whyStill(entityId) -> (string?, string?)` — the one reason the solver is not advancing a body, and the detail behind it - `Physics.stillnessReasons() -> {string}` — every reason `whyStill` can answer with - `Physics.contacts(entityId) -> {PhysicsContact}` / `Physics.touching(a, b) -> (boolean, number, {PhysicsContactPoint})` - `Physics.catchUp() -> PhysicsCatchUp`: how the frame clock kept up with real time: the frames it ran, those that dropped simulated time, owing more than a frame may catch up (`boundSeconds`, from `maxCatchUpSeconds`) or with steps past `maxSubsteps` that fell behind the time they cover (`framesBehind`), and the simulated seconds they dropped, counted since the engine started - `Physics.stepCost() -> PhysicsStepCost?`: the last step's per-stage cost, with the share attributed to soft bodies (`softBodyMs`) and each soft body's part of it (`softBodies`: entity, ms, particles, cells, elements, contacts, substeps, costliest first); a soft body's own read carries its part as `lastStepMs` - `Physics.softBodySettings(changes?) -> PhysicsSoftBodySettings`: the settings every soft body runs under, each trading quality for cost (`maxExtraSubstepRate`, `contactStiffening`, `resweepStrain`, `tangleDetection`, `overlapConstraints`, `recoveryPace`, and the FEM solver's `femTolerance`, `femMaxIterations`, `femMaxDenseDofs`, read by the bodies whose `SoftBody.solver` is `"fem"`); with a table, changes the fields it names, saved as `physics.soft_body_*` world settings and applied from the next tick, and refuses an unknown field or a value out of range by name - `Physics.solverSettings(changes?) -> PhysicsSolverSettings`: the settings the constraint solver runs every step under (`tickRate`, `maxCatchUpSeconds`, `maxSubsteps`, `solverIterations`, `pgsIterations`, `stabilizationIterations`, `warmStartCoefficient`, `warmStartJoints`, `lengthUnit`, `contactFrequency`, `contactDampingRatio`, `staticContactFrequency`, `staticContactDampingRatio`, `allowedLinearError`, `maxCorrectiveVelocity`, `predictionDistance`, `ccdSubsteps`, `frictionModel`, `frictionInBiasPass`); with a table, changes the fields it names, saved as `physics.*` world settings and run by the solver from the next step, and refuses an unknown field or a value out of range by name High-level helpers: - `Physics.raycastBetween(fromId, toId, maxDistance?) -> table?` (ids or proxies) - `Physics.hasLineOfSight(fromId, toId) -> boolean` (ids or proxies) ## Usage ```luau -- `Physics` is auto-injected by the prelude — no require in user code. local hit = Physics.raycast({x=0,y=2,z=0}, {x=0,y=-1,z=0}) Physics.applyImpulse(entityId, {x=0, y=5, z=0}) Physics.addJoint(a, b, { kind = "fixed" }) ``` ## Notes - Most apply/set helpers are polymorphic on the first argument: they accept either an explicit `entityId` (with the value as a second arg) or a value directly (using the script-context entity). - `addJoint` accepts both vec3-style anchor tables (`localAnchor = {x,y,z}`) and pre-split scalar keys (`localAnchorX/Y/Z`); both forms forward as split keys to the Joint component. - `setCollisionGroups` adds the `CollisionGroup` component if missing. - `getWheelState` returns `nil` when the entity has no `WheelCollider` component, and `vehicleState` returns `nil` when no `WheelCollider` sits under the chassis. - The sweeps (`sphereCast`, `capsuleCast`, `boxCast`) report `distance` as how far the shape's centre travels before its surface meets the geometry, and `normal` as the outward normal of the surface it met — the same normal a ray hit carries. - A ray's or a sweep's `direction` may have any length: the engine normalises it, so `maxDistance` and the reported `distance` are world units whatever the direction's length, and a direction of zero length hits nothing. - `exclude` is applied while searching: the first hit `raycast` reports, and every hit `raycastAll` counts toward `maxHits`, is on an entity outside the list, however many excluded colliders lie in front of it. - Every hit table carries `startedInside`, and it says which surface `normal` describes. `false` — the query travelled to the collider and crossed its surface, so `distance` is how far it went, `point` is where it met the surface, and `normal` is that surface's outward normal. `true` — the query's own start already lay inside that collider, so `distance` is 0, `point` is the start itself, and `normal` is the collider's outward surface normal at the surface point nearest the start: the shortest way out of it. `normal` is a unit vector either way, and every collider shape answers an inside start the same way, so a slope read like `math.acos(hit.normal.y)` is meaningful without knowing which shape was hit. - `raycastBetween` and `hasLineOfSight` cast from the source's world position toward the target's world position, wherever each sits in the hierarchy. Each end takes either an entity id or a proxy, and an end naming no entity raises an error naming the argument (`fromId` or `toId`) and the id. - Each end's own colliders hold nothing up: those of the body it rides (its own `Physics` or `SoftBody`, else the body of its nearest ancestor carrying one) and of every entity riding that body, a child collider composed onto it included. `raycastBetween` passes over the source's; with nothing between the pair, its first hit is the target's collider. - `raycastBetween` returns `nil` if the two entities are coincident (< 0.001 units apart). - `hasLineOfSight` returns `true` even when nothing is hit: line-of-sight only fails if a collider belonging to neither end sits between the pair. - The observation reads answer in edit mode as well as play mode. `bodyState` reports `exists = false` with `stillness = "noBody"` for an entity that carries no rigid body, and `nil` only when nothing in the scene answers to that id. - `observe(nil, { bodies = false })` builds the world accounting alone; `{ contactPoints = false }` keeps each contact pair's normal, depth, impulse and point count while leaving out the individual points. - `stepCost` figures cover the one step that ran, so they are already per-step costs; it is `nil` on a frame where the pipeline did not step.
▲ 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
·
toolbox · born here
❒asset
# capture Render a screenshot of the scene from anywhere — an explicit position, a named camera station around an entity, a specific camera, or a mirror of the active viewport — and a grid of them in one image; or read back the frame the engine actually presented, exactly as the player saw it. The picture of the machine's own camera (a webcam, a phone camera) is `cameraInput`, covered by the `topics/camera-input` guide; this toolbox photographs the scene. Every source but `presented` and `window` (see [The presented frame](#the-presented-frame)) spawns an ephemeral offscreen camera, triggers one render, and returns the picture as an image value — returned from a tool, a probe or `execute`, it reaches you as a picture, with what the capture has to say about it (its size, the frame it is of, the cells of a grid) beside it. A PNG is written as well when you pass a `path`. The convenience wrappers render from a world-space position (with optional look-at), frame a target entity, mirror the active viewport camera including its layers, or render a specific camera by name from its exact authored pose and settings (`fromCamera`, with optional per-capture overrides that never touch the camera); each waits for the render and the GPU readback, cleans up its camera, and returns only once the picture is read back. The low-level oneshot spawns the camera, triggers one render, and returns the handles at once without waiting, leaving the readback and cleanup to the caller; the `capture` MCP tool is built on it. A cleanup tool clears the capture output directory. ## Where a shot lands A capture given a `path` writes the PNG there and says where those bytes stand, beside the path it wrote: `durable` is true when the PNG is on the path it names and the next session reads it back, and false when the play shadow took it (live in this session and discarded on a guarded play-exit unless kept, with `survivesRestart` saying whether a restart keeps it and `playShadow` naming the routes that keep it) or when the path is in `/source/tmp/` scratch (gone when the engine stops or restarts, with a `warning` opening `SCRATCH`). Every capture carries it on the picture it returns as `durability`. Shooting gameplay means shooting in play, which is exactly when a `/source` destination is the shadow's, so this is the field that says whether a shot survives leaving play — `vfs.promotePlayShadow(path)` keeps it with play still running. ## The presented frame `source = "presented"` reads back the frame the engine presented to the player instead of rendering one. Nothing is drawn for it: it is the frame the viewport drew, copied out as it was finished, after the post chain, the upscale, the display transform, the content UI and every post-scene pass, at the size it was composed at. So it is the one capture whose temporal antialiasing, motion blur, camera motion, auto exposure and render scale are the real ones, and the source to verify any of them with. `source = "window"` is the whole presented surface (the window, the browser canvas or the headless framebuffer) with everything painted on the window: the editor's chrome and every window-level UI pass. Where no Scene panel shows the viewport, the two are the same image: the scene fills the window and the editor's chrome is painted over it, and each such frame says so in its `note` (a cell of a `presented` capture, a frame `renderer.presentedFrames` returns) for as long as that chrome is on the window. Show the Scene panel (the editor toolbox's `layout` tool) to read the game view alone. `frames = n` (1-32) takes n presented frames, one every `interval` frames (default 1: consecutive), at real gameplay speed, and lays them out as a grid in the order they were presented. Each cell states what its frame was drawn with: `frame` (the renderer's count, so consecutive frames carry consecutive numbers), `rasterWidth` / `rasterHeight` (the size the scene rasterized at), `compositeWidth` / `compositeHeight`, `renderScale` and `scaleMode`, `jitter` (the projection's sub-pixel offset in raster pixels), `exposure` (what the display transform multiplied the scene by) and `historyReset` (the viewport camera's first frame, a cut, or a hand-over to another camera). A single frame comes back at the size it was presented at; `width` / `height` resample it, or size the sheet a grid is laid into. A presented frame is drawn through the camera, layers, lens and chain that drew the screen, so the options that aim, light or shape a rendered frame (`camera`, `entity`, `position`, `viewpoint`, `fov`, `pass`, `renderLayers`, `postProcessing`, `environment`, `mode = "collage"` and the collage axes) are refused for it; aim the camera holding the viewport instead, or take an offscreen capture. A source that renders refuses `frames` and `interval` the same way, since they count presented frames. `deterministic` and `clearAir` hold the clock and the air for the whole engine, so they reach the presented frame too. A diagnostic buffer of the viewport itself, under its real camera motion and history, is read the same way: put the camera holding the viewport on that pass (the camera toolbox's `set` with `debugPass = "motion_vectors"`) and take `source = "presented"`. The viewport's velocity buffer is the frame's travel against the frame before it, so a turning camera reads in it, where an offscreen `pass = "motion_vectors"` holds the objects' own motion alone. The `motion_vectors` picture is a visualization: each channel is the square root of 100 times the stored displacement's size on its axis (R horizontal, G vertical, B the length), the sign is dropped, and R reads 255 from `width / 200` px of horizontal travel, G from `height / 200` px of vertical travel (raster pixels). The rendering guide's part on motion (`topics/rendering-motion`), "What the `motion_vectors` picture encodes", states it in full. The same frames, with their pixels as `TextureCpuHandle`s, come from `renderer.presentedFrames({ scope = "viewport" | "window", frames, interval })`, and `velocity = true` adds the viewport's velocity buffer from each frame as numbers (`frame.velocity`, a `VelocityField`): each pixel's travel in pixels per frame, x right and y down, signed and unclamped, read with `field:at(x, y)`, `field:row(y)` and `field:region(rect)`. ## The feed Every capture publishes the frame it made to `@builtin::tools.capture.feed`, so a viewer can show the newest one without taking a shot of its own. `Feed.latest()` is that frame: a `src` an image widget draws (the render target's guid while the engine still holds it, the written path when the capture produced a file), with the size, the source and the pass beside it. `Feed.watch(fn)` calls `fn` as each new frame arrives. The editor's Capture panel is built on it, and the `watch` layout puts that panel under the scene. A viewer calls `Feed.shown()` to say it is drawing frames from the feed. From then on the feed holds the newest capture's render target so the picture stays up after the capture that made it is finished with it, and lets it go when a later frame replaces it; `Feed.shown(false)` stops. With nobody drawing, a capture's target is released the moment its capture is done, and nothing is held. ## Viewpoints A **viewpoint** names where the camera stands and which way is up in the image: `front`, `back`, `left`, `right`, `top`, `bottom`, `iso`. It replaces reverse-engineering a `{yaw, pitch}` pair, and names the seven stations that answer "is this built correctly". `basis` says which axes the name is measured against, and it is **required** alongside a viewpoint when a subject is being framed: - **`"local"`** — the subject's own axes. `front` is the side it faces however it is turned, and the frame is fitted to its own extents rather than to the world-axis box around them. - **`"world"`** — the world axes. `front` is whatever faces world +Z. For a crate turned 40 degrees those are different pictures, so the call says which one it wants. Framing a world position rather than an entity, both values mean the world axes and either is accepted. ## Passes `pass` names **what** the frame holds, by name. `"final"` is the lit picture; a built-in diagnostic pass (`albedo`, `normal`, `depth`, `motion_vectors`, …) replaces the shaded image with the buffer behind it; and any capture **view** a render feature has published (`renderer.captureView.list()` enumerates them) is selectable by its own name. A name that is neither is refused against the list of what is registered. The name carries two decisions: which channel the camera renders, and which render layers that channel is legible under. A diagnostic buffer is read flat, so the sky behind it and the post-process chain over it come off; a view that draws its own geometry declares the layers it needs and is rendered under them. Stating `renderLayers` answers that second question yourself, for the one call. `passes` spreads the same vocabulary across the cells of a collage, and each cell reports the layers it was read under. ## Projection `projection = "orthographic"` covers a fixed world-space height at every distance. Parallel edges stay parallel and two equal-size objects at different depths cover equal pixels, which is what makes it the projection to check a shape or compare sizes under — a perspective frame's convergence hides both. `orthoHeight` sets that height; omit it and it is fitted to what is being framed. Any camera can be orthographic, not only a capture: it is a field on the `Camera` component. A capture through a camera the scene holds (`fromCamera`, `viewport`, and `source = "camera"`, `"screen"` or the scene camera) takes that camera's `projection` and `orthoHeight` with the rest of its lens, and its lighting `environment` with an `isolated` camera's background and ambient; a `projection` or `orthoHeight` stated for the call stands over the camera's. ## Which entity a capture framed A capture names an entity, or a camera to render from, by its id or by its name. A name exactly one entity carries means that entity. A name several entities carry means none of them on its own, so the capture is refused, and the refusal says how many entities carry it and names each by name and id; pass the id of the one you mean. A player is drawn as its body, so a capture of a player identity (an entity carrying `UserIdentity`, named `user`) frames the body its `avatar` names. A player prototype is absent from the live scene while it plays, so its name reaches no entity there: a capture of that name is refused, and the refusal names each player spawned from the prototype, by its identity and its body, with their ids. Every cell of a capture aimed at an entity reports what it framed under `subjects`: one `{ id, name }` per subject, carrying `playerIdentity = { id, name }` when the picture is the body of the identity the capture named. ## Isolate Framing a subject fits the **frame** to it; it does not decide what is drawn in that frame. Everything else standing there is still rendered — and a scene's default player spawn sits at the world **origin**, which is exactly where a prop usually gets built, so a tight shot of a new prop at the origin can come back showing the player instead. `isolate = true` draws the subject without the other geometry. It changes exactly that — lighting, sky and post-process are untouched, so a final frame stays a final frame, and a flat read of the geometry is a `pass`. Excluded geometry still casts shadows onto the subject and still bounces light into it, the same as any render-layer exclusion. In a `setups` collage each cell shows the entity its own set-up frames alone, and a set-up can state `isolate` for its own cell; a set-up aimed from a position or a camera frames no entity and is refused when it is to be isolated. ## The tone the frame carries Every capture reports `luma` on its cell record: the tone of the pixels it just encoded, in code values on the 0-255 scale the image is delivered at. ``` luma = { pixels, min, max, mean, p1, p5, p50, p95, p99, span, spread, crushed, clipped } ``` `span` is `max - min` — the whole range, a single stray pixel included. `spread` is `p95 - p5` — the range the body of the picture occupies, which is the reading that answers whether a shot is legible. `crushed` and `clipped` are the shares of the picture sitting at code 0 and at code 255. A frame's mean cannot answer that question: half a picture at 40 and half at 200 carries the same mean as a flat field at 120, and only one of them has anything in it. A subject can be modelled, shaded, lit and drawn and still arrive inside a handful of code values, in which case the image looks like a wash and every other field here reports success. `spread` is the number that says so. The same reading is available anywhere pixels are: `cpu:tone()` on a `TextureCpuHandle` — from `renderer.texture.readback(rtHandle)` on a capture handle, from a render-to-texture camera's target, from a CPU canvas — and `cpu:histogram()` under it, the per-code-value counts for luminance and for each of the three channels, which every reading above is a sum over. `cpu:histogram(x, y, w, h)` counts one rectangle of the picture alone, so a reading per region of the frame — how much of each cell is dark, lit or a given colour — is one call per region. `cpu:flip(reference)` holds the picture against another of its size by NVIDIA FLIP, the comparison a golden is judged by; `@builtin::modules.postMetrics` carries it with the golden runner, the pixel metrics (banding, temporal variance, halo overshoot, ring energy, hue drift) and the scopes, each reading a presented frame or a capture result as it comes. ## The grade an offscreen frame carries A capture spawns its own camera and renders offscreen, and the post-process chain runs over that frame the way it runs over the viewport's — for a station, for an orbit around an entity, for a named camera, for a render-to-texture camera alike. Inside an effect, `engine.view_proj` / `engine.prev_view_proj` / `engine.inv_view_proj` are the camera THAT render was drawn from and `engine.resolution` is that target's own size, so a grade that reconstructs world space from scene depth reconstructs against the station and lens the capture asked for. That makes an offscreen capture an oracle for an authored look: it photographs a chosen station and lens without taking the on-screen camera away from whoever else is driving the scene, and moving that camera somewhere else does not move the frame this one returns. An offscreen render keeps no view history of its own, so `engine.prev_view_proj` there holds that same matrix rather than the frame before it, and a pass taking camera motion from the two reads none. On the viewport the pair is a frame apart, so a camera's motion (and the blur and temporal reconstruction built on it) is read from the presented frame: `source = "presented"`. A render feature's passes reach an offscreen render the same way, against the same camera — the `renderFeature` assetType README carries that half, including `@frame.camera`, its own per-target camera input. `render(ctx)` itself runs once a frame for the main viewport, so `ctx.viewport` is the window's size rather than the captured target's; a feature sizes its scratch with `screen = true` and lets the engine track the drawn target. `postProcessing = false` takes the chain off the frame a capture returns, and with it the film a render feature draws — the flare and grain, a short focus's bokeh, the shutter's smear. It is a `Camera` property rather than a render layer, so `renderLayers` does not reach it. A capture naming a diagnostic `pass` drops the chain by default, so the buffer comes back as the value it encodes. ## Collage `collage` renders a grid of frames into one image. What varies across its cells is what you pass — `setups` for a cell per whole camera set-up, `viewpoints` for a cell per view of one subject (or `"sides"` for all six), `passes` for a cell per render pass, `duration` for a cell per sample over time. A collage with no axis is refused rather than quietly sampling time. `setups` is the shot list: each entry is written the way a single capture is aimed (`source`, `camera`, `entity`/`entities`, `position`, `lookAt`, `rotation`, `distance`, `angle`, `margin`, `viewpoint`, `basis`, `projection`, `orthoHeight`, `fov`, `near`, `far`), plus `label` to name the shot on the result, and a field an entry leaves out comes from the collage's own options. `setups` and `viewpoints` are one axis — both say where the camera stands — so a request names one of them; either crosses with `passes` into a 2D grid, a row per station and a column per pass. The shot most of this exists for is one call: six sides of one object, each an orthographic elevation, nothing else in frame. Authoring the cameras themselves — creating, listing, aiming, framing, and setting their parameters — is the `camera` toolbox.
▲ 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 · tools/capture.toolbox/shared.module

Problems

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

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

Usability ratings

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

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

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

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