From 60116b17b59c5e137924a9669ddc9bbe58a58ef7 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Fri, 27 Aug 2021 00:51:17 +0200 Subject: Add an `Array.pop_at()` method to pop an element at an arbitrary index Negative indices are supported to pop an element relative from the end. --- doc/classes/Array.xml | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'doc') diff --git a/doc/classes/Array.xml b/doc/classes/Array.xml index 7767a1028d..df0e3a0459 100644 --- a/doc/classes/Array.xml +++ b/doc/classes/Array.xml @@ -393,6 +393,14 @@ + + + + + Removes and returns the element of the array at index [code]position[/code]. If negative, [code]position[/code] is considered relative to the end of the array. Leaves the array untouched and returns [code]null[/code] if the array is empty or if it's accessed out of bounds. An error message is printed when the array is accessed out of bounds, but not when the array is empty. + [b]Note:[/b] On large arrays, this method can be slower than [method pop_back] as it will reindex the array's elements that are located after the removed element. The larger the array and the lower the index of the removed element, the slower [method pop_at] will be. + + -- cgit v1.2.3