Lua modding API¶
Reference for the Lua surface mods may call. Packs register content with
JSON/XML; optional LuaScriptPath scripts implement behavior through
hooks and these APIs — not through io, os, or World.Map.
Start here¶
- Modding overview
- Getting started
- Content packs
- Gameplay configuration:
Config/playerConfig.jsonandConfig/worldConfig.jsoninside the pack; startup only, skipped by Load Now. - Sandbox rules
Reference¶
| Page | Role |
|---|---|
| World | Map queries and mutations (31 helpers) |
| Utils | Geometry / list helpers |
| Types and handles | Returned views, opaque handles, vectors, time values, and query collections |
| Item | self.item proxy |
| Armor | self.armor proxy |
| Creature | self.creature proxy |
| Player | self.player proxy |
| Structure | self.InWorldStructure proxy |
| Flora | self.flora proxy |
| Projectile | self.projectile proxy |
| Hooks | Script callback names by base class |
Generated 2026-10-02T21:05:27.5090099Z · b8c9ae78 · 7 proxy pages.