Skip to main content

How to read this handbook


  • You should have basic Lua knowledge. See the Lua 5.3 Manual (ZH) and Lua 5.3 Function Reference (ZH).
  • Numbers starting with 0x in examples are hexadecimal (what is hex? See Baidu Baike).
  • Optional parameters are enclosed in square brackets [].
  • When a parameter or return value is a table with a fixed structure, curly braces are used to describe it.
  • In type descriptions, Text and String both refer to Lua's string type, but Text usually means printable plain text.
  • Chapters or sections starting with an exclamation mark (!) indicate the function(s) may implicitly yield (other threads may run before the function returns).
  • Unless otherwise stated, example code does not handle edge cases and should not be copied directly into production scripts.