Summary
Applies a function to each item in a table
Prototype
val = table.foreach (t, f)
Description
Executes f for each element in table t.
Function f is called with the arguments (key, value).
If f returns a non-nil value the loop is broken, and this value is returned as the result from table.foreach. Effectively this could be used to find an element inside a table matching a certain condition.
t = { "the", "quick", "brown", "fox", name = "Nick" }
table.foreach (t, print)
-->
1 the
2 quick
3 brown
4 fox
name Nick
Warning the use of table.foreach is deprecated. This means it may not be available in future versions of Lua. You are recommended to rewrite such uses by using the 'pairs' function. For example:
for k, v in pairs (t) do
f (k, v)
end
See Also ...
Lua functions
table.concat - Concatenates table items together into a string
table.foreachi - Applies a function to each item in a numerically-keyed table
table.getn - Returns the size of a numerically-keyed table
table.insert - Inserts a new item into a numerically-keyed table
table.maxn - Returns the highest numeric key in the table
table.remove - Removes an item from a numerically-keyed table
table.setn - Sets the size of a table (obsolete)
table.sort - Sorts a table
Topics
Lua base functions
Lua bc (big number) functions
Lua bit manipulation functions
Lua coroutine functions
Lua debug functions
Lua io functions
Lua LPEG library
Lua math functions
Lua os functions
Lua package functions
Lua PCRE regular expression functions
Lua script extensions
Lua string functions
Lua syntax
Lua table functions
Lua utilities
Scripting
Scripting callbacks - plugins
(Help topic: lua=table.foreach)