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

lua_xmove[-?, +?, –] void lua_xmove (lua_State *from, lua_State *to, int n); Exchange values between different

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

lua_rawgeti[-0, +1, –] int lua_rawgeti (lua_State *L, int index, lua_Integer n); Pushes onto the stack

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

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

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

lua_isyieldable[-0, +0, –] int lua_isyieldable (lua_State *L); Returns 1 if the given coroutine can yield

2025-01-10 15:47:30
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_pushcclosure
  • References/Lua/Lua/API/Functions and Types

lua_pushcclosure[-n, +1, m] void lua_pushcclosure (lua_State *L, lua_CFunction fn, int n); Pushes

2025-01-10 15:47:30