4.8 – Functions and Types[-o, +p, x]

Here we list all functions and types from the C API in alphabetical order. Each function has an indicator like this:

The first field, o, is how many elements the function pops from the stack. The second field, p, is how many elements the function pushes onto the stack. (Any function always pushes its results after popping its arguments.) A field in the form x|y means the function can push (or pop) x or y elements, depending on the situation; an interrogation mark '?' means that we cannot know how many elements the function pops/pushes by looking only at its arguments (e.g., they may depend on what is on the stack). The third field, x, tells whether the function may raise errors: '-' means the function never raises any error; 'm' means the function may raise out-of-memory errors and errors running a __gc metamethod; 'e' means the function may raise any errors (it can run arbitrary Lua code, either directly or through metamethods); 'v' means the function may raise an error on purpose.

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

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

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

lua_touserdata[-0, +0, –] void *lua_touserdata (lua_State *L, int index); If the value at the given index

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

lua_dump[-0, +0, –] int lua_dump (lua_State *L, lua_Writer writer,

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

lua_remove[-1, +0, –] void lua_remove (lua_State *L, int index); Removes the element at the given valid

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

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

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

lua_geti[-0, +1, e] int lua_geti (lua_State *L, int index, lua_Integer i); Pushes onto the stack

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_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_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