Scripting API

This is the reference for the Eggox scripting API, version 1. Scripts are Lua, run on the server in every copy of a room, and see the world through the verbs below. Each section is its own page; the whole reference is one file at /api/reference.md.

Versions

A room is made on the current API version and keeps it: what its scripts were written against goes on working when the API moves on. The Studio's top bar shows the room's version; when a newer one exists it offers UPGRADE, and the version's page here lists what changed so you can read first and adjust after. Published copies run the version their room was published on.

v1 (current)

Since 2026-09-18.

• The room API: events, scene and players, windows, readouts, timers, saves and leaderboards, rooms and copies, the floor.
• The studio block: components on the game and on things, scripts on things and items with `self`.