Description¶

A generic array that can contain several elements of any type, accessible by a numerical index starting at 0. Negative indices can be used to count from the back, like in Python (-1 is the last element, -2 is the second to last, etc.).

Example:

vararray=["One",2,3,"Four"]print(array[0])# One.print(array[2])# 3.print(array[-1])# Four.array[2]="Three"print(array[-2])# Three.

Arrays can be concatenated using the+ operator:

vararray1=["One",2]vararray2=[3,"Four"]print(array1+array2)# ["One", 2, 3, "Four"]

Note: Concatenating with the+= operator will create a new array, which has a cost. If you want to append another array to an existing array,append_array is more efficient.

Note: Arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, useduplicate.

Note: When declaring an array withconst, the array itself can still be mutated by defining the values at individual indices or pushing/removing elements. Usingconst will only prevent assigning the constant with another value after it was initialized.

Methods¶

Method Descriptions¶

• ArrayArray(PoolColorArray from)

Constructs an array from aPoolColorArray.

• ArrayArray(PoolVector3Array from)

Constructs an array from aPoolVector3Array.

• ArrayArray(PoolVector2Array from)

Constructs an array from aPoolVector2Array.

• ArrayArray(PoolStringArray from)

Constructs an array from aPoolStringArray.

• ArrayArray(PoolRealArray from)

Constructs an array from aPoolRealArray.

• ArrayArray(PoolIntArray from)

Constructs an array from aPoolIntArray.

• ArrayArray(PoolByteArray from)

Constructs an array from aPoolByteArray.

• voidappend(Variant value)

Appends an element at the end of the array (alias ofpush_back).

• voidappend_array(Array array)

Appends another array at the end of this array.

vararray1=[1,2,3]vararray2=[4,5,6]array1.append_array(array2)print(array1)# Prints [1, 2, 3, 4, 5, 6].

• Variantback()

Returns the last element of the array. Prints an error and returnsnull if the array is empty.

Note: Calling this function is not the same as writingarray[-1]. If the array is empty, accessing by index will pause project execution when running from the editor.

• intbsearch(Variant value,bool before=true)

Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search. Optionally, abefore specifier can be passed. Iffalse, the returned index comes after all existing entries of the value in the array.

Note: Callingbsearch on an unsorted array results in unexpected behavior.

• intbsearch_custom(Variant value,Object obj,String func,bool before=true)

Finds the index of an existing value (or the insertion index that maintains sorting order, if the value is not yet present in the array) using binary search and a custom comparison method declared in theobj. Optionally, abefore specifier can be passed. Iffalse, the returned index comes after all existing entries of the value in the array. The custom method receives two arguments (an element from the array and the value searched for) and must returntrue if the first argument is less than the second, and returnfalse otherwise.

funccardinal_to_algebraic(a):matcha:"one":return1"two":return2"three":return3"four":return4_:return0funccompare(a,b):returncardinal_to_algebraic(a)<cardinal_to_algebraic(b)func_ready():vara=["one","two","three","four"]# `compare` is defined in this object, so we use `self` as the `obj` parameter.print(a.bsearch_custom("three",self,"compare",true))# Expected value is 2.

Note: Callingbsearch_custom on an unsorted array results in unexpected behavior.

• voidclear()

Clears the array. This is equivalent to usingresize with a size of0.

• intcount(Variant value)

Returns the number of times an element is in the array.

• Arrayduplicate(bool deep=false)

Returns a copy of the array.

Ifdeep istrue, a deep copy is performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. Iffalse, a shallow copy is made and references to the original nested arrays and dictionaries are kept, so that modifying a sub-array or dictionary in the copy will also impact those referenced in the source array.

• boolempty()

Returnstrue if the array is empty.

• voiderase(Variant value)

Removes the first occurrence of a value from the array. If the value does not exist in the array, nothing happens. To remove an element by index, useremove instead.

Note: This method acts in-place and doesn't return a value.

Note: On large arrays, this method will be slower if the removed element is close to the beginning of the array (index 0). This is because all elements placed after the removed element have to be reindexed.

• intfind(Variant what,int from=0)

Searches the array for a value and returns its index or-1 if not found. Optionally, the initial search index can be passed.

• intfind_last(Variant value)

Searches the array in reverse order for a value and returns its index or-1 if not found.

• Variantfront()

Returns the first element of the array. Prints an error and returnsnull if the array is empty.

Note: Calling this function is not the same as writingarray[0]. If the array is empty, accessing by index will pause project execution when running from the editor.

