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

lua_getextraspace[-0, +0, –] void *lua_getextraspace (lua_State *L); Returns a pointer to a raw memory

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

lua_pushfstring[-0, +1, e] const char *lua_pushfstring (lua_State *L, const char *fmt, ...); Pushes

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

lua_pushboolean[-0, +1, –] void lua_pushboolean (lua_State *L, int b); Pushes a boolean value with value

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

lua_getallocf[-0, +0, –] lua_Alloc lua_getallocf (lua_State *L, void **ud); Returns the memory-allocation

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

lua_pushinteger[-0, +1, –] void lua_pushinteger (lua_State *L, lua_Integer n); Pushes an integer with value

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

lua_next[-1, +(2|0), e] int lua_next (lua_State *L, int index); Pops a key from the stack, and

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

lua_compare[-0, +0, e] int lua_compare (lua_State *L, int index1, int index2, int op); Compares

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

lua_pushcfunction[-0, +1, –] void lua_pushcfunction (lua_State *L, lua_CFunction f); Pushes a C function

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

lua_rawlen[-0, +0, –] size_t lua_rawlen (lua_State *L, int index); Returns the raw "length" of the value

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

lua_yieldk[-?, +?, e] int lua_yieldk (lua_State *L, int nresults, lua_KContext

2025-01-10 15:47:30