Difference between revisions of "Pairs"

From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2011.6<br/> === Description === Returns three values: an iterator function, the table t, and nil, so that the construction for...")
 
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(9 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 nil, so that the construction  
+
Returns three values: an iterator function, the table t, and nil, so that the construction:
 +
 
 +
for i,v in pairs(t) do body end
 +
 
 +
will iterate over any key pairs (indexed or associative) even with nil values.
 +
<syntaxhighlight lang="lua">
 +
(function), (table), (nil) = pairs(t)
 +
</syntaxhighlight>
  
    for i,v in pairs(t) do body end
+
=== Parameters ===
 +
'''t''': (table) table to iterate<br/>
  
will iterate over any key pairs (indexed or associative) even with nil values
+
=== Return values ===
<source lang="lua">
 
(function) (table) (nil), = pairs(t,)
 
</source>
 
'''t:''' (table) table to iterate ''''''<br/>
 
 
'''Returns''' (function) iterator function<br/>
 
'''Returns''' (function) iterator function<br/>
 
'''Returns''' (table) provided table<br/>
 
'''Returns''' (table) provided table<br/>
 
'''Returns''' (nil) nil value<br/>
 
'''Returns''' (nil) nil value<br/>
 +
 +
{{(global)}}

Latest revision as of 14:32, 13 July 2023

Available since: Gideros 2011.6
Class: (global)

Description

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

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

will iterate over any key pairs (indexed or associative) even with nil values.

(function), (table), (nil) = pairs(t)

Parameters

t: (table) table to iterate

Return values

Returns (function) iterator function
Returns (table) provided table
Returns (nil) nil value