Pairs: Difference between revisions

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..."
 
No edit summary
 
(10 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
for i,v in pairs(t) do body end


will iterate over any key pairs (indexed or associative) even with nil values
will iterate over any key pairs (indexed or associative) even with nil values.
<source lang="lua">
<syntaxhighlight lang="lua">
(function) (table) (nil), = pairs(t,)
(function), (table), (nil) = pairs(t)
</source>
</syntaxhighlight>
'''t:''' (table) table to iterate ''''''<br/>
 
=== Parameters ===
'''t''': (table) table to iterate<br/>
 
=== Return values ===
'''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/>
=== See also ===
'''https://luau.org/library#global-functions'''<br/>
{{(global)}}

Latest revision as of 10:28, 21 July 2025

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

See also

https://luau.org/library#global-functions