Table.remove

From GiderosMobile
Revision as of 14:31, 13 July 2023 by Hgy29 (talk | contribs) (Text replacement - "<source" to "<syntaxhighlight")

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. <syntaxhighlight lang="lua"> (varies) = table.remove(table,pos) </source>

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