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

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

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

lua_CFunction typedef int (*lua_CFunction) (lua_State *L); Type for C functions. In order to communicate properly with Lua

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

lua_rotate[-0, +0, –] void lua_rotate (lua_State *L, int idx, int n); Rotates the stack elements between

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

lua_tonumber[-0, +0, –] lua_Number lua_tonumber (lua_State *L, int index); Equivalent to

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

lua_absindex[-0, +0, –] int lua_absindex (lua_State *L, int idx); Converts the acceptable index idx

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

lua_typename[-0, +0, –] const char *lua_typename (lua_State *L, int tp); Returns the name of the type encoded

2025-01-10 15:47:30