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

avatarAppearance

How a person wears an avatar, as one data document, and how the engine composes it onto a live avatar on every peer.

by◐lumi·posted 5d ago
What it does

avatarAppearance

How a person wears an avatar, as one data document, and how the engine composes it onto a live avatar on every peer.

local avatarAppearance = require("@builtin::modules.avatarAppearance")

local doc = avatarAppearance.new("@builtin::avatars.humanoid")
doc.body_shape = { height = 1.9, width = 1.1 }
doc.colours = { body = "#3366cc", hair = "#201008" }
doc.worn = {
    { slot = "hat", item = "@builtin::meshes.cone", adjust = { y = 0.06, scale = 0.25 } },
    { slot = "held", item = "@builtin::meshes.cylinder", adjust = { z = 0.1, scale = 0.1 } },
}
doc.animation_pack = "@builtin::systems.characterController.presets.synty"  -- a Locomotion preset
doc.emotes = { "<emote guid>", "<emote guid>" }
doc.parameters = { moveSpeed = 3 }

assert(avatarAppearance.validate(doc).ok)
local root = asset.resolve("@builtin::avatars.humanoid", "avatar"):instantiate()
local r = avatarAppearance.apply(root, doc)        -- { changed, pending, unapplied }
-- a player's body: layers.active.players.localPlayer.avatar (the avatar root)
print(#avatarAppearance.encode(doc), avatarAppearance.address(doc))

The document

The fields are ZeroMind's appearance document, field for field, so an outfit an account saved reads as it is:

fieldwhat
v1
avatarthe avatar asset reference
body_shapenamed numbers; height (metres) and width (a factor) are composed
colours#rrggbb / #rrggbbaa per region; body is every mesh of the body the avatar's regions (in avatar.json) gives no other region; the items seated on its points (the avatar's own parts, the worn items) keep their own colours
wornthe worn items in order: { slot, item, adjust? }
animation_packa Locomotion preset reference
emotesemote asset guids (uuids, stored lowercase and hyphenated), in menu order
parametersnamed bools, numbers or strings; moveSpeed, sprintMultiplier and tintBlend are composed

A worn slot is one of the 19 standard attachment points (hat, rightGrip, bodyBack, ...; see avatarStandard) or a slot alias: held (rightGrip), offhand (leftGrip), back (bodyBack), face (faceFront), neck (neckBase), waist (waistCenter). adjust takes x, y, z (metres in the point's frame), pitch, yaw, roll (degrees), scale, and sx, sy, sz (a factor along one axis, times scale: { scale = 0.05, sy = 9 } stretches a cylinder into a stick).

encode writes the canonical bytes (compact JSON, fields in schema order, map keys sorted), address their sha256, decode(bytes, address?) reads them back and checks them against an address, and validate names every rule a document breaks (ZeroMind's bounds, at most 4096 bytes, and the standard's slots and adjustments).

Composing

apply(root, doc) composes onto a live avatar root and, applied again with another document, recomposes only what differs: an item both documents wear stays as it is. read(root) is the document composed there, worn(root) the items with the entities spawned for them, settle(root) seats items whose point waits for the body's skeleton, and clear(root) takes it all back off, returning the avatar to how it stood before the first document. diff(a, b) states what differs between two documents.

Games

override(doc, rules) is a game's view of a player's document; the player's document is unchanged. A worn rule reaches every item worn on the point its slot names, by whichever name the document gives it (held reaches an item worn as rightGrip):

local seen = avatarAppearance.override(doc, {
    worn = { hat = "my_helmet", held = false },        -- replace the hat, take the held item away
    body_shape = { height = { min = 1.6, max = 1.8 } }, -- clamp the height for the match
    animation_pack = "my_pack",                         -- force a pack
})

The Appearance component carries the document and the rules on an avatar root as synced data, so every peer composes the same character.

Outfits and the profile

outfits(answer?) is a set of named outfits with one current, in the shape ZeroMind answers GET /v1/me/appearance in ({ current, outfits }): :save(name, doc, { makeCurrent }), :get, :list, :wear, :current, :remove, :toJson. fromDescriptor(descriptor) reads a ZeroMind profile's avatar_descriptor (a builtin body, a tint, a height, motion) as the document ZeroMind's own mapping gives, value for value (the descriptor's numbers are 32-bit floats), so both have one address.

The account

The signed-in person's account keeps their outfits and the one they wear. A player wears their account's look on the body that binds when they join a world (or switch modes): the current outfit's document, read by its address, else the document their profile avatar_descriptor maps to. It is written into the body's Appearance component, so every peer composes it. A body without Humanoid wears nothing, and a game's Appearance rules still apply over it.

local me = avatarAppearance.accountAppearance()      -- { ok, outfits, current?, look?, from?, address? }
avatarAppearance.saveOutfit("Pirate", doc, { makeCurrent = true })
avatarAppearance.wearOutfit("Pirate")                -- by name or id; nil wears none
avatarAppearance.deleteOutfit("Pirate")
avatarAppearance.wearAccountLook()                   -- the local player wears the account's look again

saveOutfit, wearOutfit and deleteOutfit change how the person appears to everyone, so the engine asks them in its own dialog first, whoever calls, and the local player then wears the account's new look. ZeroMind refuses them to an agent's own account (code = "AGENT_APPROVAL_REQUIRED"); the person makes those changes on the app menu's Outfits tab (appMenu.open("outfits"), modules.api.engine.outfits). An engine that booted offline is signed in to no account and answers { ok = false, offline = true }.

Interface

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

conforms to

zero/source-extract/v2

module avatarAppearance How a person wears an avatar, as one data document: which avatar, body shape parameters, colours per named region, the worn items in order, the animation pack, the equipped emotes and avatar parameter defaults. The document is ZeroMind's appearance document field for field (`v`, `avatar`, `body_shape`, `colours`, `worn`, `animation_pack`, `emotes`, `parameters`), so an outfit saved on an account reads here as it is, and its canonical bytes and address (the sha256 of those bytes) are the ones ZeroMind states. `apply` composes a document onto a live avatar and recomposes only what changed since the last one; `override` is how a game replaces or removes items, clamps the body shape or forces a pack without touching the player's own document; `outfits` holds named documents with one of them current. The `Appearance` component carries a document on an avatar root as synced data, so every peer composes the same character from it.

Appearance

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

argtypedescription
t{ [string]: any }?

isEmpty(t: any) → boolean

argtypedescription
tany

copy(v: any) → any

argtypedescription
vany

chars(s: string) → number

argtypedescription
sstring

encodeNumber(n: number) → string

A number as ZeroMind's canonical form writes an f64 (serde_json, which prints it with ryu): the shortest digits that read back as the same number, in fixed point from 1e-5 up to 1e16 with `.0` on a whole number (`2.0`, `0.00001`), and in scientific notation outside that range (`1e-6`, `1.5e17`).

argtypedescription
nnumber

canonicalGuid(s: any) → string

An emote guid as ZeroMind stores it: lowercase and hyphenated. Reads a uuid in the forms it is written in (hyphenated, 32 hex digits, braced, `urn:uuid:`); nil for a string that is no uuid.

argtypedescription
sany

encodeString(s: string) → string

argtypedescription
sstring

encodeValue(v: any) → string

argtypedescription
vany

encodeNumberMap(t: { [string]: number }) → string

argtypedescription
t{ [string]: number }

encode(doc: any) → string

The document's canonical bytes: compact JSON, the fields in the order the schema states them (`v`, `avatar`, `body_shape`, `colours`, `worn`, `animation_pack`, `emotes`, `parameters`), every map's keys sorted, empty fields left out, colours lowercase, emote guids lowercase and hyphenated, and every number written as ZeroMind writes it. Equal documents have equal bytes, and these are the bytes the document's address hashes and the bytes a peer receives.

argtypedescription
docanyA document.

examples

local bytes = avatarAppearance.encode(doc); print(#bytes)

address(doc: any) → string

The document's address: the sha256 (hex) of its canonical bytes, the address ZeroMind serves an outfit's document at (`GET /v1/content/<address>`).

argtypedescription
docanyA document, or its canonical bytes.

examples

print(avatarAppearance.address(doc))

new(avatar: string) → any

A document wearing `avatar` and nothing else.

argtypedescription
avatarstringAn avatar asset reference (`"@builtin::avatars.humanoid"`, a guid or an identity).

examples

local doc = avatarAppearance.new("@builtin::avatars.humanoid")

normalized(doc: any) → any

A document in the shape the encoder and every reader take: colours lowercase, emote guids lowercase and hyphenated, worn items and emotes as arrays, empty fields left out.

argtypedescription
docany

decode(bytes: string, address: string?) →

Read a document from its JSON bytes (an outfit's `document`, a content-store read, the `Appearance` component's field). With `address`, the bytes must hash to it, the check a peer makes on a document it was handed by its address.

argtypedescription
bytesstringThe document's JSON text.
addressstring?Optional sha256 hex the bytes must hash to.

examples

local doc, why = avatarAppearance.decode(bytes, sha)

pointOf(slot: string) → string

The point a worn slot is worn on: a standard attachment point is its own, an alias in `avatarAppearance.slots` names one.

argtypedescription
slotstringA slot name.

examples

print(avatarAppearance.pointOf("held"))  -- "rightGrip"

keyProblem(what: string, key: any) → string

argtypedescription
whatstring
keyany

refProblem(what: string, r: any) → string

argtypedescription
whatstring
rany

isColour(s: any) → boolean

argtypedescription
sany

isFinite(n: any) → boolean

argtypedescription
nany

validate(doc: any) → any

Every rule a document breaks, each named. The bounds are ZeroMind's (the version, references, key names, finite numbers, `#rrggbb` / `#rrggbbaa` colours, the counts, no emote twice, parameter values, the 4096-byte size), so a document that passes is one an account can save; the standard adds that every worn slot is a point an avatar carries (`pointOf`) and every adjustment one an item takes (`adjustments`). `field`, `version`, `ref`, `key`, `number`, `colour`, `count`, `slot`, `adjust`, `emote`, `parameter` or `size`.

argtypedescription
docanyA document.

examples

local v = avatarAppearance.validate(doc); for _, p in v.problems do print(p.rule, p.message) end

add(rule: string, name: string, message: string) → void

argtypedescription
rulestring
namestring
messagestring

countOf(t: any) → number

argtypedescription
tany

checkCount(name: string, n: number, max: number) → void

argtypedescription
namestring
nnumber
maxnumber

assertValid(doc: any, where: string) → void

argtypedescription
docany
wherestring

f32(n: number) → number

argtypedescription
nnumber

descriptorNumber(v: any) → number

A descriptor number as a 32-bit float, or nil for one that is not a number.

argtypedescription
vany

hexByte(c: any) → string

A tint channel as its two hex digits: the 0 to 1 channel times 255, rounded.

argtypedescription
cany

fromDescriptor(descriptor: any) → any

The document a ZeroMind profile's `avatar_descriptor` reads as, the mapping ZeroMind states (`AppearanceDocument::from_descriptor`), value for value: its builtin body is the `avatar` (`@builtin::avatars.<bundle>`), its height the `height` body shape parameter (clamped to 1.2 to 2.2 m), its tint the `body` colour with its blend as the `tintBlend` parameter, and its motion the `moveSpeed` (0.5 to 12) and `sprintMultiplier` (1 to 5) parameters. The descriptor's numbers are 32-bit floats, so `height = 1.8` reads as 1.7999999523162842, the value ZeroMind's document holds, and the two documents have one address.

argtypedescription
descriptoranyThe descriptor, as its JSON text or as a table `{ v, bundle, tint = { r, g, b, blend }, height, motion = { moveSpeed, sprintMultiplier } }`.

examples

local doc = avatarAppearance.fromDescriptor(creator.avatarDescriptor)

wornKey(w: any) → string

argtypedescription
wany

changedKeys(a: any, b: any) → void

argtypedescription
aany
bany

diff(a: any?, b: any) → any

What differs between two documents, part by part: whether the avatar, the animation pack or the emotes differ, which body shape parameters, colour regions and parameters differ, and which worn items `b` adds and `a` loses. Two documents with equal canonical bytes are `same`.

argtypedescription
aany?A document (or nil for none).
banyA document.

examples

local d = avatarAppearance.diff(outfitA, outfitB); print(#d.worn.added)

override(doc: any, rules: any) → any

A game's view of a player's document: a new document with the game's rules applied, the player's own document left as it was. `rules` may hold: `avatar` (a reference: the game's own body), `worn` (`{ [slot] = item | { item, adjust } | false }`: every item worn on the point that slot names replaced by the game's, or removed, whichever of the point's names the player's document uses: `held` reaches an item worn as `rightGrip`), `body_shape` (`{ [name] = number | { min, max } }`: a value forced, or a value the player states clamped), `colours` (`{ [region] = colour | false }`), `animation_pack` (a reference, or false for none), `emotes` (the list the game allows, in its order: the player's emotes it names are kept) and `parameters` (`{ [name] = value | false }`).

argtypedescription
docanyThe player's document.
rulesanyThe game's rules.

examples

local seen = avatarAppearance.override(doc, { worn = { hat = "my_helmet" }, body_shape = { height = { max = 1.9 } } })

ruled(slot: string, rule: any) → any

argtypedescription
slotstring
ruleany

isOwner(rootId: string) → boolean

Whether this engine writes the avatar's synced fields: always when it is in no multiplayer session, else when it owns the avatar.

argtypedescription
rootIdstring

idOf(v: any) → string

argtypedescription
vany

resolve(ref: any, kind: string?) → any

argtypedescription
refany
kindstring?

guidOf(ref: any) → string

argtypedescription
refany

readState(rootId: string) → any

argtypedescription
rootIdstring

bodyParts(rootId: string, state: any) → void

The entities that make up the body under the avatar root: the body root an instantiated avatar spawned, or the children the root's `Asset` composed from a body bundle (a replicated avatar), leaving out worn items and the name label.

argtypedescription
rootIdstring
stateany

meshesUnder(ids: { string }, skip: { [string]: boolean }) → void

The meshes of the body under `ids`: an item seated on one of its points, and everything under that item, is no mesh of the body.

argtypedescription
ids{ string }
skip{ [string]: boolean }

parseColour(c: string) → void

argtypedescription
cstring

byte(i: number) → number

argtypedescription
inumber

definitionOf(ref: any) → any

The avatar definition (`avatar.json`) of the avatar a document names, or nil.

argtypedescription
refany

trySeat(rootId: string, w: any, factor: number) → boolean

argtypedescription
rootIdstring
wany
factornumber

despawnTree(id: string) → void

argtypedescription
idstring

composeShape(rootId: string, doc: any, state: any) → boolean

Compose the body shape: every body part scaled about the avatar root by the height over the body's own height and by the width across it. The body's own height and eye height are read from its descriptor once its skeleton stands.

argtypedescription
rootIdstring
docany
stateany

composeColours(rootId: string, doc: any, state: any, unapplied: { string }) → void

argtypedescription
rootIdstring
docany
stateany
unapplied{ string }

composePack(rootId: string, doc: any) → boolean

argtypedescription
rootIdstring
docany

composeParameters(rootId: string, doc: any, state: any) → void

argtypedescription
rootIdstring
docany
stateany

composeAvatar(rootId: string, doc: any) → boolean

Swap the body to the one the document's avatar wears. An instantiated avatar swaps through `setCharacter`; a replicated one (its root's `Asset` composes the body bundle) swaps by its owner writing the `Asset` source every peer composes.

argtypedescription
rootIdstring
docany

originalAvatar(rootId: string) → string

The avatar the root stands as before any document was composed onto it.

argtypedescription
rootIdstring

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

argtypedescription
aany
bany

settleWorn(rootId: string, state: any) → number

argtypedescription
rootIdstring
stateany

resetSeats(state: any) → void

argtypedescription
stateany

apply(root: any, doc: any) → any

Compose `doc` onto a live avatar root and recompose only what changed since the document composed onto it last: the avatar's body (swapped to the one the document's avatar wears), the body shape (`height`, `width`), the colours (each region's meshes tinted: `body` is every mesh of the body the avatar's `regions` in `avatar.json` gives no other region, the items seated on its points (the avatar's own parts, the worn items) keeping their own colours, and a colour's alpha, else the `tintBlend` parameter, is how strongly it tints), the worn items (each spawned on this engine and seated on its slot's point with its adjustment; an item the last document wore too stays as it is), the animation pack (a Locomotion preset; without one the avatar's own), and the `moveSpeed` / `sprintMultiplier` parameters. The emotes and every other parameter are carried for the systems that read them (`read`). An item whose point the body has not set up yet is seated by `settle` once it has. `colours`, `worn`, `animation_pack`, `emotes`, `parameters`), how many items wait for their point, and `{ colours, worn, animation_pack? }`: the colour regions no mesh carries, the worn items that did not resolve to an asset, and a pack that did not apply to the avatar's Locomotion.

argtypedescription
rootanyThe avatar root (an EntityRef or id), as `avatarRef:instantiate()` returns it.
docanyA document (`validate` must pass).

examples

local r = avatarAppearance.apply(root, doc); print(table.concat(r.changed, ","))

settle(root: any) → number

Finish composing what `apply` could not yet: the body shape and the worn items whose point waits for the body's skeleton. The `Appearance` component calls it every frame while something waits.

argtypedescription
rootanyThe avatar root.

examples

while avatarAppearance.settle(root) > 0 do task.wait() end

clear(root: any) → boolean

Take what documents composed onto a live avatar root back off it: the worn items despawned, and the body, shape, colours, pack and parameters as the avatar stood before the first document. `read` answers nil afterwards. The `Appearance` component calls it when its document is emptied.

argtypedescription
rootanyThe avatar root.

examples

avatarAppearance.clear(root)

read(root: any) → any

The document composed onto a live avatar root, read back as `apply` composed it.

argtypedescription
rootanyThe avatar root.

examples

local doc = avatarAppearance.read(root); print(doc.avatar)

worn(root: any) →

The worn items composed onto a live avatar root, in order: `{ slot, item, point, id, seated }`, `id` the entity this engine spawned for the item. An item `seated` false is waiting for its point (`carried` true) or the body has no such point (`carried` false).

argtypedescription
rootanyThe avatar root.

examples

for _, w in avatarAppearance.worn(root) do print(w.slot, w.id, w.seated) end

outfits(answer: any?) → any

A set of named outfits, one of them current, in the shape ZeroMind answers an account's appearance in (`GET /v1/me/appearance`: `{ current, outfits }`), so an account's answer reads here as it is and the set writes back in the same form. Each outfit is `{ id, name, document, appearance_sha, created_at?, updated_at? }`; `current` is `{ outfit_id, appearance_sha, version }` or nil. The set answers `:save(name, doc, { makeCurrent? })`, `:get(idOrName)`, `:list()`, `:wear(idOrName | nil)`, `:current()` (the current outfit), `:remove(idOrName)` and `:toJson()`.

argtypedescription
answerany?Optional `{ current, outfits }` table or its JSON text to start from.

examples

local set = avatarAppearance.outfits(); set:save("Pirate", doc, { makeCurrent = true })

find(self: any, key: any) → void

argtypedescription
selfany
keyany

bump(self: any, outfit: any?) → void

argtypedescription
selfany
outfitany?

save(self: any, name: string, doc: any, opts: any?) → any

argtypedescription
selfany
namestring
docany
optsany?

get(self: any, key: string) → any

argtypedescription
selfany
keystring

list(self: any) → void

argtypedescription
selfany

wear(self: any, key: string?) → any

argtypedescription
selfany
keystring?

current(self: any) → any

argtypedescription
selfany

remove(self: any, key: string) → boolean

argtypedescription
selfany
keystring

toJson(self: any) → string

argtypedescription
selfany

accountCall(req: { [string]: any }) → any

Run `req` on the signed-in person's account (`zeromind.appearance`) and wait for its outcome: `{ ok = true, result }` or `{ ok = false, error, declined?, offline?, status?, code? }`.

argtypedescription
req{ [string]: any }

lookOf(result: any, set: any) → void

The document the account wears from a read's result: the current outfit's (its stored bytes, checked against the address the account names, else the document the outfit list carries), else the profile descriptor's, else none. Answers `doc?, from?`.

argtypedescription
resultany
setany

accountAppearance(opts: any?) → any

The signed-in person's appearance as their account keeps it: the outfits they saved (an `outfits` set holding the account's answer), the current one, and the look they wear, which is the current outfit's document, else the document their profile `avatar_descriptor` maps to (`fromDescriptor`), else none. An agent signed in as itself reads the outfits of the person it acts for, and its own profile's descriptor. A read asks nobody. Answers again from the last read for `accountHoldSeconds`. Yields while ZeroMind is read. `"outfit"` or `"descriptor"`, `address` the look's address), or `{ ok = false, error, offline? }`: an engine that booted offline is signed in to no account.

argtypedescription
optsany?Optional `{ fresh = true }` to read ZeroMind whatever was read before.

examples

local me = avatarAppearance.accountAppearance(); if me.ok then print(me.from, me.address) end

localAvatar( ) → string

The local player's avatar root, or nil while none is bound.

wearAccountLook(root: any?, opts: any?) → any

Wear the signed-in person's account look on an avatar root: the `Appearance` component's document becomes the look `accountAppearance` answers, and every peer composes it; with no look on the account the document is emptied and the avatar returns to how it stood. A game's override rules on the component stay as they are. A player wears their account look when their body binds; this wears it again, on that body or another. Yields while the account is read. the local player's avatar when left out. `{ ok = false, error, offline? }`.

argtypedescription
rootany?Optional avatar root (an EntityRef or id, the entity carrying `Humanoid`);
optsany?Optional `{ fresh = true }` to read the account anew.

examples

local r = avatarAppearance.wearAccountLook(); print(r.ok, r.address)

outfitId(key: any) → void

An outfit key as the account's id: an id the account keeps, or the id of the outfit named `key`. Answers `id?, error?, offline?`.

argtypedescription
keyany

rewearLocal( ) → void

After a write that may have changed the current outfit: the next read asks ZeroMind, and the local player wears the account's look again, so the other peers see the change.

saveOutfit(name: string, doc: any, opts: any?) → any

Save `doc` as the outfit `name` on the signed-in person's account, over the outfit of that name when the account keeps one, and with `makeCurrent` wear it: the local player then wears it and every peer sees it. The engine asks the person in its own dialog first, whoever calls; ZeroMind refuses it to an agent's own account (`AGENT_APPROVAL_REQUIRED`). Raises when `doc` breaks a rule. Yields until the person answers and ZeroMind does. declined?, offline?, status?, code? }`.

argtypedescription
namestringThe outfit's name (1 to `limits.outfitName` characters).
docanyThe document (`validate` must pass).
optsany?Optional `{ makeCurrent = true }`.

examples

local r = avatarAppearance.saveOutfit("Pirate", doc, { makeCurrent = true })

wearOutfit(key: string?) → any

Wear one of the signed-in person's outfits, by id or name, or none (`nil`): the account's current outfit changes, the local player wears it (or, with none, the profile's look) and every peer sees it. The engine asks the person in its own dialog first. Yields.

argtypedescription
keystring?The outfit's id or name, or nil to wear none.

examples

avatarAppearance.wearOutfit("Pirate")

deleteOutfit(key: string) → any

Delete one of the signed-in person's outfits, by id or name. Deleting the current outfit leaves none current, and the local player then wears the profile's look. The engine asks the person in its own dialog first. Yields.

argtypedescription
keystringThe outfit's id or name.

examples

avatarAppearance.deleteOutfit("Pirate")

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.

74+items
·
assettype · born here
❒asset
# Module (asset type) A module is a reusable, stateless (or globally-stateful) Luau library that other code pulls in with `require()`. Modules are the unit of factored-out logic in a world: helpers, math libraries, format parsers, registries, shared algorithms. ## When to use one - You have logic you want to share across multiple components, services, scenes, or tools. - You have a registry, lookup table, or shared cache that callers all read from / write to. - You want a stable API surface (`M.fn`) other code can depend on. If the logic is bound to one entity, use a `.component`. If you want a named UI of fields rather than functions, use a `.preset`. ## Where it lives - Source: `/zero/source/.../<name>.module/` - Identity: the source path with `/` written as `.` and each segment's type suffix dropped — `/zero/source/demo/beats.module` is `demo.beats`, and `/zero/source/kit.package/beats.module` is `kit.beats`, the container's name kept and its `.package` suffix gone. `asset.create` returns this string, `asset.resolve(...).identity` reads it back, and the `require` forms below write it as `<identity>`. - Folder shape: - `init.luau` (or `init.lua`) — module body. **Required.** Returns a table (conventionally named `M`). - `README.md` — instance-level documentation. **Required.** - `.metadata` — agent-editable tags + free-form fields. **Required.** ## How to create one ```luau asset.create("module", "<name>") -- Creates: /zero/source/<name>.module/ -- init.luau (canonical `local M = {} … return M`) -- README.md (instance README template) -- `folder` places it in a subfolder of /source, and that subfolder -- leads the identity: `{ folder = "lib" }` produces `lib.<name>`. -- `into` authors it inside a resolved container (a package, a toolbox), -- whose own identity leads the same way: asset.create("module", "<name>", { folder = "lib" }) asset.create("module", "<name>", { into = asset.resolve("myPkg.package") }) ``` ## How it operates 1. **Registration.** Writing `init.luau` into a `.module/` folder indexes the asset and registers the module path with the resolver. 2. **Loading.** The first `require("<identity>")` runs the file's body and caches the returned table. Subsequent requires from anywhere return the **same table** — this is the shared-state lever for "module-local" registries. The body runs in an environment of the module's own: a name it declares without `local` is readable by the module's own functions and by no other script, so an export reaches its callers through the returned table and nothing else. Requiring a component's folder runs its chunk the same way, once, and its `update`, `start` and `public` stay in that environment; a component runs on an entity through `entity(id).component.add(name)`. 3. **Hot reload.** Editing the file re-runs the module body and folds what it returns into the table already loaded, so that table keeps its identity: a caller that captured it with `require` reads the new source's functions and values through the reference it already holds, and a later `require` returns that same table. A key the new source drops goes away; a key something set at runtime stays. The body's own `local`s start again from their initial values, so state that must outlive an edit lives in `modules.state()` (`guides { path: "core/scripting-and-tasks" }`). 4. **Identity resolution.** A module is reached by its `<identity>`, and where the caller lives decides which spelling of it resolves. For a module in a **world**, from a caller in that same world — another module, a component, a scene entrypoint, or an `execute` chunk: - `require("<identity>")` — the identity on its own, resolved against the caller's own root. It carries every folder segment, so a module created with `{ folder = "demo" }` is `require("demo.beats")`. - `require("@root::<identity>")` — the same root-relative resolution, written out. - `require(".sibling")` — a module in the same folder, by its bare name; `..name` steps up one folder, `...name` two. Logs, stack traces and hot-reload notices name that same module `@local.source.<identity>` — its key under the world source root. The `<identity>` tail of that key is the form above, so a trace reading `@local.source.demo.beats` is `require("demo.beats")`. For a module in a **library** — content under `/zero/source/libs/@<lib>/` — `@<lib>::` addresses that library's root from anywhere: `require("@builtin::modules.transform")`. Mounting a world as a library moves its files under such a root and flips the caller root to `@<lib>::`, which is what keeps the root-relative forms above resolving across the move. ## Discovery - `asset.list("module")` — every registered module. - `asset.inspect("<name>")` — public functions, source path, this type README. - `ls /zero/source/<name>.module` lists the files the folder holds. ## Authoring conventions - Return a single `M` table from `init.luau`. Top-level statements with side effects run on first require — useful for one-time initialization, dangerous if they touch the engine before it's ready. - Write exported functions as `typed function`, not `function`: the argument types are enforced at the call and the checker knows the signature, so a caller's mistake is reported where they made it. - Annotate exported functions with `--!desc` / `--!arg` / `--!return` / `--!example` so the LSP, `tools.list`, and `asset.inspect` surface them. A function with no `--!desc` is reachable only by someone already reading this file. - Declare a VALUE with `Field.<kind>(default, mode, description)`, and a table whose members are reached through a metatable with `--!members <TypeName>` — the latter gives the surface its accepted member set, its type, and its documentation from one table. See `guides { path: "core/authoring" }` for all four rules and `modules/api/engine/entity.module/members.module` for a worked member table. - Keep module state in module-local upvalues or in `modules.state()`. A name the body declares without `local` lives in the module's environment, which every run of the module shares: a function the previous run left in place reads what the reload assigned. Module-locals start again from their initial values with each hot reload; the table `modules.state()` returns is the same table on both sides of every reload. - Prefer focused modules over kitchen-sink modules. If two halves of a module have no shared state, split them. ## Common pitfalls - **Cyclic requires.** A `require` chain that loops will return the partial table (the half built before the cycle was detected). Design for one-way dependencies. - **Engine-time side effects.** Don't `entity.spawn` at module top-level — the engine may not be ready. Expose an `M.init` and call it from a scene entrypoint. - **Hot-reload + module-local cache.** A module that caches expensive computation in upvalues loses that cache on reload — fine for dev, but be aware in performance work. - **`init.lua` vs `init.luau`.** Either works, `.luau` is canonical. - **Writing one while play runs.** A `/source` write made while play is running lands on the play shadow, and a guarded play-exit discards it unless it is kept. One `.module` write shadows `init.luau`, the `README.md` and the `.metadata` together. `vfs.write(path, bytes, { durable = true })` skips the shadow, and `vfs.promotePlayShadow` keeps what is already on it — the `core/vfs` guide has the model and what each route costs. ## Related types - `.component` — for entity-bound state + lifecycle hooks. - `.service` — generates content you don't have yet (a mesh, sound, texture, …) via a metered provider. - `.tool` — for a single agent-callable function with a YAML schema. - `.package` — to group several modules + components + scenes into one shippable folder. ## In the Inspector Exports: what the module exports (name, kind, signature), parsed from its source without running it, with **Check** (the LSP's diagnostics for its entry file) and **Open**.
▲ 0↑ born
◇
component · born here
❒asset
# Model Loads and displays a 3D mesh on an entity. Disabling the component hides the mesh. Supports procedural meshes (`cube`, `sphere`, ...), model files, and remote URLs. Tint and outline are shader effects applied to the mesh. **Material lives on this component.** There is no standalone `Material` component — a material only renders where there is a mesh to render it on, so the `material` field is part of Model (and SkinnedModel). Set it at add time or assign the field later; properties are registry-wide. Public fields: `model`, `material` (`AssetRef<material>`), `tintR/G/B`, `tintBlend`, `outlineR/G/B`, `outlineIntensity`, `outlineOccluded` (`"hide"`, the default, hides the rim where geometry stands in front of the mesh; `"dashed"` draws it there in dashes, the `occluded` choice of `@builtin::modules.outline`). Methods: `:setTint(color, blend?)` (color: `{r, g, b}` array or `{r=, g=, b=}` map), `:clearTint()`, `:setOutline(color, intensity?)`, `:clearOutline()`, `:setMaterialProperty(prop, value)`, `:getMaterialProperty(prop)`, `:getMaterialPropertyNames()`. ```luau entity(id).component.add("Model", { model = "cube", material = "gold" }) entity(id).component.get("Model").material = "checkerboard" -- swap material entity(id).component.get("Model"):setTint({1, 0, 0}, 0.5) entity(id).component.get("Model"):setMaterialProperty("roughness", 0.2) ``` **Tint is synced.** Every `tint*` field replicates, so `:setTint` is the colour every participant sees. A colour that changes every frame on many entities (a stress map, a heat map, a damage flash, per instance colour) belongs in an instance-data lane instead: wear `@builtin::materials.instance_color` (or `instance_color_unlit`) and write `renderer.instanceData.set(id, 2, r, g, b, coverage)`, which replicates nothing and costs about a twentieth of a tint write. `guides { path = "topics/rendering-instance-data" }` has the lane layout.
▲ 0↑ born
◇
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
◇
component · born here
❒asset
# Text3D Renders text in 3D world space. The quad auto-sizes to fit the text content and never clips. Positioning works like TextMeshPro: `offsetX/Y/Z` is a local offset from the entity, `pivotX/pivotY` is the anchor within the quad, and `billboard` makes it face the camera. With `billboard = false` the text reads from the entity's own forward, the local -Z that `transform.forward` reports and that `entity:lookAt` aims. Sizing — three fields, two jobs: - `worldHeight` — the quad's height in **world units** (default `1.0`). This is the one field that resizes a label, and it holds that height under every transform between the label and the world: a label hung off a shrunken detail box on a model comes out the size it asked for, and so does one whose own entity carries a `localScale`. Width follows the rasterised text's aspect. Measure the result with `getWorldSize()`, which reports the extent the quad is drawn at. - `fontSize` — the **raster resolution** in texels (default `32`). Higher values sharpen the texture and change wrapping against `maxWidth`; the world-space size stays `worldHeight`. - `scale` — rasterisation scale multiplier applied at raster time. Resolution only, like `fontSize`. `maxWidth` is the width the text wraps at, in pixels of the raster `fontSize` states; `0` keeps it on one line. A label already drawn is laid out again when the field is written, so a caller re-wraps one label to line after line rather than making a label per line. `alphaCutoff` decides whether the letters are a surface. At `0` (the default) the text is pure alpha blending: it draws over what is behind it and leaves the depth buffer alone, so a screen-space effect that reads scene depth — volumetric fog, screen-space shadows — integrates the whole distance behind the letters and the text sits inside it. Above `0`, coverage at or over the threshold is drawn opaque and written to depth, so those effects stop at the glyph shape instead. `0.5` reads well for most fonts; higher thins the letters, lower keeps more of the antialiased edge. Public fields: `content`, `fontSize`, `color`, `alignment`, `richText`, `maxWidth`, `outline`, `outlineColor`, `background`, `scale`, `worldHeight`, `alphaCutoff`, `shadowX/Y`, `fontFamily`, `weight`, `slant`, `offsetX/Y/Z`, `pivotX/Y`, `billboard`. `weight` and `slant` are strings (`"regular"` / `"bold"`, `"normal"` / `"italic"`). Methods: `setText(content)`, `setStyle(options)`, `getText()`, `getSize()`, `getWorldSize()`, `refresh()`. ```luau entity(id).component.add("Text3D", { content = "Hello World" }) entity(id).component.add("Text3D", { content = "HP: 100", worldHeight = 0.5, fontSize = 96, color = "red", offsetY = 2.0, pivotY = 0 }) -- A title that keeps its letters crisp through volumetric fog. entity(id).component.add("Text3D", { content = "RAISING", worldHeight = 3.0, alphaCutoff = 0.5 }) ``` A label that is not showing, or came out in a face you did not ask for, reads back out of the text system: `text.observe()` lists every live text object with the entity that owns it and the texture its raster is in, and `text.face(h)` names the font face the shaper actually used against the `fontFamily` that was requested. `topics/text` walks both.
▲ 0↑ born
◇
component · born here
❒asset
# PlayerNameLabel Drives this entity's `Text3D` with the owning player's name, read from the nearest ancestor `PlayerAvatar`'s synced `displayName` so every peer renders the same name without a local registry lookup. The label re-rasterises when the display name changes, and in play it hides itself on the local player's own avatar, since name labels exist so other players are identifiable. A label shows a name or nothing: an avatar with no `PlayerAvatar` (a stock avatar placed as a non-player character) or one whose `displayName` is empty has its label's text emptied and the label hidden. Location: `src/lua/lib/components/PlayerNameLabel.component`
▲ 0↑ born
◇
component · born here
❒asset
# Appearance Carries how the person behind an avatar wears it, as one appearance document (`modules.avatarAppearance`), on the avatar root: the entity carrying `Humanoid`, which is `player.avatar` for a player. The document and a game's override rules are synced data of a few hundred bytes: every peer receives them and composes the same character on its own engine, so no mesh, bone or worn item is sent. Writing a new document recomposes only what differs from the one before. ```luau local avatarAppearance = require("@builtin::modules.avatarAppearance") local doc = avatarAppearance.new("@builtin::avatars.humanoid") doc.body_shape = { height = 1.9 } doc.colours = { body = "#3366cc" } doc.worn = { { slot = "hat", item = "@builtin::meshes.cone", adjust = { y = 0.05, scale = 0.2 } } } local body = layers.active.players.localPlayer.avatar -- the avatar root (it carries Humanoid) body.component.add("Appearance", {}) local look = body.component.get("Appearance") look:wear(doc) -- the person's document look:override({ worn = { hat = "my_helmet" } }) -- the game's view of it print(look:size(), look:address(), look:get().worn[1].item) ``` - `document` (synced): the person's document as its canonical JSON. Emptied (`:wear(nil)`), the avatar returns to how it stood before the first document. - `rules` (synced): the game's override rules as JSON; the person's document stays as it is. - `:wear(doc | nil)`, `:get()`, `:effective()`, `:override(rules | nil)`, `:address()`, `:size()`, `:emotes()`, `:composed()`. Location: `src/lua/lib/components/Appearance.component`
▲ 0↑ born
▣
module · born here
❒asset
# avatarStandard The humanoid avatar standard every carried avatar is built around, so a game can rely on the avatar a visitor arrives with: where a hat or a held item goes, where the eyes are, which expressions the face has, and how tall the body is. ```luau local avatarStandard = require("@builtin::modules.avatarStandard") local d = asset.resolve("my_hero", "avatar"):descriptor() -- an avatar asset local d2 = entity(playerId).component.get("Humanoid"):descriptor() -- a live player's body local v = asset.resolve("my_hero", "avatar"):validate() for _, p in v.problems do print(p.rule, p.name, p.message) end ``` ## The standard - **Bones**: the 55 VRM 1.0 humanoid bones (`avatarStandard.bones`), each filled through the humanoid avatar type's structural detection whatever the rig names its bones. 15 are required: `hips`, `spine`, `head`, and per side `UpperLeg`, `LowerLeg`, `Foot`, `UpperArm`, `LowerArm`, `Hand`. `avatarStandard.roleOf` maps a VRM name to the humanoid role (`rightHand` -> `righthand`). The eyes and the jaw are found by name among the head's own bones. - **Attachment points**: 19 (`avatarStandard.points`): `origin`, `hat`, `hair`, `faceFront`, `faceCenter`, `neckBase`, `leftCollar`, `rightCollar`, `leftShoulderTop`, `rightShoulderTop`, `bodyFront`, `bodyBack`, `waistFront`, `waistCenter`, `waistBack`, `leftGrip`, `rightGrip`, `leftSole`, `rightSole`. Each is placed from the body's own proportions, and its frame is the avatar's axes on the body standing in a T-pose with its palms down (+Y up, +Z forward, +X the body's left), carried by the anatomy of the bone under it. A grip's +Z leaves the fist on the thumb's side; a sole's +Z points toward the toes. - **Viewpoint**: between the eyes when the body has eye bones, else in front of the head at eye level. - **Expressions** (`avatarStandard.expressions`): the VRM presets are the required face tier (`aa ih ou ee oh`, `blink blinkLeft blinkRight`, `lookUp lookDown lookLeft lookRight`, `happy angry sad relaxed surprised`, `neutral`); `neutral` is the face at rest and the look presets are met by eye bones too. The Oculus 15 visemes and ARKit's 52 shapes are optional tiers. A blend shape answers a preset by its name (case and separators ignored, VRChat's `vrc.v_` viseme prefix read); an avatar whose shapes are named otherwise maps them in `avatar.json`: `"expressions": { "aa": "Mouth_A", "blink": { "shape": "Eyes_Closed", "overrideMouth": "block" } }` (`overrideBlink`, `overrideLookAt`, `overrideMouth` take `none`, `block` or `blend`). - **Height band**: `avatarStandard.heightBand`, 0.5 to 3 m. ## The descriptor Positions and rotations are in the avatar's own space: metres, +Y up, +Z the way the body faces, +X its left, from the ground beneath its hips. Up is the body's own vertical (an avatar asset's bundle stands it on +Y; a live avatar stands on its root's up), so a spine that leans in the rig leans in the descriptor too. | Field | Holds | |---|---| | `standard` | `"humanoid/1"` | | `conforms` | true when the body breaks no rule | | `bones` | `{ [vrmBone] = boneName }` for every VRM bone the body fills | | `chains` | the body's optional chains by class (`hair`, `ear`, `tail`, `chest`, `skirt`, `face`, `attachment`, ...), each `{ root, bones }` | | `points` | `{ [point] = { role, bone, position, rotation, local } }`; `local` is the same frame in the carrying bone's own space | | `viewpoint` | `{ role, bone, position, rotation, local, source }`, `source` `"eyes"` or `"estimate"` | | `expressions` | `vrm` (`{ [preset] = { shape?, source, override } }`), `visemes`, `arkit` (`{ [name] = shape }`), `missing` (the VRM presets nothing answers), `tiers` (`{ vrm, visemes, arkit }`, each true when the body has the whole tier) | | `height`, `bounds`, `band` | the body's height (ground to crown), the extent of its skeleton, and the band the standard takes; `height` and `bounds` are nil for a body with no humanoid frame | | `proportions` | metres, for sizing what the body wears: `head` (crown above the head joint), `shoulderWidth`, `hipWidth` (between the upper-arm and upper-leg joints), `torso` (hips to the base of the neck), `arm` (shoulder joint to wrist), `leg` (hip joint to the ground) | | `scale` | 1 for an asset; for a live body, its avatar root's world scale, so it stands `height * scale` tall in the world | | `problems` | every rule broken, each `{ rule, name, message }`, `rule` one of `type`, `bone`, `point`, `expression`, `height` | `validate` answers `{ ok, problems, summary }`; `summary` says the problems in one line per broken rule ("missing 3 required bones: rightUpperArm, rightLowerArm, rightHand"), in the player's language, for showing a player why their avatar was turned away. The lines come from the library's `avatar_standard` catalog; a world words them its own way with an `avatar_standard.json` of its own (`summary.bone_one`, `summary.bone_other`, `summary.height`, ...). A live body is held to the height band at the height it stands in the world (`height * scale`). `validate(body, { rules })` holds a body to the rules a game relies on (`avatarStandard.rules`: `type`, `bone`, `point`, `expression`, `height`; all of them by default). A game whose players need no faces leaves out `expression`: ```luau local v = h:validate({ rules = { "type", "bone", "point", "height" } }) ``` `describe(body)` takes an avatar asset or a live avatar entity, which both state the body's units; `validate(body)` answers `{ ok, problems }`. A bare `rig` states no units (the built-in Synty rigs are in centimetres), so describe one through an avatar that wears its body, or with `describeStructure(structure, opts)` (`opts`: `qualification`, `unit` in metres per rig unit, `up` the body's vertical in the structure's space, `morphTargets`, `expressions`). Without `up` the avatar's space stands on the humanoid frame's up, from the hips toward the chest. Seat items on the points with `Humanoid:attach(point, itemId, opts)` (the Humanoid component's README); `Humanoid:attach("viewpoint", cameraId)` seats a first-person camera at the eyes.
▲ 0↑ born
◇
component · born here
❒asset
# Asset Promote the bundle's spawned children from temporary to permanent scene state and remove the Asset component, "baking" the bundle's contents directly into the owning scene. Subsequent saves persist the baked entities verbatim and stop replaying the bundle template. Location: `src/lua/lib/components/Asset.component`
▲ 0↑ born
◇
component · born here
❒asset
# CharacterController Kinematic mover. Integrates velocity against gravity, walls, ceilings and ground, and writes the result to the entity's position every frame. ## Driving it The character moves on a public input bus: `inputX`, `inputZ` and `inputJump`. Each frame the controller reads the bus, moves on what it found, and then refills it for the next frame. **Only the local player's body answers the player's controls.** The character the local player is bound to (`layers.active.players.localPlayer.avatar`) refills its bus from the `move` axis and the `sprint` / `jump` actions of its input map, so the map drives it whenever nothing else does. Every other character holds no map and refills its bus with no movement: an NPC, a mannequin, a preview or another player's body stands where it is until something writes its bus. The player's spawn binds the body for you; to hand the controls to a character you made, bind it: ```luau layers.active.players.localPlayer.avatar = entity(bodyId) ``` The character takes the map up on the frame after the bind and gives it back when the binding moves to another body. Anything else takes the character over by writing those three fields from its own `update()` — an AI brain, a networked peer, a replay, or gameplay code that wants the character committed during an attack. The write works from **any** `executionOrder`, because the refill happens after the read: whatever is in the bus when the controller next reads it is what the character does. - A writer ahead of the controller (`executionOrder` below `-100`) is acted on the same frame. - A writer behind it is acted on the next frame. - Stop writing, and the character stops one frame later; on the local player's body the map has it back instead. - Pausing gameplay empties the bus, so a character frozen mid-stride stands where it was paused and a writer that had it committed says so again. `inputX` / `inputZ` are a world-space velocity in units per second — the controller applies them as they are, so scale them yourself rather than expecting `moveSpeed` to. `inputJump` asks for one jump and the next update consumes it. A component that walks the character due north, whatever the input map says: ```lua -- Northbound.component/init.luau declare { executionOrder = 50 } -- anywhere works; 50 runs after the controller public = { speed = Field.number(4.0, Sync), } function update(_dt: number) local cc = public.entity.component.get("CharacterController") if cc == nil then return end cc.inputX = 0 cc.inputZ = -public.speed end ``` `WASDInput` is the same pattern shipped as a component: it reads an input map of its own and writes the bus of whatever component `targetComponent` names, which is how a mover that reads no controls of its own gets driven. On a CharacterController — which reads `move`, `sprint` and `jump` from its own `inputMap` — a WASDInput writes the bus every frame at its own `speed`, and that is the speed the character walks at. `CharacterController.install` adds one when `input = true` asks for it. ## The control scheme `inputMap` is the scheme the character answers to. It reads three controls from it, each on its own: - `move` — an axis2, projected against the active viewport camera so "forward" is into the screen. - `sprint` — held, multiplies `moveSpeed` by `sprintMultiplier`. - `jump` — pressed, asks for one jump. A map declaring only some of the three drives the character with those: a scheme with no `sprint` holds one gait, a scheme with no `jump` stays on the ground. The character logs which controls the map left out and names the map, so a game with three verbs ships a three-control scheme. A field naming no map leaves the character answering nothing, and logs that too. **Repointing it on a live character takes on the next frame.** The map the character was holding is stood down — its controls leave the live set and its touch buttons leave the screen — and the map named here is taken up in its place: ```luau entity(bodyId).component.get("CharacterController").inputMap = asset.resolve("mygame.input.run", "inputMap") ``` Assigning the map the character already holds changes nothing, so re-stating the scheme leaves the live set where it is. While gameplay is paused the character holds no map at all (the editor's camera has the controls), and it takes whatever `inputMap` names when play resumes. A character that is not the local player's body holds no map either, and takes whatever `inputMap` names when it is bound as that body. ## Platforms, belts and the contact filter The character meets the surfaces content declares on colliders the way a rigid body does. Its ground, wall and ceiling queries are cast for the character's own entity as their mover (`Physics.raycast(..., { mover = id })` and the same option on the shape casts), so the contact rules the physics step applies to bodies apply to it too: - **One-way platforms.** A collider whose `oneWay` points up holds the character from above only: it jumps up through the platform from below and lands on top of it, and walks through its sides. - **Dropping through.** `Physics.passThrough(character)` drops it through the one-way colliders it stands on (or, with a second argument, only those that entity owns). It falls through under its own gravity and meets each again once it is clear of it. ```luau Physics.passThrough(player) -- drop through what it stands on Physics.passThrough(player, platform) -- drop through this platform alone ``` - **Moving surfaces.** Standing on a collider whose `surfaceVelocity` moves (a conveyor belt, a treadmill, an escalator) carries the character at that velocity on top of its own walk. It keeps the carry as momentum when it jumps or walks off, and air control (`airControlFactor`) takes it back toward the walk it asks for. - **Moving bodies.** Standing on a body that itself moves or turns (a lift, a moving platform, a turntable, a raft, a ship's deck, a train car) carries the character with it: each frame the point under its feet goes where the body took it, and the character turns with the body's turn about up, with its own walk on top. It rises and descends with a lift without leaving the ground, and keeps the body's motion at its feet as momentum when it jumps or walks off. In the air it goes on moving with that motion until it lands, the way a crate thrown off the deck does: air control (`airControlFactor`) steers its walk relative to it, so a jump in place on a moving deck comes down on the spot it left, and a wall it meets in the air stops the part of it the wall is in the way of. A kinematic body a script moves (`localPosition` writes, `Physics.setVelocity`), a dynamic body the simulation moves and a transform something animates all carry it alike. The body is read where the frame draws it (`Physics.drawnPose`), and the character is seated on the ground as drawn, so the two stay in step on screen at any frame rate and physics tick rate. A body a script moves after this component's `update` (an `executionOrder` above -100, or a task) carries the character on the next frame. The momentum a kinematic body or an animated transform leaves the character with is how fast it carried the feet over the last tenth of a second (and at least the last six frames), however the frames fell against the physics ticks, and a body that vanishes from under the character leaves it the same. A character something else moves (a teleport, a respawn, a script writing its position) stands where it was put and rides nothing until it stands on a body again. ```luau local lift = entity.spawn("lift") lift.component.add("BoxCollider", { half = { 1.5, 0.1, 1.5 } }) lift.component.add("Physics", { kind = "kinematic" }) Physics.setVelocity(lift.id, 0, 1, 0) -- the character on it rides up Physics.setAngularVelocity(lift.id, 0, 1, 0) -- and turns with it ``` - **The contact filter.** Give the character a collider with a `contactTag` (a trigger capsule is enough) and `Physics.setContactFilter` answers its pairs: a collider whose tag the filter answers `"ignore"` or `"sensor"` with the character's tag is one the character walks through. ```luau player.component.add("CapsuleCollider", { isTrigger = true, contactTag = "player" }) Physics.setContactFilter("player", "ghostWall", "ignore") ``` ## Other characters Characters meet one another as solid bodies. Every entity carrying a `CharacterController` is an upright capsule of its `radius` and `height` to every other character's wall pass (`physics.characters`), so two characters walking into each other stop a skin apart, a character meeting another off centre slides around it, and `blocked` reads true while a walk presses into another character. The same holds for the local player, an NPC and another player's body. A character is a body while its entity is active and its controller enabled: one set inactive (`entity(id):setActive(false)`) or with its controller disabled (`enabled = false`) lets the others walk through it until it is switched back on. The push rule: - A walk never moves another character. Each peer moves only the characters it owns, against where it sees the others, so two players' bodies meet on both peers' screens. - Two characters that overlap (placed into one another, two spawned at one point, a body the network shows a frame late) move apart at up to 2 m/s each, each taking half of the overlap, and never through a wall. A pair pressed together stands still a skin apart. - A character gives way to no body moving into it: the one walking in is the one stopped, on the peer that moves it, so a player walking into a standing one never drives it along, however late each peer sees the other. - Only bodies sharing some height meet: a character jumping over another passes above it, and one coming down onto another's head is moved off it to the side. Which characters pass through which is the contact filter's to say, by each character's `contactTag` (`"character"` unless content names another): ```luau Physics.setContactFilter("character", "character", "ignore") -- nobody blocks anybody ghost.component.get("CharacterController").contactTag = "ghost" Physics.setContactFilter("ghost", "character", "ignore") -- the ghost walks through people Physics.setContactFilter("redTeam", "redTeam", "ignore") -- teammates pass, foes block ``` ## Triggers, pickups and the bodies it walks into The character holds no rigid body: it states its capsule (`Physics.setWaterVolume`), `height` tall and `radius` round, standing on its feet. That capsule is how the rest of the world meets it: - **Triggers and pickups.** A trigger collider hears the character enter and leave it as it hears a body (`Physics.onTrigger(zone, fn)`, with `other` the character's entity), and a listener on the character (`Physics.onTrigger(character, fn)`) hears every trigger it goes through. Every engine the character exists in hears it, the remote players' bodies included, so a zone counted on each peer counts every player. A trigger on an entity beneath the character (a sensor it carries) rides with it and does not hear it. - **Water.** `Physics.onWater` hears it go in and out of the water and `Physics.immersion` reads how deep it stands. - **Pushing.** A dynamic body the walk runs into is pushed along the walk: the walk stops at it as at a wall, and the body is given the impulse that brings its speed along the walk up to the walk's, with at most `pushForce` newtons (400 by default) behind it. On level ground a body moves once `pushForce` passes its friction coefficient times its weight, so at the default a 5 kg crate goes along at the walk with the character behind it and a 500 kg one stands like a wall. `pushForce = 0` makes every body a wall. - **Bodies moving into it.** A body that moves into the character puts it back outside, as a wall that moved into it does. ```luau local player = layers.active.players.localPlayer.avatar Physics.onTrigger(coin, function(e) if e.kind == "enter" and e.other == player.id then collect(coin) end end) player.component.get("CharacterController").pushForce = 150 -- a weaker shove ``` ## Telemetry These read back what the mover did on the frame just simulated: - `grounded` — standing on ground no steeper than `maxSlopeAngle`. - `falling` — in the air and descending. - `sliding` — on ground too steep to stand on, being carried down it. - `blocked` — the character asked to move horizontally and the wall pass left it with none of that movement: pressed into a wall, or wedged where two surfaces meet. This is what tells a character standing still apart from one whose walk is being refused. - `slopeAngle` — the angle, in degrees, of the ground under it. - `velocityX` / `velocityY` / `velocityZ` / `horizontalSpeed` — its velocity. - `jumpCount` — jumps used since it last landed.
▲ 0↑ born
◇
component · born here
❒asset
# Humanoid Marker component for entities carrying a skeleton conforming to the standard humanoid bone layout (Synty / Unreal-Mannequin convention). Content reads a humanoid body's bones and attachment sockets through this component instead of re-walking the descendant tree, and seats items on those sockets with `:attach`. ## Bone naming convention ``` Hips Spine_01 → Spine_02 → Spine_03 → Neck → Head └ Eyes, Eyebrows, Jaw UpperLeg_R / UpperLeg_L LowerLeg_R / LowerLeg_L Ankle_R / Ankle_L Ball_R / Ball_L → Toes_R / Toes_L Clavicle_R / Clavicle_L Shoulder_R / Shoulder_L Elbow_R / Elbow_L Hand_R / Hand_L IndexFinger_01..04 / Thumb_01..04 / Finger_01..04 ``` Mixamo / Unity-Humanoid imports go through a bone-rename pass at import time (tracked separately). ## Fields | Field | Type | Notes | |---|---|---| | `height` | number | Foot-to-head height in T-pose, metres. Default 1.8. | | `eye_height` | number | Foot-to-eyes height, metres. Default 1.65. | | `bones` | `{ [string]: entity }` | Computed; bone-name → entity-proxy map. Re-walks on read. | | `sockets` | `{ [string]: entity }` | Computed; role (`righthand`, `head`, …) → the bone filling it on this body, through the body's RetargetProfile. | ## Methods | Method | Returns | Notes | |---|---|---| | `:bone(name)` | `entity \| nil` | Nil-safe single-bone lookup; same as `self.bones[name]`. | | `:socket(point)` | `entity \| nil` | The bone at a role, or at an exact bone name. | | `:attach(point, childId, opts?)` | `entity \| nil` | Seats `childId` on the socket bone at the socket's frame, moved by `opts.position` / `opts.rotation` / `opts.scale`. Position and scale are metres in the humanoid's own space, whatever bone units the rig was authored in; rotation is relative to the bone, as a quaternion `{ x, y, z, w }` or Euler degrees `{ pitch, yaw, roll }`. An option outside those three, or a value in none of those forms, raises with the item left as it was. Returns the socket bone. | | `:attachments()` | `{ { id, point, position, rotation, scale } }` | Every item seated with `attach`, with the point and transform it was seated with. An avatar body swap re-seats each on the new body. | ## Usage ```luau -- Read a specific bone local h = entity(playerId).component.get("Humanoid") local head = h.bones.Head -- entity proxy local handR = h:bone("Hand_R") -- nil-safe lookup -- Seat a hat 12 cm above the head, on any humanoid body local hat = entity.spawn("hat") h:attach("head", hat.id, { position = { 0, 0.12, 0 } }) -- Read height for camera mounting local cam = entity.spawn("eye_cam", { parent = playerId }) cam.localPosition = { 0, h.eye_height, 0 } ``` ## Tag convention Bundles carrying a humanoid skeleton tag themselves with both `playerVisual` AND `humanoid` in their `.metadata`. Tooling can filter to humanoid-conforming visuals via `asset.list("bundle", nil, { fields = { tags = { "playerVisual", "humanoid" } } })`.
▲ 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
◇
component · born here
❒asset
# SkinnedModel Component that drives skinned model playback and animation graph integration. Like `Model`, it carries the `material` field (`AssetRef<material>`) — material lives on the model that renders it, not as a standalone component. Set it at add time or assign `entity(id).component.get("SkinnedModel").material = "..."` later; `:setMaterialProperty` / `:getMaterialProperty` / `:getMaterialPropertyNames` operate on the assigned material (registry-wide). **Tint is synced.** Every `tint*` field replicates, so `:setTint` is the colour every participant sees. A colour that changes every frame on many characters (a damage flash, a team colour, a heat map) belongs in an instance-data lane instead: wear `@builtin::materials.instance_color` (or `instance_color_unlit`) and write `renderer.instanceData.set(id, 2, r, g, b, coverage)`, which replicates nothing. `guides { path = "topics/rendering-instance-data" }` has the lane layout. ## Blend model `skinning` chooses how the pass combines a vertex's joint influences. - `"linear"` (default) averages the joint matrices themselves. The average of two rotations is not a rotation, so a strongly twisted joint loses volume toward its axis — at a 180° twist a limb collapses onto the axis entirely. - `"dualQuaternion"` averages the joints' rigid motions as unit dual quaternions and renormalises, so the blend is a rotation at every weight and the cross-section is carried through the twist. Non-uniform joint scale rides along as a separately blended stretch. It costs a quaternion extraction per influence, so it is worth setting on characters whose wrists, shoulders or spine twist far, and leaving off elsewhere. ```lua entity.find("hero").component.get("SkinnedModel").skinning = "dualQuaternion" ``` A rig at rest renders identically under either model. ## Render self-check A few frames after its mesh attaches, a SkinnedModel checks that the mesh names something the engine can draw (on the GPU, or held off the device until this display puts it back) and that the pose it is drawn in has not collapsed it: the posed vertices the skinning pass wrote are measured against the mesh's own bind-pose extent, so a 1 cm part of a prop is judged by its own size. A mesh that fails is swapped for the builtin ERROR marker, drawn un-skinned with the error material, and the reason is logged. Setting `model` again takes the marker down and checks the new mesh. `renderCheck()` answers the verdict: `{ state = "pending" | "passed" | "failed" | "skipped", reason }`. ```lua local v = entity.find("prop_part").component.get("SkinnedModel"):renderCheck() if v.state == "failed" then print(v.reason) end ```
▲ 0↑ born
·
assettype · born here
❒asset
# assetType (asset type) An asset type says what a kind of asset is: the files an asset of the kind is made of, the code that gives it behaviour, the interface a person uses to work with it, and how it is found, pictured and checked. A `<typename>.assetType/` folder declares a type called `<typename>`, and every `<name>.<typename>/` folder is an asset of it. `assetType` is itself a type, so a type is an asset like any other: it is created, versioned, installed and contributed the same way. ## Making a type `asset.create("assetType", "<typename>")` scaffolds a type. The type registers the moment its folder is written, anywhere under `/zero/source/`, and from then on `<name>.<typename>/` folders are its assets. An asset of a type that is not registered yet is not an asset, so make the type first. A type folder is a root: `~.x` in any file inside it names the type's own `x`, wherever the type is installed. Keep the type's whole implementation inside its folder and reach it that way. What a type folder must hold is set by this type's own `type.yaml`, the same way every type's `type.yaml` sets what its assets hold. `asset.validate` on a type reports anything missing, and the scaffold produces a folder that passes. ## What sets your type's schema (`type.yaml`) `type.yaml` is the structural contract every asset of the type is checked against. The keys below are the ones the engine reads; a key not listed here is ignored. | Key | What it controls | |---|---| | `suffix` | The folder suffix of the type's assets. Defaults to `.<typename>`. | | `primary` | The file or files that are the asset's content: what the asset resolves to when it is used. | | `entry_files`, `primary_aliases` | Further files that load as the asset or share its identity. | | `is_container` | Whether the suffix stays in the identities of what the asset holds. | | `is_opaque_walker` | Whether a walk of the tree stops at the asset and registers only its primary. | | `plural_dir`, `classify_exts` | Loose files in a folder of this name, or with these extensions, are assets of the type. | | `is_text_default` | Whether the asset's files are text unless stated otherwise. | | `broadcasts_subassets` | Whether assets nested inside an asset of the type are found by their own short name. | | `root` | `true` makes every asset of the type a root, so `~.x` inside one names that asset's own `x`. | | `contract_ref: { field, category }` | A key of the primary file that names another asset the asset is built on. | | `files: { required, optional }` | The files an asset holds (below). | | `allow_unlisted` | `false` reports every file the type does not declare. | | `aliases_from: [{ file, key }]` | Further names an asset answers to, read from its own files. | | `settings:` | Typed per-asset settings (below). | | `inspector:` | The interface people use for the type and its assets (below). | | `preview:` | How an asset is pictured (below). | | `references:` | Names of other assets the type's files carry (below). | | `indexing:` | What search reads for each asset (below). | | `describe:` | How a missing description is generated (below). | ### The files an asset holds Each entry under `files.required` or `files.optional` is `{ path, kind: file | folder, one_of_group?, content? }`. `*` in a path matches within one segment. Entries that share a `one_of_group` are satisfied by any one of them. `content` lists checks on the file's bytes: | Check | Passes when | |---|---| | `non_empty` | the file has content | | `json_field { key, type?, non_empty?, accept? }` | the JSON holds the key (a dotted path) with that shape | | `yaml_field { key, type?, non_empty?, accept? }` | the same for YAML | | `described { keys?, headings?, message? }` | the file says what the asset is (see "Ask your assets to say what they are") | Each check takes a `message`, which is what the author is told when it fails. ### Settings `settings: { values, schema: { type | instance, export? } }` gives every asset typed settings. `values` names the file an asset's values live in; `schema.type` declares one schema for the whole type, and `schema.instance` names a file each asset declares its own in. `asset.create` writes the resolved values, and a write to the values file reaches `onChange` with what changed. ## The human side (`inspector.luau`) A type is used by people through its Inspector, and without one the type is usable only from code. The Inspector is the type's interface for a person: for a procedural graph it is the graph editor, for a kit it is the tracking view of what the kit holds and what is still missing. Writing it is part of writing the type. `inspector: { type, instance? }` in `type.yaml` names the files. `type` is the interface for the type itself and for its assets; `instance` names a file an asset may ship to add its own. Each returns: ```luau return { sections = { { id = "graph", title = "Graph", build = function(ctx) ... end } }, replace = { contents = { ... } }, -- replace a default section by id order = { "graph", "contents" }, -- section order } ``` `build(ctx)` receives the asset and builds the section. A section's `title`, and the text its rows carry, is a string or an `i18n.text` value read from a catalog (`i18n.text("inspectors.mesh.title")`), which follows the editor's language. `asset.create("assetType", ...)` scaffolds a working `inspector.luau` to start from. `asset.validate` on a type that names no inspector, or names one that does not load, reports it. ## Say what your type is for (`about.yaml`) Every type carries an `about.yaml` that says what the type is for, in three plain-language texts: ```yaml intent: "Sets the typeface of the text in your game: UI, labels, signs and 3D lettering." function: "A font, from a TTF, OTF or WOFF file, made available to all of Zero's text, including 3D text." usage: "You choose it by name for your UI or your text, and the text appears in that typeface." ``` - **`intent`** is what the type is for in someone's game, in the words a game maker uses. Up to 800 bytes. - **`function`** is how it works today: what an asset of it is made of and what the engine does with it. Up to 1500 bytes. - **`usage`** is what a person or an agent does with one. Up to 1200 bytes. Write about the type as a whole, not one asset of it, and say what it does now. Agents read these texts to learn when to reach for the type and how; people searching find the type by them. The scaffold starts each text with `[[describe]]` and a note on what to write; a text that still starts that way counts as not written. `services describe` can write them. They show up in `asset.inspect` as `detail.about`, in `assetTypeRef:getAbout()`, at the end of the type's `types/<typename>` guide, and at the top of the type's Inspector. ## Ask your assets to say what they are A type can require each asset to carry a description: a file, written by the author or generated, saying what the asset is and what it is for. Declare it with a `described` check: ```yaml files: required: - path: "README.md" kind: "file" content: - { check: "described", message: "Say what this widget is for and where it goes." } ``` A file that is missing, empty or still has a line starting with `[[describe]]` fails the check, and so does a YAML file whose named `keys` are missing or over their `max_bytes`, or a Markdown file missing a named heading. `asset.validate` names the asset, and a push that carries it is refused with `message`. `services describe` finds such assets and writes their descriptions. `describe:` steers what is generated: ```yaml describe: guidance: "Say what the widget shows, what input it reacts to, and where it fits in a UI." examples: - "<identity of an asset of this type whose description reads well>" ``` An example is an asset of your type whose description is a true, written one, never a placeholder and never the asset being described; with none, leave `examples` empty. A type whose assets the model cannot perceive (a sound, a motion) says so in `guidance`, and the description is drawn only from what the asset's own files state. Start the file unwritten in your `template/`: a heading and one line starting with `[[describe]]`, never example content, which every new asset would carry verbatim. A type whose assets say what they are through their own content (a mesh, a texture) declares no check. ## The type's code (`behavior.luau`) `behavior.luau` returns one table. These are the keys the engine reads from it; anything else on the table is the type's own. ### What the type's assets can do | Key | Shape | What the engine does with it | |---|---|---| | `ref` | `{ [name] = function(self, ...) }` | Every function becomes a method on every asset of the type: `ref:name(...)`. | | `modules` | `{ [name] = require(".x") }` | Code the type's assets reach with `asset.containing(__FILE__).modules.<name>`. | | `events` | an events schema | Events an asset fires. Readers subscribe through `ref.events.<name>:connect(...)`; the type fires them. | | `refShapes` | `{ [method] = function(self) -> (typeExpr, source?) }` | The result type of a `ref` method for one particular asset (below). | | `namePattern` | a Lua pattern | The names `asset.create` accepts for the type's assets. Default `^[A-Za-z][A-Za-z0-9_]*$`. | | `derive` | `{ output, module, compute, fingerprint, matches?, required?, timeout? }` | A file computed from the asset when it is committed; a `required` one holds the commit until it lands. | Some `ref` names mean the same for every type, and the engine calls them: - **`instantiate(self, target?, opts?) -> (root, idMap)`**: puts the asset in a scene. Defining it is what makes the type scene-instantiable. Its return is a contract (below). - **`inspect(self) -> detail`**: what `asset.inspect` reports for the asset beyond the common record (below). - **`preview(self, opts)`**: renders the asset's picture; it wins over the type's `preview:` recipe. - **`previewMaterial(self) -> { material }`**: the material a `surface` preview paints. - **`saveDefinition(self)`**: writes the asset's in-memory edits back to its files in edit mode. Some names are answered for every asset before the type is asked, so a `ref` entry of the same name is never reached: `getSource`, `getBytes`, `getText`, `exists`, `deps`, `canInstantiate`, `canPreview`, `preview` (which calls yours when you define one), `meta`, `runtime`, `events`, `typeRef`, `modules`, and the residency flags `has_backing_asset`, `has_runtime_changes`, `cpu_resident`, `gpu_resident`. ### When the engine calls the type | Hook | Signature | When it runs | |---|---|---| | `onCreate` | `(name, opts) -> { [path] = contents }` | On `asset.create`. Returns the files of the new asset, laid over the type's `template/`. Annotate `opts`: its type is the schema `asset.create` checks the caller's arguments against. A `""` key writes a single loose file. | | `onReplace` | `(dest, files) -> files` | On an `asset.create` over an asset already at `dest`, after `onCreate`, so what the author added can be carried into the replacement. | | `onRegister` | `(self)` | Once per asset, when it first registers: when the world loads, on a live `asset.create`, and when an asset arrives later (installed, pulled, synced). This is what makes an asset take effect the moment it is written. | | `onChange` | `(ref, change)` | On every write to a file inside an asset of the type. `change` is `{ path, asset, type, kind, origin }`, plus `settings` and `settingsChanged` for a write to the settings values file; `kind` is `edited` or `seeded`, `origin` is `local` or `remote`. Filter on `change.path`. Writes to one asset arrive in order, each after the hook for the one before has finished, and the hook may wait on what it reads. A write the hook makes inside its own asset arrives later like any other, so keep the hook convergent. | | `onDependencyChange` | `(ref, change)` | When a module the asset's code requires is re-run, or a name the asset carries starts resolving. `change.kind` is `dependency`. | | `onDelete` | `(ref)` | When an asset of the type leaves the world: deleted, or the world it is in is swapped away. | | `validate` | `(ref) -> { { code, message, severity?, path? } }` | On `asset.validate`, after the `type.yaml` checks, for the type's own rules. `severity` defaults to `error`. Runs on every push, so a type's rules hold at publish. A hook that fails reports `validate.hook_failed`. | ### Settings hooks | Hook | When it runs | |---|---| | `settingsDefaults(name, opts, asked) -> table` | Once per `asset.create`, for values the schema's defaults do not give. | | `settingsCorrections(values, name, opts) -> (corrections?, reasons?)` | On every settings write. A correction to a field the writer named refuses the write, giving the reason. | | `settingsDerivedDefaults(values, explicit, changed)` | On a settings write, for fields derived from others. | | `normalizeSettings(values, stored?)` | On every read and write, to map an earlier spelling of a field to the current one. | | `settingsHealed(values, stored)` | On a read, to repair stored values. | | `settingsSchemaProblem(schema, ref) -> string?` | When an asset's own schema is read; a returned string refuses the schema. | `creationInputs` (`{ [opt] = true | selectorOpt }`) names `asset.create` options that are inputs to the type rather than settings. ### Reloading An edit to `behavior.luau` reaches existing assets with no restart. ## How an asset is pictured (`preview:`) | `kind` | The picture is | The type provides | |---|---|---| | `instantiate` | the asset placed in the preview studio through its `instantiate` | `ref.instantiate` | | `image` | a file the asset holds, fitted to the frame | `source: { files }`, the candidate files in order | | `surface` | the asset painted on a mesh | `mesh`, and `ref.previewMaterial` | | `custom` | whatever `ref.preview` returns | `ref.preview` | ```yaml preview: kind: surface mesh: sphere ``` `angle: [yaw, pitch]` turns the camera. The studio owns the light, the backdrop and the framing, so an asset pictures the same in every world. A type with no `preview:` that defines `instantiate` still answers `ref:preview()`. A picture is rendered when something asks to view it (the editor showing the asset, `ref:preview()`), when previews are generated on request (`assets.generatePreviews`), and when the asset is staged. An edit alone renders nothing. The picture records what it was made from, so a stale one is told from a current one. ## The names your type's assets hold (`references:`) Where your type's own format or API carries the name of another asset, declare it here: ```yaml references: keys: # a top-level key of the type's files that holds a name, or a table of them - { key: "shader", type: "shader" } args: # an argument of a call, counting from 1 - { call: "g:node", position: 2, type: "procNode" } fields: # a field of the options table a call takes - { call: "fx.beam", field: "material", type: "material" } ``` `type` is the category the name resolves in. `asset.declareReferenceKey`, `asset.declareReferenceArg` and `asset.declareReferenceField` declare the same from a script. ## What search reads (`indexing:`) `indexing:` is how assets are found. Search reaches an asset only through what its type's `indexing:` names, and adds nothing of its own. That includes you: an asset indexed badly is one you cannot find later, when you are making something else and need it. A type whose assets are never looked for says `indexing: none`. ```yaml indexing: data: # text, read from the asset's files - role: identity extractor: verbatim source: { file: "README.md" } - role: interface extractor: symbols source: { files: ["init.luau"] } - role: implementation extractor: verbatim source: { files: ["init.luau"] } content: # the picture - role: identity modality: image source: { file: "preview.png" } facets: # what a query filters and re-ranks by file: ".metadata" rigged: { type: bool, from: { components: { contains: SkinnedModel } } } roughness: { type: number, filter: range, from: { file: "mat.yaml", field: "floats.roughness" } } ``` **Roles.** Each `data` and `content` entry has a `role`, and a query matches in two slots: - **`identity`**: what an asset is. For anything you look at, the picture; for anything else, the text that says what it is. - **`capability`**: what it does and how it is made. `interface` (the signatures or shape a caller uses) and `implementation` (the body) both count as capability, and a type with code usually declares both. Ask what a person would recognise an asset of the type by, and what it does, and point each role at the file that says it. For text, that is the asset's description: the file your template starts with a `[[describe]]` block, which the author writes or `services describe` fills in (see "Ask your assets to say what they are"). **`data`.** `extractor: verbatim` embeds a file's text as it is; `symbols` embeds the declared signatures of code. `source` is `{ file }` or `{ files: [...] }`. Never index a file name (`source: { field: name }`): one or two words carry nothing to match. **`content`.** `modality: image` embeds the picture itself, so a text query matches what the asset looks like. A type whose assets are looked at makes the picture its identity. **`facets`.** What a query narrows and re-ranks the matches by. `file` is embedded whole, so keys nobody declared in it are still found. Each further key is computed for every asset and states a value for every one, including `false`: a file can imply "not rigged" but never say it, and a query separates rigged from unrigged only because the unrigged ones say `rigged: false`. A key is `{ type: bool | number | enum, filter?: range, from }`, where `from` is `{ file, field }` (a field of one of the asset's files, dotted for nesting), `{ metadata: key }`, or `{ components: { contains | any_outside } }` (what the asset's entities carry). ## What blocks a push A push checks every asset it carries against its type. These refuse it: - a required file that is missing, a `content` check that fails, a `described` file not written yet; - an error from the type's `validate`. Unlisted files and warnings do not. A `described` file blocks only a push that changes the asset. When a push is refused, the message names each asset and what it lacks. `world.publishBlockers()` and `zm status` read the same list without pushing. ## Typing a result from the asset (`refShapes`) A `ref` method whose result depends on the asset (one entry per child folder, per row of a config, per control a map declares) can only be annotated as `{ [string]: Thing }`, which accepts any key. `refShapes` states the result for each asset instead: a function returning a Luau type expression for that asset, and the module whose types the expression uses. Read the asset; never run it. ```lua -- inputMap.assetType/behavior.luau M.refShapes = { activate = function(self): (string, string) local names = {} for _, control in ipairs(M.ref.controls(self)) do table.insert(names, control.name .. ": Handle") end if #names == 0 then return "", "" end return "{ " .. table.concat(names, ", ") .. " }", "@builtin::modules.zinput.scheme" end, } ``` With it, `map.jump:onPressed(fn)` is checked and `map.noexisting` is reported. A per-asset type applies where the call site names which asset: a component field whose default names it, or an annotation `AssetRef<"inputMap", "<identity>">`. `asset.resolve(name, category)` carries only the category, and a name computed at runtime carries nothing, so calls on those keep the declared return. The type belongs to the call's result: index it there, or bind what you need from it there, and the names stay checked. `require("@builtin::assetTypes.assetType.shared.refShapes").published()` shows what was published: `categories` (each type's method surface) and `returns` (per-asset results by identity, then method). An identity missing from `returns` was never published. Results are recomputed when an asset is written; at most 64 assets of one type are read. ## Putting an asset in a scene (`ref.instantiate`) A caller writes one piece of code against every instantiable type, so what `instantiate` returns is fixed: ```lua local Instantiable = require("@builtin::assetTypes.assetType.shared.instantiable") M.ref = { instantiate = function(self, target, opts) local root = Instantiable.root(self, target, opts) -- compose the asset under `root`, now return Instantiable.result(self, root, idMap) end, } ``` **In.** `target` is the entity the asset lands under, or onto for a hierarchy type; with none, the type spawns a new root. `position`, `rotation` (three numbers in degrees, or a quaternion), `scale`, `name` and `temporary` mean the same for every type: `Instantiable.root` applies them to a root you make, `Instantiable.place` to one you adopt. Document any options of your own in the hook's `--!arg` docs. **Out.** `(root, idMap)`. `root` is the composed root, live when you return: build synchronously, never defer to a component's `awake`. `idMap` maps each original id to the spawned one, so a component that composes the asset again on every load can pass it back in and keep references into the composition. Every call goes through `Instantiable.result`, which refuses a root that is not live and turns a missing `idMap` into `{}`. ## Inspecting an asset (`ref.inspect`) `asset.inspect(ref)` builds a record every asset shares (`identity`, `name`, `guid`, `source`, `typeName`, `typeDefinitionPath`, `scope`, `origin`, `description`, `tags`), then calls `ref.inspect(self)` for the type's own `detail`: ```lua M.ref = { inspect = function(self) -- read the asset's own files, never runtime state: inspect works on an asset -- that has not been compiled, uploaded or registered return { --[[ what makes this asset what it is ]] } end, } ``` Without it, the record is the shared part alone, and an agent inspecting the asset learns nothing of what it is. A hook that raises leaves `detail` empty and sets `record.warning`. ## Discovery - `asset.list("assetType")`: every registered type. - `asset.inspect("<typename>")`: the type, its README and its `about.yaml` texts. - `asset.resolve("<typename>", "assetType")`: the type itself.
▲ 0↑ born
·
assettype · born here
❒asset
# Component (asset type) A component is a reusable behavior + data unit attached to an entity. The component file declares public fields, methods, and lifecycle callbacks; the engine instantiates one per attachment and drives its hooks every frame. Components are the primary unit of gameplay code — movement, AI, animations, UI panels, network sync, and per-entity state all live here. ## When to use one - You need per-entity state that survives across frames. - You need per-entity behavior driven by engine lifecycle hooks (`start`, `update`, `onDestroy`). - You want to expose configurable fields to designers / `entity.spawn` callers / scenes without code changes. If you need a stateless pure-function library, use a `.module`. If you need to generate content declaratively, use a `.service`; compute work belongs in a `.computeShader`. ## Where it lives - Source: `/zero/source/.../<Name>.component/` - Identity: `<Name>` (the `.component` suffix strips from the identity, but the folder retains the suffix on disk). - Folder shape: - `init.luau` (or `init.lua`) — declares the component. **Required.** - `README.md` — instance-level documentation. **Required.** - `.metadata` — agent-editable tags + free-form fields. **Required.** The structural contract is enforced by `asset.validate` against this type's `type.yaml`. ## How to create one Always start with the scaffold — it guarantees the folder shape matches `type.yaml` from the moment it's on disk: ```luau asset.create("component", "<Name>") -- Creates: /zero/source/<Name>.component/ -- init.luau (canonical declare + public block + hooks stubbed) -- README.md (instance README template) ``` After scaffolding, edit `init.luau` to fill in the actual fields and behaviour. The component registers as soon as the file is written — hot-reload is automatic; no engine restart required. ## How it operates 1. **Registration.** Writing `init.luau` into a `.component/` folder indexes the asset, mints a guid (in the `.meta` sidecar), and surfaces the type to the engine's component registry. Same-frame visible to `entity.component.add`. 2. **Attachment.** `entity(id).component.add(name, data)` (or the batch form `tools.use("entityOps", "addComponents", targets, { [name] = data })`) attaches an instance. The `data` table's fields override the component's declared defaults; omitted fields take the declared default. The `data` values are copied into `public.*` BEFORE `awake()` runs. 3. **Lifecycle.** The hooks run in this order: - `awake()` — same frame as attach, immediately after the data copy. Initialise state, set up native bridges, register with other systems. Other components on the same entity may not have awoken yet. - `start()` — the next frame. Every component on the entity has completed `awake()` by then, so cross-component setup is safe here. - `update(dt)` — same frame as `start()`, then every frame after, for as long as the gameplay clock is running. `fixedUpdate(dt)` runs once per physics step, straight after it, with the step's `dt`, so a frame can run it several times or not at all; `editorUpdate(dt)` runs while the clock is held. Which of them ticks is decided by `engine.mode` AND `engine.paused` together — see **Per-frame hooks and the two axes** below, and `man modes`. - `onDestroy()` — when the component is removed via `component.remove` or when the owning entity is despawned. Release resources, drop native ECS components. For the full list (`onEnable`, `onDisable`, `fixedUpdate`, `editorUpdate`, `onPropertyChanged`, `onAssetReload`, `onModuleReload`, `onBeforeSave`, …) and the timing details, **read `man components` — that is the canonical lifecycle reference. Generic component patterns (declare blocks, public fields, sync, ECS bindings, typed methods) all live there.** 4. **Public surface.** Fields declared in `public` are inspectable, editable in the inspector, and persist with the entity. Methods are declared on that same table with a colon — `typed function public:method(args)` — and every one of them takes the component ref as `self`, so a caller invokes it with a colon too: `entity(id).component.get(name):method(args)`. That is the one calling convention a component ref answers to: the reflection methods `ref:fields()` / `ref:getField(name)` / `ref:setField(name, value)` take the same spelling. A function the chunk declares at file scope (`function helper()`) is the component's own, reachable from its hooks under its bare name; `public` is what the ref carries. 5. **Settings and the Inspector card.** `type.yaml` names the component's settings schema as `settings: { schema: { instance: "init.luau", export: "public" } }`: the `public` table IS the schema, and its values live on each entity the component is on, so `asset.schema(componentRef)` answers the Field descriptors and no values file exists. On an entity the Inspector shows the component as a card whose generic `settings` section edits those fields as typed controls, each edit checked against the schema and written to the live component as one undoable operation. `type.yaml` also names `inspector: { instance: "inspector.luau" }`: a component that ships an `inspector.luau` beside its `init.luau` shapes its card — the file returns `{ sections, replace, order }` (see `assetTypes/README.md`, "`inspector:`"), each section's `build(ctx)` reading `ctx.component` (the live component) and `ctx.selection.id` (the entity). `SceneModule.component/inspector.luau` replaces `settings` with the bound module's declared inputs. 6. **Events.** An `events` block declares typed moments the component fires from inside — `events = { onHit = Event({ dmg = Field.number(0, NoSync) }) }`. The owner fires with `events.onHit:fire({ dmg = 10 })`; outside code subscribes through the proxy's subscribe-only facade, `entity(id).component.get(name).events.onHit:connect(fn)` (`:once` / `:wait` too). Pass `Sync` as the event's second argument to replicate a fire to other peers. Events let one component react to another's moments without polling. Full reference: **`man components`**, Events section. 7. **Hot reload.** Editing `init.luau` reloads the component definition; live instances are reconciled with the new declaration in-place, and each crosses one lifecycle boundary: `onDestroy()` ends the running life, then `awake()` and `start()` construct the one that replaces it, and `update()` resumes on the next frame. `public` and `private` values carry across; module-level `local`s belong to the chunk, so the new life starts with them at their initial values and its `awake`/`start` are what fill them in. Whatever the old life handed elsewhere — a subscription, a shared registration, a spawned entity — is released in `onDestroy`, the call that pairs with the construction about to run. An edit that leaves the source byte-identical crosses no boundary at all. A field carries its value across when something stated it: a key of the `data` table the instance was attached with (a scene record's data is that table), or a write made since. Every other field takes the edited source's declared default, so changing a default reaches every instance that left the field to it. An instance that states its own value for a field whose default the edit changed keeps that value, and the reload logs a `[HotReload]` warning naming the field, the entity, the value kept and both defaults. ## Discovery - `asset.list("component")` — every registered component (engine + world + libraries). - `asset.inspect("<name>")` — identity, scope, public fields, lifecycle methods, source path, and this type README. `detail` carries the component's declared `fields`, `methods`, and `events`, parsed from its source — `tools.use("assets","describe", "<name>")` renders it as markdown, so a component's events are visible without opening its source. - `ls /zero/source/<Name>.component` lists the files the folder holds. - `entity(id).component.list()` — components attached to an entity. ## Per-frame hooks and the two axes `engine.mode` (`"edit"` / `"play"`) and `engine.paused` (the gameplay clock) are independent, and the per-frame hooks read them separately: - `update(dt)` / `fixedUpdate(dt)` tick while **the gameplay clock is running** — whichever mode the engine is in. - `editorUpdate(dt)` ticks while **the clock is held** — because the mode is `edit`, or because play is paused — and also alongside `update` whenever edit is running. Which gives four states, and this table is the contract: | `engine.mode` | `engine.paused` | hooks that tick | |---|---|---| | `edit` | `true` | `editorUpdate` | | `edit` | `false` | `update`, `fixedUpdate`, `editorUpdate` | | `play` | `false` | `update`, `fixedUpdate` | | `play` | `true` | `editorUpdate` | Entering edit sets `paused = true` and entering play sets it back to `false`, so a session that never writes `engine.paused` only ever sees rows 1 and 3 — which is where the shorthand "`update` is the play tick, `editorUpdate` is the edit tick" comes from. It is the two default rows of a four-row table, not the rule. **Row 2 is the one that surprises.** With `engine.paused = false` in edit — set by hand, or by a tool that advances the gameplay clock to sample it, such as a `capture.collage` given a `duration` — `update` and `editorUpdate` both fire, once each, every frame. A component that declares both and routes them to one body therefore runs that body **twice per frame**: ```luau local function drive(dt) ... end function update(dt) drive(dt) end function editorUpdate(dt) drive(dt) end -- twice per frame in row 2 ``` Nothing reports the doubling; it reads as an animation running at twice its intended speed. To get exactly one tick per frame in every row, ask which axis you meant and answer it in the body: ```luau function update(dt) drive(dt) end function editorUpdate(dt) if engine.paused then drive(dt) end end ``` A scene `entrypoint.luau` declaring the same two hook names is dispatched by the scene loader, not by this table: there `update` needs play AND running, `editorUpdate` needs edit, and play-paused ticks neither. Read `man scenes` before carrying a component's rule to an entrypoint. ## Authoring conventions - Annotate public fields with `--!desc` so the inspector + LSP show documentation alongside the field name. - Declare lifecycle hooks (`start`, `update`, `onDestroy`) explicitly rather than relying on engine defaults — readers can see at a glance what runs when. - Keep `update(dt)` cheap — it runs every frame per instance. Move heavy work to `start`, to a `.computeShader`, or behind a job (`man jobs`). - For multi-entity batching, prefer `tools.use("entityOps", "addComponents", targets, components)` over a loop of `entity(id).component.add` — it takes many targets and many components in one call. ## Common pitfalls - **Naming.** The component identity is the folder stem with `.component` stripped (e.g. `<Spinner>.component/` → identity `Spinner`). Don't repeat the suffix in the identity passed to `component.add`. - **`init.lua` vs `init.luau`.** Either is accepted (it's a `one_of_group: "entrypoint"`), but `.luau` is canonical. Mixing both in one folder is invalid. - **`update` in edit mode.** It runs whenever the gameplay clock is running, and entering edit stops that clock — so `update` is idle in a freshly-entered edit session and ticks again the moment anything sets `engine.paused = false`. Use `tools.use("wld", "play")` to test update logic under the mode it ships in; `tools.use("wld", "edit")` to return. See **Per-frame hooks and the two axes** above. - **Renaming.** Renaming the folder changes the identity. References to the component are recorded against the component itself, so renaming or moving it does not break them. ## Related types - `.module` — pure-function library, no per-entity state. - `.service`: a declarative content generator, no per-entity state. - `.preset` — a captured component configuration, replayable into `component.add` without re-typing fields. - `.bundle` — entity hierarchies that may carry component attachments as part of the bundle. ## In the Inspector Fields: its execution order, hooks, and how many methods and events it declares, then the fields its `public` table declares as read-only typed controls holding their defaults, with **Check** and **Open** for its entry file. Instances: a link to every entity carrying it. What its card shows on an entity comes from the component's own `inspector.luau`.
▲ 0↑ born
❒
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
# 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 · modules/avatarAppearance.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.