Difference between revisions of "Table.remove"
From GiderosMobile
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | '''Available since:''' Gideros 2011.6<br/> | + | '''<translate>Available since</translate>:''' Gideros 2011.6<br/> |
| − | === Description === | + | === <translate>Description</translate> === |
<translate>Removes from table the element at position pos, shifting down other elements to close the space, if necessary. 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.</translate> | <translate>Removes from table the element at position pos, shifting down other elements to close the space, if necessary. 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.</translate> | ||
<source lang="lua"> | <source lang="lua"> | ||
(varies) = table.remove(table,pos) | (varies) = table.remove(table,pos) | ||
</source> | </source> | ||
| − | === Parameters === | + | === <translate>Parameters</translate> === |
'''table''': (table) <translate>table from which to remove element</translate> <br/> | '''table''': (table) <translate>table from which to remove element</translate> <br/> | ||
'''pos''': (number) <translate>index at which to remove element (default is last element)</translate> '''optional'''<br/> | '''pos''': (number) <translate>index at which to remove element (default is last element)</translate> '''optional'''<br/> | ||
| − | === Return values === | + | === <translate>Return values</translate> === |
| − | '''Returns''' (varies) <translate>removed value</translate><br/> | + | '''<translate>Returns</translate>''' (varies) <translate>removed value</translate><br/> |
Revision as of 07:29, 24 August 2018
Available since: Gideros 2011.6
Description
Removes from table the element at position pos, shifting down other elements to close the space, if necessary. 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.
(varies) = table.remove(table,pos)
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
