API Reference

The Luax API reference is auto-generated from the /// dartdoc comments in the source code by dartdoc_modern. The generated site lives under /api/.

This page is a quick index into the generated reference, organized by the top-level entry points you can import in Dart.

Library entry points

Entry point	Generated page	What's in it
package:luax/lua.dart	/api/lua/	The main runtime API — LuaState, LuaBasicAPI, LuaAuxLib, LuaCoroutineLib, LuaDebug, LuaEventAPI, PlatformServices, enums, typedefs
package:luax/lua_parser.dart	/api/lua_parser/	Parser & AST types for static analysis — Parser, Block, Exp, Stat, Node and all concrete subclasses
package:luax/debug.dart	/api/debug/	Debug utilities — LuaStateDebug extension
package:flutter_luax/flutter_lua.dart	(external)	Companion package for Flutter widget bindings — see Flutter Integration

Top-level API surface

The most common types you'll reach for:

• LuaState — the abstract VM API
• LuaBasicAPI — the C-API-shaped stack operations
• LuaAuxLib — auxiliary library helpers (load, error reporting, type checks)
• LuaCoroutineLib — coroutine control
• LuaEventAPI — the Dart side of the event system
• LuaDebug — debug hooks
• Parser — the Lua source parser
• Block — the AST root

For conceptual overviews of how these types fit together, see the Guide — particularly Dart↔Lua Interop, Async / Await, and the Architecture deep-dive.

Note on /// comments

The auto-generation reads /// doc comments from the source. If you find a gap in the reference — a method with no description, a missing parameter doc — the fix is to add /// comments in the corresponding .dart file and re-run the generator. The reference is only as good as the comments in the source.