API Reference

The Zero engine's Luau API, one page per namespace (89 in total). Every function with its signature, parameters, return values, and a worked example.

• agentSessions

  agentSessions is a Luau API namespace of the Zero engine, holding 4 functions: forget, get, put and record.

• animation

  Observe what the engine is animating: every body it is posing, the clips driving each one and where their playheads are…

• asset

  Asset resolver, ref envelope builder, sidecar metadata.

• audio

  Engine-native audio: encode audio (or raw PCM) into the ZAUD compressed payload, decode/inspect it, set what the mix is heard at, a level per named channel…

• av

  Audio/video encode + mux control: live streaming, recording, encoder/muxer primitives.

• base64

  Base64 encode / decode between binary and text Luau strings (standard RFC 4648 alphabet, padded).

• blend

  Record-stride blend primitives over Buffer slices: layout registry + weighted/lerp combiners.

• bundle

  bundle is a Luau API namespace of the Zero engine, holding 1 function: update.

• camera

  Script-facing camera queries: the main scene camera, the on-screen render camera, the editor fly-camera, per-frame view data, and the camera observation…

• cameraInput

  Physical cameras as live textures and pixel sources: list the capture devices (a webcam, a phone's front and back cameras), open one as a feed…

• channel

  Keyframe-channel sampling primitives: registry + sampleInto variants.

• color

  Color construction, conversion, and perceptual ops (RGB / HSL / HSV / Oklch / hex).

• ColorSequence

  ColorSequence is a Luau API namespace of the Zero engine, holding 2 functions: deserialize and new.

• component

  component is a Luau API namespace of the Zero engine, holding 20 functions, among them data, entity, entityId, instanceId and add.

• compute

  GPU compute pipelines: compile shaders, dispatch workgroups, read back results.

• cursor

  cursor is a Luau API namespace of the Zero engine, holding 2 functions: clear and set.

• debugger

  Luau debugger: breakpoints, stepping, stack inspection, watches.

• ecs

  ecs is a Luau API namespace of the Zero engine, holding 40 functions, among them AudioListener, AudioSource, Camera, Collider and CollisionGroups.

• egress

  Credential-injecting HTTP for BYO-key world egress (Mechanism B).

• engine

  engine is a Luau API namespace of the Zero engine, holding 48 functions, among them discardPlayChanges, editWaiters, engineRecord, gameplayReady and gpuCompute.

• entity

  Entity spawn / despawn / query / hierarchy surface.

• Entity

  Entity wrapper namespace. Also reachable as the lowercase entity(...) proxy constructor.

• environment

  Environment / reflection capture: bake the scene into reflection-probe cube slots from world positions, persist them as faces6.texture assets…

• Field

  Field is a Luau API namespace of the Zero engine, holding 24 functions, among them alias, assetRef, bitmask, bool and check.

• font

  Font primitive: parse a font file ONCE into a baked, vectorized glyph format (ZFNT), then drive every text surface from it.

• frameStream

  Carries an image the GPU drew out to another program: the view a camera renders…

• globals

  globals is a Luau API namespace of the Zero engine, holding 1259 functions, among them deserialize, new, Entity, allTypes and distance.

• home

  The person's home folder, /zero/home/<username>: their own files, carried from world to world in the editor.

• http

  Async HTTP: GET/POST returning JSON or raw bytes.

• httpServer

  Serve HTTP from this engine.

• i18n

  The player's language, and which of your world's languages to show them. i18n.pick({"en", "pt", "es"})…

• input

  input is a Luau API namespace of the Zero engine, holding 41 functions, among them armObservation, backUnanswered, emulateKeyDown…

• jobs

  jobs is a Luau API namespace of the Zero engine, holding 21 functions, among them context, dispatch, find, inspect and list.

• layers

  Top-level scene-management namespace + Scene proxy. Owns the public layer-management API surface exposed on _G.layers.

• library

  Discover, check, and import library assets: the @builtin/ tree the engine ships and the @namespace/ trees imported from other worlds.

• live

  live is a Luau API namespace of the Zero engine, holding 1 function: isConnected.

• log

  log is a Luau API namespace of the Zero engine, holding 4 functions: debug, error, info and warn.

• logs

  Read-only query surface over the engine's in-memory log ring buffer.

• lsp

  Embedded Luau language server: check / search / inspect.

• luau_codegen

  luau_codegen is a Luau API namespace of the Zero engine, holding 3 functions: chunk, chunks and status.

• luau_profile

  Sampling profiler + manual regions for Luau scripts.

• Material

  Material helpers namespace.

• mathx

  Batch math kernels over buffer slices (damp, lerp/slerp, transform).

• mcp

  mcp is a Luau API namespace of the Zero engine, holding 4 functions: call, image, listTools and poll.

• mcpLog

  Read-only MCP tool-call log ring buffer.

• microphone

  Capture from an input device and read what is arriving: a loudness, a magnitude spectrum, and the raw PCM.

• modelImport

  The model-import pipeline: decompose any assimp-supported 3D model (fbx, obj, dae, gltf, glb, stl, ply, 3ds) into meshes, materials, textures…

• modules

  modules is a Luau API namespace of the Zero engine, holding 2266 functions, among them getInstructions, getManifest, getReadme, inspect and onChange.

• multiplayer

  Multiplayer sync state and operations: connection, peers, ownership, rooms, undo/redo.

• notices

  Post an event record that surfaces to the callers it is addressed to on the response of the tool call that posted it, or on their next tool call.

• NumberRange

  NumberRange is a Luau API namespace of the Zero engine, holding 1 function: new.

• NumberSequence

  NumberSequence is a Luau API namespace of the Zero engine, holding 2 functions: deserialize and new.

• nx

  nx is a Luau API namespace of the Zero engine, holding 67 functions, among them add, addStrided, addStridedFrom, applyAbs and applyCeil.

• packages

  Discover and inspect registered packages (folders marked with package.yaml).

• physics

  Lowercase alias of Physics. Same identity. Prefer this in new code so the convention matches entity, scene, cam.

• Physics

  Physics namespace: collisions, joints, raycasts, body manipulation.

• plugins

  What the plugin host loaded, and the one way to call a plugin.

• postprocess

  Fullscreen post-process effects: register / remove / toggle / named-property updates / list the chain / read one effect's declared property schema…

• preset

  Preset namespace: apply named tuning bundles to components.

• profiler

  Frame-level profiler capture, EMA stats, and named profiling blocks.

• Random

  Seeded random-number generators.

• reflectionProbe

  Reflection-probe system: multiple proximity-blended reflection probes in a scene.

• renderer

  GPU-resource factory + CPU codec/store wrappers: the GPU/CPU half of the asset↔resource split.

• scopes

  Scopes: work you start together and that ends together, tied to what started it (an entity, a component, a scene, another scope)…

• service

  Credit-metered service invoke, buffered or streamed.

• settings

  settings is a Luau API namespace of the Zero engine, holding 7 functions, among them all, get, getBool, getNumber and getString.

• shader

  Shader compilation: turning authored WGSL into registered GPU programs, and the reusable modules those programs include.

• shell

  Engine emulated Unix shell: same shell that powers the MCP bash tool.

• skeleton

  The skeleton pose-data pipeline: sample a clip into a pose buffer, and bind/apply a pose buffer onto a Skeleton + Model entity.

• sky

  Sky configuration: type, time of day, day/night cycle, procedural parameters, presets, explicit sun direction.

• stream

  Named byte streams by URL scheme: TCP, tty, Bluetooth Low Energy and loopback transports, dialled out or listened…

• streaming

  What the engine has resident of a world's detail right now, and why a piece of it is not on screen.

• stringx

  Batch text-scanning kernels: read a whole run of numbers out of a string in one call.

• subscriptions

  Runtime inspection and cancellation of component-event subscriptions.

• substrate

  Typed data buffers, on the CPU or the GPU: the engine's one buffer primitive.

• task

  task is a Luau API namespace of the Zero engine, holding 29 functions, among them active, await, background, batched and bindCaller.

• terminal

  terminal is a Luau API namespace of the Zero engine, holding 7 functions, among them create, destroy, kill, list and poll.

• text

  Text rasterisation resource: create a text handle, set its content and style, then rasterise it to a texture for display…

• time

  time is a Luau API namespace of the Zero engine, holding 6 functions, among them deltaTime, drawnFrameCount, frameCount, realtime and time.

• toml

  toml is a Luau API namespace of the Zero engine, holding 3 functions: encode, parse and replaceArrayTables.

• tools

  tools is a Luau API namespace of the Zero engine, holding 360 functions, among them __useVia, bind, callable, create and createToolbox.

• Transform

  Math helpers for positions, rotations, and directions on transforms.

• typed

  typed is a Luau API namespace of the Zero engine, holding 1818 functions, among them build, flushPendingPersists, forgetRuntime…

• ui

  UI system: screens, styles, themes, widget responses, focus, custom-widget builders, per-widget state.

• userfile

  The files of the person at the screen, both ways. pick opens their own file picker (native OS dialog / Android / web browser) and brings the chosen file(s)…

• vfs

  Virtual filesystem: read, write, list, watch.

• video

  Video playback: create / play / pause / seek / setRate / setLoop / destroy on render-target-backed video players.

• world

  world is a Luau API namespace of the Zero engine, holding 93 functions, among them add, add_all, affirm, args and assetInstallable.

• ws

  ws is a Luau API namespace of the Zero engine, holding 6 functions, among them close, connect, liveness, poll and recv.