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

camera_rig

Shared internals for the camera rigs — the parts every follow camera needs before it gets to have a personality.

by◐lumi·posted 3mo ago
What it does

camera_rig

Shared internals for the camera rigs — the parts every follow camera needs before it gets to have a personality.

The built-in rigs (chase, mount, cinematic, birds_eye, third_person_follow, orbital_follow and the rest) resolve their follow target the same way, read where it is drawn the same way, ease toward their framing measured from the subject the same way, turn a look-around the same way, avoid geometry the same way, and write their pose the same way. Only the placement of the camera relative to the subject differs, so everything else lives here and the rigs stay small enough to read in one screen.

local CameraRig = require("controller.camera_rig")
local follow = CameraRig.newTrail()

function update(dt)
    local target = CameraRig.resolveFollow(public.entity.id, public.follow)
    if target == nil then return end

    local tx, ty, tz = CameraRig.drawnPosition(target)
    if tx == nil then return end
    local px, py, pz = tx, ty + public.height, tz

    local h, radius = CameraRig.ringAt(public.rings, public.orbitT)
    local cx = px + math.sin(public.yaw) * radius
    local cy = py + h
    local cz = pz + math.cos(public.yaw) * radius

    cx, cy, cz = CameraRig.pullIn(px, py, pz, cx, cy, cz, 0.3,
        CameraRig.pullInExclude(target, public.cameraIgnore))

    cx, cy, cz = CameraRig.trail(follow, tx, ty, tz, cx, cy, cz,
        public.followTau, public.followTau, public.followTau, dt)
    CameraRig.applyPose(public.entity.id, cx, cy, cz, px, py, pz)
end

Exports

  • CameraRig.damp(current, goal, tau, dt) -> number — exponential convergence toward goal. tau is the time constant in seconds: the smaller it is the tighter the camera tracks, and 0 snaps. Frame-rate independent, so a hitched 100 ms frame and six clean 16 ms frames land in the same place, and no frame length overshoots the goal. Damp each component separately.
  • CameraRig.drawnPosition(id), CameraRig.drawnForward(id), CameraRig.drawnPose(id) -> (px, py, pz, qx, qy, qz, qw): where a subject is drawn this frame, which way it faces there, and its whole drawn pose. A body the simulation moves is drawn blended between physics ticks; a rig placed from these holds it steady on screen at any frame rate. drawnPose is what a rig riding the body (a seat, a turret) places itself in the body's frame from.
  • CameraRig.newTrail() and CameraRig.trail(state, subjectX, subjectY, subjectZ, goalX, goalY, goalZ, tauX, tauY, tauZ, dt) -> (x, y, z): ease the camera toward its goal measured as an OFFSET from the subject. The subject's own motion carries the camera at any speed, so a camera framed 6 m behind stays 6 m behind at 5 m/s and at 200 m/s, and the time constants soften only a change of the framing. Damping the camera's world position instead leaves it speed x tau behind a moving subject.
  • CameraRig.tauOf(remaining) -> number: the time constant of a per-second blend field (the share of a gap left after one second), for damp and trail.
  • CameraRig.newLook() and CameraRig.lookAround(state, dx, dy, limits, dt) -> (yaw, pitch): a look-around turned by the look control within limits ({ sensitivity, maxYaw, minPitch, maxPitch, returnDelay, returnTime, invertY? }, radians and seconds) that comes back to rest returnDelay seconds after the input stops. Yaw is positive right, pitch positive up.
  • CameraRig.newPullIn() and CameraRig.pullInEased(state, pivotX, pivotY, pivotZ, camX, camY, camZ, radius, exclude, outTime, dt) -> (x, y, z): pullIn that comes in on the frame a collider gets in the way, so no frame is drawn from inside it, and eases back out over outTime once the way is clear.
  • CameraRig.ringAt(rings, t) -> (number, number) — height and radius of the orbit at t along the three-ring spline, where rings is { bottom = { height, radius }, center = ..., top = ... }. t runs 0 at the bottom ring to 1 at the top, passing exactly through the centre ring at 0.5; adjacent rings are blended with a smoothstep so the seam has no visible kink. Out-of-range t clamps rather than extrapolating.
  • CameraRig.resolveFollow(selfId, followField) -> string? — the entity this rig follows. Takes the rig's own follow field (an entity id or an entity reference) when it is set, and otherwise falls back to the Camera.follow slot, which is the standard place every camera behavior reads its target from — that is what makes "swap the behavior, keep the follow target" work. Returns nil when nothing is set AND when the resolved id has no live entity, which is the normal state for the first frames of play mode while the avatar is still spawning.
  • CameraRig.pullIn(pivotX, pivotY, pivotZ, camX, camY, camZ, radius, exclude?) -> (number, number, number): the camera position moved in along the pivot-to-camera line until no collider is between the two. A sphere of radius is swept from the pivot, and every collider in the world stops it, whether or not anything draws it: an invisible walk bound and a trigger volume pull the camera in exactly as a wall does. radius is also the distance kept off the surface the camera lands on; 0 turns the pull-in off and returns the input untouched. exclude is an entity id, or a list of them, whose colliders the sweep passes through: the subject the camera is looking at, plus anything the camera should see through.
  • CameraRig.pullInExclude(subjectId, ignore) -> { string }: the exclude list a rig hands pullIn: the subject first, then every entity in the rig's cameraIgnore list (ids or entity proxies). orbital_follow and third_person_follow both build theirs with it from their cameraIgnore field. A rig written on this module gives its authors the same control by declaring a cameraIgnore list of its own (Field.list(Field.entityRef(nil, Sync), Sync)) and passing it here.
  • CameraRig.applyPose(selfId, camX, camY, camZ, lookX, lookY, lookZ) — place the camera and aim it at a point. Both the pose and the aim point are in the camera entity's own transform frame: parent-relative when the camera is parented to its subject, world space when it is standalone. The write goes to the local transform, so transform propagation composes the world matrix from parent_world * local instead of being fought by a world-space write.

