table.foreachi

Applies a function to each item in a numerically-keyed table

Prototype

val = table.foreachi (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.

Similar to table.foreach, except that only numeric keys in the range 1 to n are processed. 

t = { "the", "quick", "brown", "fox", name = 'Nick' }
table.foreachi (t, print)

 -->

1 the
2 quick
3 brown
4 fox
In this example the entry for "name = 'Nick'" was not returned because it did not have a numeric key.


Warning the use of table.foreachi is deprecated. This means it may not be available in future versions of Lua. You are recommended to rewrite such uses by using the 'ipairs' function. For example: 

for k, v in ipairs (t) do
  f (k, v)
end

Lua functions

Topics