Array

A generic array datatype.

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:

var array = ["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:

var array1 = ["One", 2]
var array2 = [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, use duplicate.

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

Methods

Array

Array ( ) constructor

Array

Array ( Array from ) constructor

Array

Array ( PackedByteArray from ) constructor

Array

Array ( PackedColorArray from ) constructor

Array

Array ( PackedFloat32Array from ) constructor

Array

Array ( PackedFloat64Array from ) constructor

Array

Array ( PackedInt32Array from ) constructor

Array

Array ( PackedInt64Array from ) constructor

Array

Array ( PackedStringArray from ) constructor

Array

Array ( PackedVector2Array from ) constructor

Array

Array ( PackedVector3Array from ) constructor

void

append ( Variant value )

void

append_array ( Array array )

Variant

back ( ) const

int

bsearch ( Variant value, bool before=true )

int

bsearch_custom ( Variant value, Callable func, bool before=true )

void

clear ( )

int

count ( Variant value ) const

Array

duplicate ( bool deep=false ) const

void

erase ( Variant value )

void

fill ( Variant value )

Array

filter ( Callable method ) const

int

find ( Variant what, int from=0 ) const

int

find_last ( Variant value ) const

Variant

front ( ) const

bool

has ( Variant value ) const

int

hash ( ) const

int

insert ( int position, Variant value )

bool

is_empty ( ) const

Array

map ( Callable method ) const

Variant

max ( ) const

Variant

min ( ) const

bool

operator != ( ) operator

bool

operator != ( Array right ) operator

Array

operator + ( Array right ) operator

bool

operator < ( Array right ) operator

bool

operator <= ( Array right ) operator

bool

operator == ( ) operator

bool

operator == ( Array right ) operator

bool

operator > ( Array right ) operator

bool

operator >= ( Array right ) operator

void

operator [] ( int index ) operator

Variant

pop_at ( int position )

Variant

pop_back ( )

Variant

pop_front ( )

void

push_back ( Variant value )

void

push_front ( Variant value )

Variant

reduce ( Callable method, Variant accum=null ) const

void

remove ( int position )

int

resize ( int size )

void

reverse ( )

int

rfind ( Variant what, int from=-1 ) const

void

shuffle ( )

int

size ( ) const

Array

slice ( int begin, int end, int step=1, bool deep=false ) const

void

sort ( )

void

sort_custom ( Callable func )

Method Descriptions

  • Array Array ( ) constructor

Constructs an empty Array.


Constructs an Array as a copy of the given Array.


Constructs an array from a PackedByteArray.


Constructs an array from a PackedColorArray.


Constructs an array from a PackedFloat32Array.


Constructs an array from a PackedFloat64Array.


Constructs an array from a PackedInt32Array.


Constructs an array from a PackedInt64Array.


Constructs an array from a PackedStringArray.


Constructs an array from a PackedVector2Array.


Constructs an array from a PackedVector3Array.


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


  • void append_array ( Array array )

Appends another array at the end of this array.

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

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

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


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, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array.

Note: Calling bsearch on an unsorted array results in unexpected behavior.


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. Optionally, a before specifier can be passed. If false, 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 return true if the first argument is less than the second, and return false otherwise.

Note: Calling bsearch_custom on an unsorted array results in unexpected behavior.


  • void clear ( )

Clears the array. This is equivalent to using resize with a size of 0.


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


Returns a copy of the array.

If deep is true, a deep copy is performed: all nested arrays and dictionaries are duplicated and will not be shared with the original array. If false, 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.


Removes the first occurrence of a value from the array. To remove an element by index, use remove 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.


Assigns the given value to all elements in the array. This can typically be used together with resize to create an array with a given size and initialized elements:

var array = []
array.resize(10)
array.fill(0) # Initialize the 10 elements to 0.

Calls the provided Callable on each element in the array and returns a new array with the elements for which the method returned true.

The callable's method should take one Variant parameter (the current array element) and return a boolean value.

func _ready():
    print([1, 2, 3].filter(remove_1)) # Prints [2, 3].
    print([1, 2, 3].filter(func(number): return number != 1)) # Same as above, but using lambda function.

func remove_1(number):
    return number != 1

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


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


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

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


Returns true if the array contains the given value.

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

Note: This is equivalent to using the in operator as follows:

# Will evaluate to `true`.
if 2 in [2, 4, 6, 8]:
    print("Contains!")

  • int hash ( ) const

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

Note: Arrays with equal contents can still produce different hashes. Only the exact same arrays will produce the same hashed integer 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.


  • bool is_empty ( ) const

Returns true if the array is empty.


Calls the provided Callable for each element in the array and returns a new array filled with values returned by the method.

The callable's method should take one Variant parameter (the current array element) and can return any Variant.

func _ready():
    print([1, 2, 3].map(negate)) # Prints [-1, -2, -3].
    print([1, 2, 3].map(func(number): return -number)) # Same as above, but using lambda function.

func negate(number):
    return -number

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.


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.


  • bool operator != ( ) operator






  • bool operator == ( ) operator





  • void operator [] ( int index ) operator


Removes and returns the element of the array at index position. If negative, position is considered relative to the end of the array. Leaves the array untouched and returns null 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 than 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 pop_at will be.


Removes and returns the last element of the array. Returns null if the array is empty, without printing an error message. See also pop_front.


Removes and returns the first element of the array. Returns null if the array is empty, without printing an error message. See also pop_back.

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


Appends an element at the end of the array. See also push_front.


  • void push_front ( Variant value )

Adds an element at the beginning of the array. See also push_back.

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


Calls the provided Callable for each element in array and accumulates the result in accum.

The callable's method takes two arguments: the current value of accum and the current array element. If accum is null (default value), the iteration will start from the second element, with the first one used as initial value of accum.

func _ready():
    print([1, 2, 3].reduce(sum, 10)) # Prints 16.
    print([1, 2, 3].reduce(func(accum, number): return accum + number, 10)) # Same as above, but using lambda function.

func sum(accum, number):
    return accum + number

  • void remove ( 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, use erase 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.


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


  • void reverse ( )

Reverses the order of the elements in the array.


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.


  • void shuffle ( )

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 @GlobalScope.randi. Call @GlobalScope.randomize to ensure that a new seed will be used each time if you want non-reproducible shuffling.


  • int size ( ) const

Returns the number of elements in the array.


Duplicates the subset described in the function and returns it in an array, deeply copying the array if deep is true. Lower and upper index are inclusive, with the step describing the change between indices while slicing. Wraps around if begin or end are out of bounds or negative. Returns an empty array for invalid parameters.


  • void sort ( )

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:

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

Sorts the array using a custom method. The custom method receives two arguments (a pair of elements from the array) and must return either true or false. For two elements a and b, if the given method returns true, element b will be after element a 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.

class MyCustomSorter:
    static func sort_ascending(a, b):
        if a[0] < b[0]:
            return true
        return false

var my_items = [[5, "Potato"], [9, "Rice"], [4, "Tomato"]]
my_items.sort_custom(MyCustomSorter.sort_ascending)
print(my_items) # Prints [[4, Tomato], [5, Potato], [9, Rice]].