Difference between revisions of "Ipairs"
From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>") |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
| + | '''Class:''' [[(global)]]<br/> | ||
| + | |||
=== Description === | === 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) | (function), (table), (any) = ipairs(t) | ||
| − | </ | + | </syntaxhighlight> |
| + | |||
=== Parameters === | === Parameters === | ||
| − | '''t''': (table) | + | '''t''': (table) indexed table to iterate through<br/> |
| + | |||
=== Return values === | === Return values === | ||
| − | '''Returns''' (function) | + | '''Returns''' (function) iterator function<br/> |
| − | '''Returns''' (table) | + | '''Returns''' (table) provided table t<br/> |
| − | '''Returns''' (any) | + | '''Returns''' (any) value<br/> |
| + | |||
| + | {{(global)}} | ||
Latest revision as of 15:31, 13 July 2023
Available since: Gideros 2011.6
Class: (global)
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.
(function), (table), (any) = ipairs(t)
Parameters
t: (table) indexed table to iterate through
Return values
Returns (function) iterator function
Returns (table) provided table t
Returns (any) value
