Difference between revisions of "Unpack"

From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight")
 
(6 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 the elements from the given table. This function is equivalent to
+
Returns the elements from the given table.
 +
<syntaxhighlight lang="lua">
 +
(multiple) = unpack(list)
 +
</source>
  
    return list[i], list[i+1], ···, list[j]
+
This function is equivalent to
 +
return list[i], list[i+1], ···, list[j]
 +
except that the above code can be written only for a fixed number of elements. By default, i is 1 and j is the length of the list, as defined by the length operator.
  
except that the above code can be written only for a fixed number of elements. By default, i is 1 and j is the length of the list, as defined by the length operator.
 
<source lang="lua">
 
(multiple) = unpack(list)
 
</source>
 
 
=== Parameters ===
 
=== Parameters ===
'''list''': (table) table from which to extract elements <br/>
+
'''list''': (table) table from which to extract elements<br/>
 +
 
 
=== Return values ===
 
=== Return values ===
 
'''Returns''' (multiple) all values from table as separate values<br/>
 
'''Returns''' (multiple) all values from table as separate values<br/>
 +
 +
{{(global)}}

Latest revision as of 15:32, 13 July 2023

Available since: Gideros 2011.6
Class: (global)

Description

Returns the elements from the given table. <syntaxhighlight lang="lua"> (multiple) = unpack(list) </source>

This function is equivalent to

return list[i], list[i+1], ···, list[j]

except that the above code can be written only for a fixed number of elements. By default, i is 1 and j is the length of the list, as defined by the length operator.

Parameters

list: (table) table from which to extract elements

Return values

Returns (multiple) all values from table as separate values