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_tointegerx
  • References/Lua/Lua/API/Functions and Types

lua_tointegerx[-0, +0, –] lua_Integer lua_tointegerx (lua_State *L, int index, int *isnum); Converts the

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

lua_KContext typedef ... lua_KContext; The type for continuation-function contexts. It must be a numeric type. This type is defined

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

lua_sethook[-0, +0, –] void lua_sethook (lua_State *L, lua_Hook f, int mask, int count); Sets the debugging

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

lua_pcallk[-(nargs + 1), +(nresults|1), –] int lua_pcallk (lua_State *L, int nargs,

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

lua_pop[-n, +0, –] void lua_pop (lua_State *L, int n); Pops n elements from the stack.

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

lua_Number typedef ... lua_Number; The type of floats in Lua. By default this type is double, but that can be changed to

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

lua_replace[-1, +0, –] void lua_replace (lua_State *L, int index); Moves the top element into the given

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

lua_iscfunction[-0, +0, –] int lua_iscfunction (lua_State *L, int index); Returns 1 if the value at the

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

lua_pushthread[-0, +1, –] int lua_pushthread (lua_State *L); Pushes the thread represented by L

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

lua_newuserdata[-0, +1, m] void *lua_newuserdata (lua_State *L, size_t size); This function allocates

2025-01-10 15:47:30