unpack
Unpacks a table into individual items
Prototype
t1, t2, ... = unpack (t)
Description
Returns all elements from the given list (table) as individual values. This is equivalent to:
return t [1], t [2], t [3] ..., t [n]
For example, to make an error function that takes a formatted string:
return t [1], t [2], t [3] ..., t [n]
t = { "the", "quick", "brown" }
print (unpack (t)) --> the quick brown
An example of using unpack is the case of a variable number of arguments to a function, where you want to pass those to another function.For example, to make an error function that takes a formatted string:
function ferror (fmt, ...)
error (string.format (fmt, unpack (arg)), 2)
end -- ferror
However in Lua 5.1 this is more simply written as:
function ferror (fmt, ...)
error (string.format (fmt, ...), 2)
end -- ferror
Lua functions
- assert - Asserts that condition is not nil and not false
- collectgarbage - Collects garbage
- dofile - Executes a Lua file
- error - Raises an error message
- gcinfo - Returns amount of dynamic memory in use
- getfenv - Returns the current environment table
- getmetatable - Returns the metatable for the object
- ipairs - Iterates over a numerically keyed table
- load - Loads a chunk by calling a function repeatedly
- loadfile - Loads a Lua file and parses it
- loadlib - Loads a DLL (obsolete in Lua 5.1)
- loadstring - Compiles a string of Lua code
- module - Creates a Lua module
- next - Returns next key / value pair in a table
- pairs - Traverse all items in a table
- pcall - Calls a function in protected mode
- print - Prints its arguments
- rawequal - Compares two values for equality without invoking metamethods
- rawget - Gets the value of a table item without invoking metamethods
- rawset - Sets the value of a table item without invoking metamethods
- require - Loads a module
- select - Returns items in a list
- setfenv - Sets a function's environment
- setmetatable - Sets the metatable for a table
- tonumber - Converts a string (of the given base) to a number
- tostring - Converts its argument to a string
- type - Returns the type of a variable
- xpcall - Calls a function with a custom error handler
Topics
- Lua PCRE regular expression functions
- Lua base functions
- Lua bc (big number) functions
- Lua bit manipulation functions
- Lua coroutine functions
- Lua debug functions
- Lua io functions
- Lua math functions
- Lua os functions
- Lua package functions
- Lua script extensions
- Lua string functions
- Lua syntax
- Lua table functions
- Lua utilities
- Scripting callbacks - plugins
- Scripting