4 – The Application Program Interface

This section describes the C API for Lua, that is, the set of C functions available to the host program to communicate with Lua. All API functions and related types and constants are declared in the header file lua.h.

Even when we use the term "function", any facility in the API may be provided as a macro instead. Except where stated otherwise, all such macros use each of their arguments exactly once (except for the first argument, which is always a Lua state), and so do not generate any hidden side-effects.

As in most C libraries, the Lua API functions do not check their arguments for validity or consistency. However, you can change this behavior by compiling Lua with the macro LUA_USE_APICHECK defined.

The Lua library is fully reentrant: it has no global variables. It keeps all information it needs in a dynamic structure, called the Lua state.

Each Lua state has one or more threads, which correspond to independent, cooperative lines of execution. The type lua_State (despite its name) refers to a thread. (Indirectly, through the thread, it also refers to the Lua state associated to the thread.)

A pointer to a thread must be passed as the first argument to every function in the library, except to lua_newstate, which creates a Lua state from scratch and returns a pointer to the main thread in the new state.

lua_settop
  • References/Lua/Lua/API/Functions and Types

lua_settop[-?, +?, –] void lua_settop (lua_State *L, int index); Accepts any index, or 0, and sets the

2025-01-10 15:47:30
lua_settable
  • References/Lua/Lua/API/Functions and Types

lua_settable[-2, +0, e] void lua_settable (lua_State *L, int index); Does the equivalent to t[k]

2025-01-10 15:47:30
lua_newthread
  • References/Lua/Lua/API/Functions and Types

lua_newthread[-0, +1, m] lua_State *lua_newthread (lua_State *L); Creates a new thread, pushes

2025-01-10 15:47:30
lua_newstate
  • References/Lua/Lua/API/Functions and Types

lua_newstate[-0, +0, –] lua_State *lua_newstate (lua_Alloc f, void *ud); Creates a new thread running in

2025-01-10 15:47:30
lua_upvalueindex
  • References/Lua/Lua/API/Functions and Types

lua_upvalueindex[-0, +0, –] int lua_upvalueindex (int i); Returns the pseudo-index that represents the

2025-01-10 15:47:30
lua_getinfo
  • References/Lua/Lua/API/The Debug Interface

lua_getinfo[-(0|1), +(0|1|2), e] int lua_getinfo (lua_State *L, const char *what, lua_Debug *ar);

2025-01-10 15:47:30
lua_checkstack
  • References/Lua/Lua/API/Functions and Types

lua_checkstack[-0, +0, –] int lua_checkstack (lua_State *L, int n); Ensures that the stack has space for

2025-01-10 15:47:30
lua_pushnumber
  • References/Lua/Lua/API/Functions and Types

lua_pushnumber[-0, +1, –] void lua_pushnumber (lua_State *L, lua_Number n); Pushes a float with value n

2025-01-10 15:47:30
lua_pushliteral
  • References/Lua/Lua/API/Functions and Types

lua_pushliteral[-0, +1, m] const char *lua_pushliteral (lua_State *L, const char *s); This macro

2025-01-10 15:47:30
lua_upvaluejoin
  • References/Lua/Lua/API/The Debug Interface

lua_upvaluejoin[-0, +0, –] void lua_upvaluejoin (lua_State *L, int funcindex1, int n1,

2025-01-10 15:47:30