Array

Generic array datatype.

Description

Generic array which 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 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 are always passed by reference.

Methods

ArrayArray ( PoolColorArray from )
ArrayArray ( PoolVector3Array from )
ArrayArray ( PoolVector2Array from )
ArrayArray ( PoolStringArray from )
ArrayArray ( PoolRealArray from )
ArrayArray ( PoolIntArray from )
ArrayArray ( PoolByteArray from )
voidappend ( Variant value )
Variantback ( )
intbsearch ( Variant value, bool before=True )
intbsearch_custom ( Variant value, Object obj, String func, bool before=True )
voidclear ( )
intcount ( Variant value )
Arrayduplicate ( bool deep=False )
boolempty ( )
voiderase ( Variant value )
intfind ( Variant what, int from=0 )
intfind_last ( Variant value )
Variantfront ( )
boolhas ( Variant value )
inthash ( )
voidinsert ( int position, Variant value )
voidinvert ( )
Variantmax ( )
Variantmin ( )
Variantpop_back ( )
Variantpop_front ( )
voidpush_back ( Variant value )
voidpush_front ( Variant value )
voidremove ( int position )
voidresize ( int size )
intrfind ( Variant what, int from=-1 )
voidshuffle ( )
intsize ( )
Arrayslice ( int begin, int end, int step=1, bool deep=False )
voidsort ( )
voidsort_custom ( Object obj, String func )

Method Descriptions

Constructs an array from a PoolColorArray.


Constructs an array from a PoolVector3Array.


Constructs an array from a PoolVector2Array.


Constructs an array from a PoolStringArray.


Constructs an array from a PoolRealArray.


Constructs an array from a PoolIntArray.


Constructs an array from a PoolByteArray.


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


Returns the last element of the array, or null if the array is empty.


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 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.


Returns true if the array is empty.


Removes the first occurrence of a value from the array.


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, or null if the array is empty.


Returns true 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

Returns a hashed integer value representing the array contents.


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()).


  • void invert ( )

Reverses the order of the elements in the array.


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.


Removes and returns the last element of the array. Returns null if the array is empty.


Removes and returns the first element of the array. Returns null if the array is empty.


Appends an element at the end of the array.


Adds an element at the beginning of the array.


  • void remove ( int position )

Removes an element from the array by index.


  • void resize ( 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 are null.


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


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.


  • void sort ( )

Sorts the array.

Note: strings are sorted in alphabetical, not natural order.


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 either true or false.

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]].

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 2020-03-07 at 01:28:50. It's the English Stable version because it's what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.