How to Read This Handbook
- Lua knowledge required. See the Lua 5.3 Manual and Lua 5.3 Function Reference (ZH).
- Numbers prefixed with
0x in examples are hexadecimal.
- Optional parameters are enclosed in square brackets
[].
- When a parameter or return value is a table with a fixed structure, curly braces
{} describe its shape.
- In type descriptions, Text and String both refer to Lua's
string type — Text typically implies printable plain text.
- Chapters or sections prefixed with ! indicate the function(s) may implicitly yield (other threads may execute before the function returns).
- Unless otherwise stated, example code does not handle edge cases and should not be copied directly into production scripts.