Interface

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

conforms to

zero/source-extract/v2

Shared internals for the camera rigs: `chase` (behind a body, pulling in through walls, free-look), `mount` (riding a body at a point of its own frame: a driver's seat, a hood, a turret), `cinematic`, `birds_eye`, `orbital_follow`, `third_person_follow` and the rest under `controller/`. The rigs resolve a follow target the same way, read where it is drawn the same way, ease toward their framing measured from the subject the same way, turn a look-around the same way and pull in through geometry the same way. That logic lives here so each rig differs only in how it places the camera relative to the subject. Consumers: local CameraRig = require("controller.camera_rig") local target = CameraRig.resolveFollow(public.entity.id, public.follow) local h, radius = CameraRig.ringAt(rings, t)

damp(current: number, goal: number, tau: number, dt: number) → number

Frame-rate independent damping toward a goal.

argtypedescription
currentnumberCurrent value.
goalnumberTarget value.
taunumberTime constant in seconds; 0 snaps.
dtnumberFrame delta in seconds.

examples

pos.x = CameraRig.damp(pos.x, goal.x, 0.2, dt)

ringAt(rings: Rings, t: number) →

Height and radius of the orbit at a point along the three-ring spline.

argtypedescription
ringsRingsThe bottom / center / top rings.
tnumberPosition along the spline, 0 at the bottom ring and 1 at the top.

examples

local h, rad = CameraRig.ringAt(rings, 0.5)

resolveFollow(selfId: string, followField: any) → string

Resolve the entity this rig follows: the explicit field, else the standard `Camera.follow` slot.

argtypedescription
selfIdstringThis rig's entity id.
followFieldanyThe rig's own `follow` field value.

examples

local target = CameraRig.resolveFollow(public.entity.id, public.follow)

drawnPosition(targetId: string) →

Where a subject is drawn this frame, in world space. A body the simulation moves is drawn blended between physics ticks, and so is everything parented under it, while its transform (`entity.position`) moves only when a tick runs; a rig placed from the drawn pose keeps the subject steady on screen. Any other entity is drawn where its transform puts it. the scene answers to that id. A VM that holds no render state answers with the transform's position.

argtypedescription
targetIdstringThe subject to read.

examples

local x, y, z = CameraRig.drawnPosition(bodyId)

drawnPose(targetId: string) →

Where a subject is drawn this frame and how it is turned there, in world space: the position `drawnPosition` reads and the rotation the frame draws it with. A rig that rides a body (a seat, a hood, a turret) places itself in the body's frame from this pose, so it moves with the body as smoothly as the body is drawn, whatever the physics tick and the frame rate. or nil when nothing in the scene answers to that id. A VM that holds no render state answers with the transform's pose.

argtypedescription
targetIdstringThe subject to read.

examples

local px, py, pz, qx, qy, qz, qw = CameraRig.drawnPose(carId)

newTrail( ) → Trail

A fresh trail state for `trail`, holding no offset yet.

examples

local follow = CameraRig.newTrail()

trail(state: Trail, subjectX: number, subjectY: number, subjectZ: number, goalX: number, goalY: number, goalZ: number, tauX: number, tauY: number, tauZ: number, dt: number) →

Ease a camera toward the place its framing puts it, measured from its subject. The camera's OFFSET from the subject is what eases, so the subject's own motion carries the camera with it at any speed: a camera framed 6 m behind a car stands 6 m behind it at 5 m/s and at 200 m/s, and what the time constants soften is a change of the framing itself (a turn of the subject, a zoom, a look, a pull-in). `state` keeps the offset between frames.

argtypedescription
stateTrailThe rig's trail, from `newTrail`.
subjectXnumberSubject X, where it is drawn this frame.
subjectYnumberSubject Y.
subjectZnumberSubject Z.
goalXnumberWhere the framing puts the camera this frame, X.
goalYnumberGoal Y.
goalZnumberGoal Z.
tauXnumberTime constant in seconds for the offset's X; 0 snaps.
tauYnumberTime constant for Y.
tauZnumberTime constant for Z.
dtnumberFrame delta in seconds.

examples

local cx, cy, cz = CameraRig.trail(follow, tx, ty, tz, gx, gy, gz, 0.3, 0.3, 0.3, dt)

tauOf(remaining: number) → number

The time constant of a per-second blend: a rig field stating what share of the gap is left after one second (0 closes it at once, 1 never closes it) as the seconds `damp` and `trail` take. for one that never moves.

argtypedescription
remainingnumberThe share of the gap left after one second, 0 to 1.

examples

local tau = CameraRig.tauOf(public.positionSmoothing)

newLook( ) → Look

A fresh look-around state for `lookAround`, at rest.

examples

local look = CameraRig.newLook()

lookAround(state: Look, dx: number, dy: number, limits: LookLimits, dt: number) →

Turn a look-around by one frame of look input, held within its limits, and bring it back to rest once the input stops. Yaw is positive to the right, pitch positive up; a look delta reports what the pointer did, so pushing the mouse or stick forward (negative `dy`) looks up unless `invertY` is set. A look moves `state` and answers the turn.

argtypedescription
stateLookThe rig's look, from `newLook`.
dxnumberThis frame's horizontal look input.
dynumberThis frame's vertical look input.
limitsLookLimitsThe `LookLimits` the look answers to.
dtnumberFrame delta in seconds.

examples

local yaw, pitch = CameraRig.lookAround(look, dx, dy, limits, dt)

newPullIn( ) → PullIn

A fresh pull-in state for `pullInEased`.

examples

local hold = CameraRig.newPullIn()

pullInEased(state: PullIn, pivotX: number, pivotY: number, pivotZ: number, camX: number, camY: number, camZ: number, radius: number, exclude: (string | { string }, outTime: ?, dt: ?) →

`pullIn` that comes in at once and goes back out gently: each frame the sphere sweep finds where the camera may stand, a camera that would be past that point is brought in to it on that frame, so no frame draws from inside the geometry, and once the way is clear the camera eases back out to its framing over a time constant of `outTime`.

argtypedescription
statePullInThe rig's pull-in, from `newPullIn`.
pivotXnumberPivot X: the point the camera looks at.
pivotYnumberPivot Y.
pivotZnumberPivot Z.
camXnumberWhere the framing puts the camera, X.
camYnumberCamera Y.
camZnumberCamera Z.
radiusnumberSphere radius used for the cast; 0 turns the pull-in off.
exclude(string | { string }The entities whose colliders the sweep passes, as `pullIn` takes them.
outTime?Time constant in seconds of the ease back out; 0 snaps out.
dt?Frame delta in seconds.

examples

cx, cy, cz = CameraRig.pullInEased(hold, px, py, pz, cx, cy, cz, 0.3, exclude, 0.4, dt)

drawnForward(targetId: string) →

The direction a subject faces where it is drawn this frame: its local -Z carried into world space by its drawn rotation, the same axis `entity.transform.forward` reads from its transform. the scene answers to that id.

argtypedescription
targetIdstringThe subject to read.

examples

local fx, fy, fz = CameraRig.drawnForward(bodyId)

visibleForward(targetId: string) →

The direction a subject visibly faces, in world space. A body declares its own visible forward (`Locomotion.forward`), because a mesh faces whichever way its source authored it: a Synty/FBX body carries `{0,0,1}`, a glTF body `{0,0,-1}`. Reading that declaration is what lets a rig sit behind ANY subject rather than behind one particular art pipeline. Falls back to the entity's own transform forward when nothing declares one.

argtypedescription
targetIdstringThe subject to read.

examples

local fx, fy, fz = CameraRig.visibleForward(bodyId)

transformForward(id: string) → void

argtypedescription
idstring

pullIn(pivotX: number, pivotY: number, pivotZ: number, camX: number, camY: number, camZ: number, radius: number, exclude: (string | { string }) →

Pull a camera position in toward the pivot when a collider intervenes. A sphere of `radius` is swept from the pivot to the camera, and the camera stops where the sphere first meets a collider. Every collider in the world blocks the sweep, whether or not anything draws it: an invisible walk bound, a trigger volume and a wall all pull the camera in alike. The entities named in `exclude` are the ones the sweep passes through.

argtypedescription
pivotXnumberPivot X.
pivotYnumberPivot Y.
pivotZnumberPivot Z.
camXnumberDesired camera X.
camYnumberDesired camera Y.
camZnumberDesired camera Z.
radiusnumberSphere radius used for the cast; 0 turns the pull-in off and returns the camera position untouched.
exclude(string | { string }The entity, or list of entities, whose colliders never block the camera: the subject, plus any collider the camera should see through.

examples

local x, y, z = CameraRig.pullIn(px, py, pz, cx, cy, cz, 0.3, bodyId)
local x, y, z = CameraRig.pullIn(px, py, pz, cx, cy, cz, 0.3, { bodyId, boundsId })

pullInExclude(subjectId: string?, ignore: { any }?) →

The exclude list a rig hands `pullIn`: its subject, followed by every entity in its `cameraIgnore` field. Each entry of `ignore` is an entity id or an entity proxy; an empty slot is skipped.

argtypedescription
subjectIdstring?The entity the rig frames, or nil when it frames none.
ignore{ any }?The rig's `cameraIgnore` list, or nil.

examples

local exclude = CameraRig.pullInExclude(targetId, public.cameraIgnore)

applyPose(selfId: string, camX: number, camY: number, camZ: number, lookX: number, lookY: number, lookZ: number, frame: Frame.Frame?) → void

Write a camera pose onto an entity, aiming at a point. Both the pose and the aim point are expressed in the camera entity's own transform frame — parent-relative when the camera is parented, world space when it is not. The view's up is the up of `frame` (`Frame.at` of the `modules.up_frame` module: up against the gravity where the subject stands, so a camera on the side of a planet keeps level with it), +Y when it is left out.

argtypedescription
selfIdstringThe camera entity id.
camXnumberCamera X.
camYnumberCamera Y.
camZnumberCamera Z.
lookXnumberAim point X.
lookYnumberAim point Y.
lookZnumberAim point Z.
frameFrame.Frame?The frame whose up is the view's up; defaults to the world's.

examples

CameraRig.applyPose(id, cx, cy, cz, tx, ty, tz)
CameraRig.applyPose(id, cx, cy, cz, tx, ty, tz, Frame.at(tx, ty, tz))

mapGuid(ref: any) → string

Which input map an `inputMap` field names: its guid. `asset.resolve` hands back a fresh table for every call, so the guid is what says whether two refs name the same scheme, which is how a rig tells a repointed `inputMap` from a write of the map it already holds.

argtypedescription
refanyAn input map ref, or nil.

examples

if CameraRig.mapGuid(public.inputMap) ~= CameraRig.mapGuid(activeMap) then retake() end

playPaused( ) → boolean

Whether play is paused: play mode with its clock held. Edit mode holds the clock too, and a rig there keeps what it holds while it is live, so the rule is about play alone.

componentIsLive(entityId: string, enabled: boolean?) → boolean

Whether a component instance is live: enabled itself, and on an entity that is active in the hierarchy. A component's `awake` runs when it is attached whatever its state, so a rig reads this in `awake` to know whether it starts live, and states it from `onEnable` through `setDriveEnabled`: one attached disabled, or to an entity that is inactive or under an inactive parent, takes nothing up until it is live. hierarchy, or the entity's state cannot be read.

argtypedescription
entityIdstringThe entity the component is on (`public.entityId`).
enabledboolean?The component's own `enabled` field (`public.enabled`).

examples

local live = CameraRig.componentIsLive(public.entityId, public.enabled)

driveWhileRunning(arm: (, release: ?, enabled: ?) →

Hold a gameplay camera's controls while the rig is live and play is not paused. Pausing play returns the screen to the editor's free camera, so the rig's input map and its pointer lock go with it, or the camera on screen is one the author cannot move; resuming play takes them up again. A rig that is disabled, or whose entity is inactive, holds nothing a running rig holds: its controls leave the live set and its touch buttons leave the screen. In edit mode a live rig holds its controls, and a pause change there calls neither callback. A rig states whether it starts live here, from `componentIsLive` in `awake` (an instance can be attached disabled or to an inactive entity, and `awake` runs either way), and every change after that through `setDriveEnabled`. The callbacks are the rig's own arm/release; the rig arms itself in `awake` when it starts live. The pause hook runs them as well as the rig's own lifecycle, so the code a claim is recorded under can differ between an arm and its release: `release` gives back the claim `arm` took by the handles its activation returned (`map:deactivate(handles)`), which frees that claim whichever of them runs it. The registration belongs to the rig that made it and lasts as long as the rig does: `stopDriving` ends it, and a rig ends its own in `onDestroy`. A play/edit flip destroys and rebuilds the components in the scene, so a registration that outlived its rig would answer the next resume by arming a rig that is gone — taking a fresh holder on the input map, and a fresh set of subscriptions on its controls, for every flip the session has made. registration by.

argtypedescription
arm(Called when the rig starts driving — re-activate the map, retake the pointer.
release?Called when the rig stops driving: deactivate the map by the handles `arm` took, free the pointer.
enabled?Whether the rig starts live; absent, it does. A rig that starts disabled or inactive is armed by the `setDriveEnabled(handle, true)` its `onEnable` makes.

examples

driving = CameraRig.driveWhileRunning(armInput, releaseInput, CameraRig.componentIsLive(public.entityId, public.enabled))

setDriveEnabled(handle: number?, enabled: boolean) → boolean

State whether a rig is live, from its `onEnable` (as `componentIsLive` reads it) and its `onDisable` (false). Disabling it releases its controls; enabling it arms them again, in edit mode and while play runs. Enabled while play is paused, it arms on the resume. A rig that is disabled stays released across a pause and its resume. A statement of the state the rig is already in calls neither callback.

argtypedescription
handlenumber?The handle `driveWhileRunning` returned.
enabledbooleanWhether the rig is live.

examples

function onEnable() CameraRig.setDriveEnabled(driving, CameraRig.componentIsLive(public.entityId, public.enabled)) end
function onDisable() CameraRig.setDriveEnabled(driving, false) end

stopDriving(handle: number?) → boolean

End a `driveWhileRunning` registration. The rig stops answering the pause and its enabled state, so a rig that is on its way out takes nothing when gameplay resumes. A rig calls this in `onDestroy`, beside the release of whatever it is holding.

argtypedescription
handlenumber?The handle `driveWhileRunning` returned.

examples

function onDestroy() CameraRig.stopDriving(driving) end
⌬ Types
Ring = { height: number, radius: number }Rings = { bottom: Ring, center: Ring, top: Ring }Trail = { x: number?, y: number?, z: number? }Look = { yaw: number, pitch: number, idle: number }LookLimits = {PullIn = { reach: number? }

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.

53+items
·
assettype · born here
❒asset
# Module (asset type) A module is a reusable, stateless (or globally-stateful) Luau library that other code pulls in with `require()`. Modules are the unit of factored-out logic in a world: helpers, math libraries, format parsers, registries, shared algorithms. ## When to use one - You have logic you want to share across multiple components, services, scenes, or tools. - You have a registry, lookup table, or shared cache that callers all read from / write to. - You want a stable API surface (`M.fn`) other code can depend on. If the logic is bound to one entity, use a `.component`. If you want a named UI of fields rather than functions, use a `.preset`. ## Where it lives - Source: `/zero/source/.../<name>.module/` - Identity: the source path with `/` written as `.` and each segment's type suffix dropped — `/zero/source/demo/beats.module` is `demo.beats`, and `/zero/source/kit.package/beats.module` is `kit.beats`, the container's name kept and its `.package` suffix gone. `asset.create` returns this string, `asset.resolve(...).identity` reads it back, and the `require` forms below write it as `<identity>`. - Folder shape: - `init.luau` (or `init.lua`) — module body. **Required.** Returns a table (conventionally named `M`). - `README.md` — instance-level documentation. **Required.** - `.metadata` — agent-editable tags + free-form fields. **Required.** ## How to create one ```luau asset.create("module", "<name>") -- Creates: /zero/source/<name>.module/ -- init.luau (canonical `local M = {} … return M`) -- README.md (instance README template) -- `folder` places it in a subfolder of /source, and that subfolder -- leads the identity: `{ folder = "lib" }` produces `lib.<name>`. -- `into` authors it inside a resolved container (a package, a toolbox), -- whose own identity leads the same way: asset.create("module", "<name>", { folder = "lib" }) asset.create("module", "<name>", { into = asset.resolve("myPkg.package") }) ``` ## How it operates 1. **Registration.** Writing `init.luau` into a `.module/` folder indexes the asset and registers the module path with the resolver. 2. **Loading.** The first `require("<identity>")` runs the file's body and caches the returned table. Subsequent requires from anywhere return the **same table** — this is the shared-state lever for "module-local" registries. The body runs in an environment of the module's own: a name it declares without `local` is readable by the module's own functions and by no other script, so an export reaches its callers through the returned table and nothing else. Requiring a component's folder runs its chunk the same way, once, and its `update`, `start` and `public` stay in that environment; a component runs on an entity through `entity(id).component.add(name)`. 3. **Hot reload.** Editing the file re-runs the module body and folds what it returns into the table already loaded, so that table keeps its identity: a caller that captured it with `require` reads the new source's functions and values through the reference it already holds, and a later `require` returns that same table. A key the new source drops goes away; a key something set at runtime stays. The body's own `local`s start again from their initial values, so state that must outlive an edit lives in `modules.state()` (`guides { path: "core/scripting-and-tasks" }`). 4. **Identity resolution.** A module is reached by its `<identity>`, and where the caller lives decides which spelling of it resolves. For a module in a **world**, from a caller in that same world — another module, a component, a scene entrypoint, or an `execute` chunk: - `require("<identity>")` — the identity on its own, resolved against the caller's own root. It carries every folder segment, so a module created with `{ folder = "demo" }` is `require("demo.beats")`. - `require("@root::<identity>")` — the same root-relative resolution, written out. - `require(".sibling")` — a module in the same folder, by its bare name; `..name` steps up one folder, `...name` two. Logs, stack traces and hot-reload notices name that same module `@local.source.<identity>` — its key under the world source root. The `<identity>` tail of that key is the form above, so a trace reading `@local.source.demo.beats` is `require("demo.beats")`. For a module in a **library** — content under `/zero/source/libs/@<lib>/` — `@<lib>::` addresses that library's root from anywhere: `require("@builtin::modules.transform")`. Mounting a world as a library moves its files under such a root and flips the caller root to `@<lib>::`, which is what keeps the root-relative forms above resolving across the move. ## Discovery - `asset.list("module")` — every registered module. - `asset.inspect("<name>")` — public functions, source path, this type README. - `ls /zero/source/<name>.module` lists the files the folder holds. ## Authoring conventions - Return a single `M` table from `init.luau`. Top-level statements with side effects run on first require — useful for one-time initialization, dangerous if they touch the engine before it's ready. - Write exported functions as `typed function`, not `function`: the argument types are enforced at the call and the checker knows the signature, so a caller's mistake is reported where they made it. - Annotate exported functions with `--!desc` / `--!arg` / `--!return` / `--!example` so the LSP, `tools.list`, and `asset.inspect` surface them. A function with no `--!desc` is reachable only by someone already reading this file. - Declare a VALUE with `Field.<kind>(default, mode, description)`, and a table whose members are reached through a metatable with `--!members <TypeName>` — the latter gives the surface its accepted member set, its type, and its documentation from one table. See `guides { path: "core/authoring" }` for all four rules and `modules/api/engine/entity.module/members.module` for a worked member table. - Keep module state in module-local upvalues or in `modules.state()`. A name the body declares without `local` lives in the module's environment, which every run of the module shares: a function the previous run left in place reads what the reload assigned. Module-locals start again from their initial values with each hot reload; the table `modules.state()` returns is the same table on both sides of every reload. - Prefer focused modules over kitchen-sink modules. If two halves of a module have no shared state, split them. ## Common pitfalls - **Cyclic requires.** A `require` chain that loops will return the partial table (the half built before the cycle was detected). Design for one-way dependencies. - **Engine-time side effects.** Don't `entity.spawn` at module top-level — the engine may not be ready. Expose an `M.init` and call it from a scene entrypoint. - **Hot-reload + module-local cache.** A module that caches expensive computation in upvalues loses that cache on reload — fine for dev, but be aware in performance work. - **`init.lua` vs `init.luau`.** Either works, `.luau` is canonical. - **Writing one while play runs.** A `/source` write made while play is running lands on the play shadow, and a guarded play-exit discards it unless it is kept. One `.module` write shadows `init.luau`, the `README.md` and the `.metadata` together. `vfs.write(path, bytes, { durable = true })` skips the shadow, and `vfs.promotePlayShadow` keeps what is already on it — the `core/vfs` guide has the model and what each route costs. ## Related types - `.component` — for entity-bound state + lifecycle hooks. - `.service` — generates content you don't have yet (a mesh, sound, texture, …) via a metered provider. - `.tool` — for a single agent-callable function with a YAML schema. - `.package` — to group several modules + components + scenes into one shippable folder. ## In the Inspector Exports: what the module exports (name, kind, signature), parsed from its source without running it, with **Check** (the LSP's diagnostics for its entry file) and **Open**.
▲ 0↑ born
◇
component · born here
❒asset
# Locomotion Blend-space-driven locomotion for entities running the characterController package. Reads horizontal velocity from a sibling `MovementState` (or, as a fallback, `CharacterController`) component on the parent and feeds a single 2D blend space (strafe-angle on X, speed on Y) with idle / walk-{F,L,R,B} / run-{F,L,R,B} / sprintF clips. Each clip's point sits at the speed the clip carries this body at: its retarget bake measures how fast the ground passes under the stance foot on this body's legs, so the feet move with the ground at whatever speed the body moves. A clip that plays without a measured speed sits at its gait's `walkSpeed` / `runSpeed` / `sprintSpeed`. Pair on the same entity (or a parent of) a `SkinnedModel`. The component creates the AnimGraph, polls for the SkinnedModel child once start() has run, registers the clips as blend-space points and plays the graph. `update()` damps speed + angle and writes them to the active blend space each frame. This supersedes the older FSM-based Locomotion controllers (crouch / jump / fall / land / turn-in-place state machine). Those behaviours can be added back as separate layered graphs once the blend-space driver has settled.
▲ 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
# up_frame The frame something standing in the world stands in: `up` against the gravity where it is (`Physics.upAt`, which the `GravityField` components shape), and the two directions across it that a walk, a heading or a camera's orbit is measured along. The built-in `CharacterController` walks across one and publishes it as its `frame` field; `WASDInput`, `MovementState`, `Locomotion` and `LocomotionFull` read the controller's; the `orbital_follow` and `third_person_follow` cameras orbit and level themselves in one of their own. Positions stay in world space, and the module keeps no state of its own: something that moves holds its frame and hands it back each update. ```luau local Frame = require("@builtin::modules.up_frame") frame = Frame.follow(frame, p.x, p.y, p.z) -- kept from one update to the next local wx, wy, wz = Frame.toWorld(frame, dx, 0, dz) -- a step across the ground, in world space ``` ## Exports - `Frame.at(x, y, z, groups?)`: the frame at a point, the world turned the shortest way that carries +Y onto the up there. The world's own frame wherever gravity pulls down -Y. - `Frame.follow(frame, x, y, z, groups?)`: the frame something moving keeps. While a `GravityField` acts it is `frame` carried onto the up at the point, so a heading held across it walks a straight line all the way round a planet, the far side included; where none acts it is the frame of the world's gravity. Returns the frame and the `Physics.gravityFieldsAt` read at the point. - `Frame.transport(frame, ux, uy, uz)`: a frame carried onto a new up by the shortest turn from its own. - `Frame.standing(entity)`: the frame a `CharacterController` walks its entity across (its `frame`), or the frame at the entity's position for an entity with none: what the controller's `inputX` / `inputZ` and `velocityX` / `velocityZ` run along. - `Frame.fromUp(ux, uy, uz)`, `Frame.fromRotation(qx, qy, qz, qw)`, `Frame.world()`, `Frame.isWorld(f)`: a frame from an up or from a rotation, the world's own, and whether a frame is the world's. - `Frame.toWorld(f, lx, ly, lz)`, `Frame.toLocal(f, wx, wy, wz)`: a vector along the frame's X, up and Z in world space, and a world vector along the frame's axes. - `Frame.above(f, x, y, z, ly)`: the point `ly` along the frame's up from a point. - `Frame.lookAt(f, fx, fy, fz, tx, ty, tz)`: the rotation that looks from one point at another with the frame's up as the view's up, for a camera kept level with the ground a character stands on. A frame is `{ x, up, z, rotation }`: its three unit axes in world space, and the rotation carrying the world's axes onto them.
▲ 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
·
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
❒
package · born here
❒asset
▲ 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 · controller/camera_rig.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.