Table.remove: Difference between revisions
From GiderosMobile
No edit summary |
m Text replacement - "</source>" to "</syntaxhighlight>" |
||
| (8 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:''' [[table]]<br/> | |||
=== Description === | === Description === | ||
Removes from table the element at position pos, shifting down other elements to close the space | Removes from table the element at position pos, shifting down other elements to close the space if necessary. | ||
< | <syntaxhighlight lang="lua"> | ||
(varies) = table.remove(table,pos) | (varies) = table.remove(table,pos) | ||
</ | </syntaxhighlight> | ||
'''table''': (table) table from which to remove element | |||
Returns the value of the removed element. The default value for pos is n, where n is the length of the table, so that a call table.remove(t) removes the last element of table t. | |||
=== Parameters === | |||
'''table''': (table) table from which to remove element<br/> | |||
'''pos''': (number) index at which to remove element (default is last element) '''optional'''<br/> | '''pos''': (number) index at which to remove element (default is last element) '''optional'''<br/> | ||
=== Return values === | |||
'''Returns''' (varies) removed value<br/> | '''Returns''' (varies) removed value<br/> | ||
{{Table}} | |||
Latest revision as of 13:33, 13 July 2023
Available since: Gideros 2011.6
Class: table
Description
Removes from table the element at position pos, shifting down other elements to close the space if necessary.
(varies) = table.remove(table,pos)
Returns the value of the removed element. The default value for pos is n, where n is the length of the table, so that a call table.remove(t) removes the last element of table t.
Parameters
table: (table) table from which to remove element
pos: (number) index at which to remove element (default is last element) optional
Return values
Returns (varies) removed value