Difference between revisions of "Ipairs"

Latest revision as of 14:31, 13 July 2023

Available since: Gideros 2011.6
Class: (global)

Returns three values: an iterator function, the table t, and 0, so that the construction

for i,v in ipairs(t) do body end

will iterate over the pairs (1,t[1]), (2,t[2]), ..., up to the first integer key absent from the table.

(function), (table), (any) = ipairs(t)

t: (table) indexed table to iterate through

Returns (function) iterator function
Returns (table) provided table t
Returns (any) value

@@ Line 1: / Line 1: @@
 __NOTOC__
 '''Available since:''' Gideros 2011.6<br/>
+'''Class:''' [[(global)]]<br/>
 === Description ===
 Returns three values: an iterator function, the table t, and 0, so that the construction
+ ''for i,v in ipairs(t) do '''body''' end''
+will iterate over the pairs (1,t[1]), (2,t[2]), ..., up to the first integer key absent from the table.
+<syntaxhighlight lang="lua">
+(function), (table), (any) = ipairs(t)
+</syntaxhighlight>
-     `for i,v in ipairs(t) do body end`
+=== Parameters ===
+'''t''': (table) indexed table to iterate through<br/>
- will iterate over the pairs (1,t[1]), (2,t[2]), ···, up to the first integer key absent from the table.
+=== Return values ===
-<source lang="lua">
-(function) (table) (any), = ipairs(t,)
-</source>
-'''t:''' (table) indexed table to iterate through ''''''<br/>
 '''Returns''' (function) iterator function<br/>
 '''Returns''' (table) provided table t<br/>
-'''Returns''' (any) value 0<br/>
+'''Returns''' (any) value<br/>
+{{(global)}}