Skip to content

Lua modding API

Generated reference for the allowlisted Lua surface. Mods register content with JSON/XML packs; optional LuaScriptPath scripts implement behavior through hooks and these APIs — not through CLR, io, or World.Map.

Start here

Generated reference

Page Role
World Map queries and mutations (30 helpers)
Utils Geometry / list helpers
Item self.item 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-08-02T05:22:21.4279488Z · a7346a83 · 5 proxy pages.