Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

Array¶

A generic array datatype.

Descripción¶

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.

Métodos¶

Array	Array ( PoolColorArray from )
Array	Array ( PoolVector3Array from )
Array	Array ( PoolVector2Array from )
Array	Array ( PoolStringArray from )
Array	Array ( PoolRealArray from )
Array	Array ( PoolIntArray from )
Array	Array ( PoolByteArray from )
void	append ( Variant value )
void	append_array ( Array array )
Variant	back ( )
int	bsearch ( Variant value, bool before=true )
int	bsearch_custom ( Variant value, Object obj, String func, bool before=true )
void	clear ( )
int	count ( Variant value )
Array	duplicate ( bool deep=false )
bool	empty ( )
void	erase ( Variant value )
int	find ( Variant what, int from=0 )
int	find_last ( Variant value )
Variant	front ( )
bool	has ( Variant value )
int	hash ( )
void	insert ( int position, Variant value )
void	invert ( )
Variant	max ( )
Variant	min ( )
Variant	pop_at ( int position )
Variant	pop_back ( )
Variant	pop_front ( )
void	push_back ( Variant value )
void	push_front ( Variant value )
void	remove ( int position )
void	resize ( int size )
int	rfind ( Variant what, int from=-1 )
void	shuffle ( )
int	size ( )
Array	slice ( int begin, int end, int step=1, bool deep=false )
void	sort ( )
void	sort_custom ( Object obj, String func )

Descripciones de Métodos¶

Array Array ( PoolColorArray from )

Constructs an array from a PoolColorArray.

Array Array ( PoolVector3Array from )

Constructs an array from a PoolVector3Array.

Array Array ( PoolVector2Array from )

Constructs an array from a PoolVector2Array.

Array Array ( PoolStringArray from )

Constructs an array from a PoolStringArray.

Array Array ( PoolRealArray from )

Constructs an array from a PoolRealArray.

Array Array ( PoolIntArray from )

Constructs an array from a PoolIntArray.

Array Array ( PoolByteArray from )

Constructs an array from a PoolByteArray.

void append ( Variant value )

Concatena un elemento al final del array (alias de 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].

Variant back ( )

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.

int bsearch ( Variant value, bool before=true )

Encuentra el indice de un valor existente (o el indice de insercion que mantiene el ordenamiento, si el valor no esta todavia presente en el array) usando busqueda binario. Opcionalmente, un especificador before puede ser pasado. Si false, el indice devuelto vendra despues de todas las entradas existentes del valor en el array.

Nota: Llama al bsearch en un array sin ordenar causara comportamientos inesperados.

int bsearch_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 the obj. 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.

func cardinal_to_algebraic(a):
    match a:
        "one":
            return 1
        "two":
            return 2
        "three":
            return 3
        "four":
            return 4
        _:
            return 0

func compare(a, b):
    return cardinal_to_algebraic(a) < cardinal_to_algebraic(b)

func _ready():
    var a = ["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: Calling bsearch_custom on an unsorted array results in unexpected behavior.

void clear ( )

Limpia el array. Esto es equivalente a usar resize con un tamaño de 0.

int count ( Variant value )

Devuelve el numer de veces que un elemento es encuentra en el array.

Array duplicate ( bool deep=false )

Devuelve una copia del array.

Si deep es true, a copia profunda es ejecutada: todos los arrays anidados y diccionarios son duplicados y no seran compartidos con el array original. Si false, una copia superificial es dada y las referencias a los arrays anidados y los diccionarios son mantenidos, por lo que modificar un sub-array or diccionario en la copia tambien cambiara estas referencias en el array fuente.

bool empty ( )

Devuelve true si el array es vacio.

void erase ( Variant value )

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.

int find ( Variant what, int from=0 )

Busca el array por un valor y devuelve su indice o -1 sino se encuentra. Opcionalmente, el indice de busqueda inicial puede ser pasado.

int find_last ( Variant value )

Busca el array en orden inverso por un valor y devuelve su indice o -1 sino es encontrado.

Variant front ( )

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.

bool has ( Variant value )

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

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

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

int hash ( )

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.

void insert ( int position, Variant value )

Inserta un nuevo elemento en la posisción dada en el array. La posición debe ser valida, o al final de el array(pos == size().

Note: este metodo actua en el lugar y no devuelve ningún valor.

Note: en arrays largos, este metodo va a ser mas lento si el elemento incertado esta cerca al inicio del array (índice 0). Esto es por que todos los elementos despues del elemento incertado tienen que ser reindisados.

void invert ( )

Invierte el orden de los elementos en el array.

Variant max ( )

Devuelve el maximo valor contenido en el array si todos los elementos son de tipos comparables. Si los elementos no pueden ser comparados, null es devuelto.

Variant min ( )

Devuelve el minimo valor contenido en el array si todos los elementos son de tipos comparables. Si los elementos no pueden ser comparados, null es devuelto.

Variant pop_at ( int position )

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.

Variant pop_back ( )

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.

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

void push_back ( Variant value )

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.

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.

void resize ( int size )

Cambiar el tamaño del array para contener un numero diferente de elementos. Si el array es menor, los elementos so limipiados, si mayor, los nuevos elementos son null.

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

Busca el array en orden inverso. Opcionalmente, un indice de comienzo de busqueda puede ser pasado. Si negacion, el indice de comienzo es considerado relativo al final del array.

void shuffle ( )

Baraja el array de forma que los items tengan un orden aleatorio. Este metodo uso el generador de numeros globales aleatorios comun de metodos como @GDScript.randi. Llamar @GDScript.randomize para asegurar que una nueva semilla sea utilizada cada vez si tu no quieres reproducir el orden de los items.

int size ( )

Devuelve el numer de elementos en el array.

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

Duplica el subset descrito en la funcion y lo devuelve en un array, copiando profundamente el array si deep es true. Bajos y altos indices estan incluidos, cone el step] describiendo el cambio entre indices mientras se trocean.

void sort ( )

Ordena el array.

Nota: Las strings son ordenadas en orden alfabetico ( opuesto al orden natural). Esto puede llevar a comportamientos inesperados cuando se ordene un array de strings con una sequencia de numeros, considera lo siguiente:

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

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