• boolhas(Variant value)

Returnstrue if the array contains the given value.

["inside",7].has("inside")# True["inside",7].has("outside")# False["inside",7].has(7)# True["inside",7].has("7")# False

Note: This is equivalent to using thein operator as follows:

# Will evaluate to `true`.if2in[2,4,6,8]:pass

• inthash()

Returns a hashed 32-bit integer value representing the array and its contents.

Note:Arrays with equal content will always produce identical hash values. However, the reverse is not true. Returning identical hash values doesnot imply the arrays are equal, because different arrays can have identical hash values due to hash collisions.

• voidinsert(int position,Variant value)

Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (pos==size()).

Note: This method acts in-place and doesn't return a value.

Note: On large arrays, this method will be slower if the inserted element is close to the beginning of the array (index 0). This is because all elements placed after the newly inserted element have to be reindexed.

• voidinvert()

Reverses the order of the elements in the array.

• Variantmax()

Returns the maximum value contained in the array if all elements are of comparable types. If the elements can't be compared,null is returned.

• Variantmin()

Returns the minimum value contained in the array if all elements are of comparable types. If the elements can't be compared,null is returned.

• Variantpop_at(int position)

Removes and returns the element of the array at indexposition. If negative,position is considered relative to the end of the array. Leaves the array untouched and returnsnull 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.

Note: On large arrays, this method can be slower thanpop_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 slowerpop_at will be.

• Variantpop_back()

Removes and returns the last element of the array. Returnsnull if the array is empty, without printing an error message. See alsopop_front.

• Variantpop_front()

Removes and returns the first element of the array. Returnsnull if the array is empty, without printing an error message. See alsopop_back.

Note: On large arrays, this method is much slower thanpop_back as it will reindex all the array's elements every time it's called. The larger the array, the slowerpop_front will be.

• voidpush_back(Variant value)

Appends an element at the end of the array. See alsopush_front.

• voidpush_front(Variant value)

Adds an element at the beginning of the array. See alsopush_back.

Note: On large arrays, this method is much slower thanpush_back as it will reindex all the array's elements every time it's called. The larger the array, the slowerpush_front will be.

• voidremove(int position)

Removes an element from the array by index. If the index does not exist in the array, nothing happens. To remove an element by searching for its value, useerase instead.

Note: This method acts in-place and doesn't return a value.

Note: On large arrays, this method will be slower if the removed element is close to the beginning of the array (index 0). This is because all elements placed after the removed element have to be reindexed.

• voidresize(int size)

Resizes the array to contain a different number of elements. If the array size is smaller, elements are cleared, if bigger, new elements arenull.

• intrfind(Variant what,int from=-1)

Searches the array in reverse order. Optionally, a start search index can be passed. If negative, the start index is considered relative to the end of the array.

• voidshuffle()

Shuffles the array such that the items will have a random order. This method uses the global random number generator common to methods such as@GDScript.randi. Call@GDScript.randomize to ensure that a new seed will be used each time if you want non-reproducible shuffling.

• intsize()

Returns the number of elements in the array.

• Arrayslice(int begin,int end,int step=1,bool deep=false)

Duplicates the subset described in the function and returns it in an array, deeply copying the array ifdeep istrue. Lower and upper index are inclusive, with thestep describing the change between indices while slicing.

• voidsort()

Sorts the array.

Note: Strings are sorted in alphabetical order (as opposed to natural order). This may lead to unexpected behavior when sorting an array of strings ending with a sequence of numbers. Consider the following example:

varstrings=["string1","string2","string10","string11"]strings.sort()print(strings)# Prints [string1, string10, string11, string2]

• voidsort_custom(Object obj,String func)

Sorts the array using a custom method. The arguments are an object that holds the method and the name of such method. The custom method receives two arguments (a pair of elements from the array) and must return eithertrue orfalse.

For two elementsa andb, if the given method returnstrue, elementb will be after elementa in the array.

Note: You cannot randomize the return value as the heapsort algorithm expects a deterministic result. Doing so will result in unexpected behavior.

classMyCustomSorter:staticfuncsort_ascending(a,b):ifa[0]<b[0]:returntruereturnfalsevarmy_items=[[5,"Potato"],[9,"Rice"],[4,"Tomato"]]my_items.sort_custom(MyCustomSorter,"sort_ascending")print(my_items)# Prints [[4, Tomato], [5, Potato], [9, Rice]].