Script modules

animation Clip playback on a node's animation component: play, pause, seek and query. tween builds a short clip from a table of steps and returns a handle.

apple Apple services beyond platform.: Game Center identity, purchases, notifications. Calls answer on a later tick as a map whose kind is an EVENT_ constant…

assets Asset definitions by reference: a project path, file#entry for one entry, #id for a scene block, or id://<id> from assets/index.toml. A script gets the…

audio Sound playback: play starts a node's sound component and returns a handle that stop_playback, set_volume_linear, set_pitch_scale and is_playing take…

browser The page a browser build runs in; off the web every query answers nil. A parent-frame message reaches on_browser_event on every node that called listen.

debugger Breakpoints, pausing a script and resuming it. The editor's Debugger dock and the Debug Adapter Protocol server drive the same machinery.

encoding Bytes to base64 text and back. The encoding script module of the Balaur game engine: 2 functions and 0 constants a Rune script reaches as encoding::.

engine The running app: its clock, command-line args, user_data_dir, loaded plugins and quit.

events Named events between scripts. A node listens for a name and hears it as its on_<name> method; node.emit and events.emit send one.

export Exports the project being edited. targets lists what this install can build; start runs one off the frame and reports to on_export_event.

fs Files on disk, project-relative unless the path is absolute. A packed build's contents are reached through assets and scene.source.

gamend The Gamend backend: session, REST API and realtime socket. Each call returns an id to await; the result also reaches the node's on_gamend_event (or…

geometry2d Polygons on the plane as lists of [x, y] points in outline order: triangulation, booleans, hulls and containment. Every answer is identical on every…

geometry3d Mesh operations: hulls, convex decomposition, voxelisation, cutting and boolean intersection. A mesh is an asset name or a table of points and indices.

hash SHA-256 content hashes of files and strings. The hash script module of the Balaur game engine: 2 functions and 0 constants a Rune script reaches as hash::.

http HTTP requests off the frame: method, headers, body, timeout_seconds and save_to options. The reply reaches on_response as a map whose kind is response…

import Imports a .glb or .gltf model, an .aseprite sprite, or a .tmx or .ldtk level into the project being edited, with the importers balaur import runs.

input One frame of input: keyboard, mouse, touch screen and gamepads, plus what went down or came up this frame. A headless run answers every query neutrally.

json JSON text to and from script values. Its null keeps nil through a round trip.

log The info, warn and error levels a script writes at, and the buffer behind them. Lines go through the engine's own tracing stream.

math Deterministic float maths backed by pure-Rust libm: the same inputs give the same bits on every platform.

multiplayer Host, join and play a rollback match. Set this machine's input with set_input and read every slot's with rollback.input(slot); events reach every…

node What every node has: name, path, transform, children, components and script. Each function takes the node first; scripts call it as a method…

physics What spans both physics worlds: pausing, sleeping, tuning and clearing. Bodies and colliders live in physics2d and physics3d.

physics2d The 2D rigid-body world: bodies and colliders on nodes, their velocities, raycasts and overlap queries. physics holds what spans both worlds.

physics3d The 3D rigid-body world: bodies and colliders on nodes, their velocities, raycasts and overlap queries. physics holds what spans both worlds.

platform Store services every platform shares: sign-in, achievements, leaderboards, cloud saves. A call answers later on on_platform_event with a map whose kind…

project The projects this machine has opened, the templates a new one starts from, and the folder picker the OS provides. What the editor's start screen is made…

random The engine's one deterministic PCG32 stream: the same seed draws the same numbers on every platform, and a replay reproduces every draw.

regex Regular expressions, the regex-lite dialect: no look-around or back-references. A pattern is compiled on every call; a match is #{ start, end, text…

release Which build of the engine this is, what the channels are publishing, and replacing this install with another. The editor's Engine tab and About sheet…

render What a frame is made of: the shape, sprite, mesh or emitter a node draws, the 2D and 3D cameras, the backdrop, debug lines and screenshots. window holds…

replay Records what a running game is fed and plays it back. A recording holds each tick's input, network arrivals and events; balaur run --record writes one.

rollback Rollback netcode from a script's side. input reads this tick's input, real or predicted; is_resimulating is true when a tick runs again after a late input.

save Save games: a table in, a table out, stored per user. [save] version stamps each file; [save] migrate names the script whose migrate_save(version, data)…

scene The node tree: its root, lookup by path and instancing, plus the component and preset vocabulary an editor's palette lists.

script Loads other scripts, inspects what they declare and calls into them; a failure stays contained.

settings Every setting the engine, its plugins and the game declare, by path: physics/solver_iterations is [physics] solver_iterations in project.toml. define…

skeleton Bones under a rig node: their rest pose and the order a skin numbers joints in. A bone is any node carrying bone2d or bone3d.

strings Localization: one strings/<locale>.toml per language, keys to strings. [locale] in project.toml sets the starting locale and the fallback; a key neither…

task Waiting inside an async handler: init and event handlers may await; update is synchronous.

toml TOML text to and from script tables, the format of scene files, asset definitions and component properties.

ui Immediate-mode UI redrawn from a script's draw_ui every frame: panels, layout containers and widgets. HUD elements in the scene tree are the widget…

websocket A long-lived socket for text or binary frames. Events reach the node's on_websocket_event (or on_event) as a map with socket and kind: open, message…

window The OS window and the display under it: mode, cursor, app icon, keep-awake, the safe area and the refresh rate.