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

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

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

lua_len[-0, +1, e] void lua_len (lua_State *L, int index); Returns the length of the value at

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

lua_State typedef struct lua_State lua_State; An opaque structure that points to a thread and indirectly (through the thread) to the

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

lua_tolstring[-0, +0, m] const char *lua_tolstring (lua_State *L, int index, size_t *len); Converts

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

lua_type[-0, +0, –] int lua_type (lua_State *L, int index); Returns the type of the value in the given

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

lua_setfield[-1, +0, e] void lua_setfield (lua_State *L, int index, const char *k); Does the equivalent

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

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

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

lua_createtable[-0, +1, m] void lua_createtable (lua_State *L, int narr, int nrec); Creates a

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

lua_rawequal[-0, +0, –] int lua_rawequal (lua_State *L, int index1, int index2); Returns 1 if the two values

2025-01-10 15:47:30