View source for IPairs

{{Version|0.2.0}}
{{ApiReference
|name=ipairs
|shortdesc=Returns an iterator of index-value pairs for all elements in a table, for use with <code>for...in</code>.
|tbl||The table.
}}
The <code>ipairs()</code> iterator function is used exclusively with <code>for...in</code> to iterate over all elements in the indexed [[sequence]] (array-like) portion of the table. It emits the index and value together, which you can assign to variables in the <code>for</code> loop:
<syntaxhighlight lang="lua">
for i, v in ipairs(tbl) do
  -- ...
end
</syntaxhighlight>

This iterator produces only the values in the table which are considered part of its indexed sequence. It will not produce values associated with non-numeric keys, and it will not produce values for any indices greater than <code>#table</code>.

It is guaranteed that the indices will be produced in ascending order.

== Examples ==
<syntaxhighlight lang="lua">
t = {111, 222, 333}
for i, v in ipairs(t) do
  print(i..': '..v)
end
-- 1: 111
-- 2: 222
-- 3: 333

t = {123, 456, n=42, x=100, y=200}
for i, v in ipairs(t) do
  print(i..': '..v)
end
-- 1: 123
-- 2: 456
</syntaxhighlight>

== See also ==

* [[Lua]]
* [[Tables]]
* [[Add|<code>add()</code>]]
* [[All|<code>all()</code>]]
* [[Del|<code>del()</code>]]
* [[Foreach|<code>foreach()</code>]]
* [[Next|<code>next()</code>]]
* [[Pairs|<code>pairs()</code>]]
[[Category:Reference]]
[[Category:API]]
[[Category:Iterators]]
[[Category:Lua]]