PackedStringArray

Un array empaquetado de Strings.

Descripción

An array specifically designed to hold Strings. Packs data tightly, so it saves memory for large array sizes.

If you want to join the strings in the array, use String.join().

var string_array = PackedStringArray(["hello", "world"])
var string = " ".join(string_array)
print(string) # "hello world"

Differences between packed arrays, typed arrays, and untyped arrays: Packed arrays are generally faster to iterate on and modify compared to a typed array of the same type (e.g. PackedStringArray versus Array[String]). Also, packed arrays consume less memory. As a downside, packed arrays are less flexible as they don't offer as many convenience methods such as Array.map(). Typed arrays are in turn faster to iterate on and modify than untyped arrays.

Note: Packed arrays are always passed by reference. To get a copy of an array that can be modified independently of the original array, use duplicate(). This is not the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will not affect the original value. To update a built-in property of this type, modify the returned array and then assign it to the property again.

Nota

Hay diferencias notables cuando usa esta API con C#. Véase Diferencias de la API de C# con GDScript para más información.

Tutoriales

Constructores

PackedStringArray

PackedStringArray()

PackedStringArray

PackedStringArray(from: PackedStringArray)

PackedStringArray

PackedStringArray(from: Array)

Métodos

bool

append(value: String)

void

append_array(array: PackedStringArray)

int

bsearch(value: String, before: bool = true)

void

clear()

int

count(value: String) const

PackedStringArray

duplicate()

bool

erase(value: String)

void

fill(value: String)

int

find(value: String, from: int = 0) const

String

get(index: int) const

bool

has(value: String) const

int

insert(at_index: int, value: String)

bool

is_empty() const

bool

push_back(value: String)

void

remove_at(index: int)

int

resize(new_size: int)

void

reverse()

int

rfind(value: String, from: int = -1) const

void

set(index: int, value: String)

int

size() const

PackedStringArray

slice(begin: int, end: int = 2147483647) const

void

sort()

PackedByteArray

to_byte_array() const

Operadores

bool

operator !=(right: PackedStringArray)

PackedStringArray

operator +(right: PackedStringArray)

bool

operator ==(right: PackedStringArray)

String

operator [](index: int)


Descripciones de Constructores

PackedStringArray PackedStringArray() 🔗

Construye un PackedStringArray vacío.


PackedStringArray PackedStringArray(from: PackedStringArray)

Constructs a PackedStringArray as a copy of the given PackedStringArray.


PackedStringArray PackedStringArray(from: Array)

Constructs a new PackedStringArray. Optionally, you can pass in a generic Array that will be converted.


Descripciones de Métodos

bool append(value: String) 🔗

Concatena un elemento al final del array (alias de push_back()).


void append_array(array: PackedStringArray) 🔗

Añade un PackedStringArray al final de este array.


int bsearch(value: String, before: bool = true) 🔗

Encuentra el índice de un valor existente (o el índice de inserción que mantiene el orden de clasificación, si el valor aún no está presente en el array) utilizando la búsqueda binaria. Opcionalmente, se puede pasar un especificador before. Si es false, el índice devuelto viene después de todas las entradas existentes del valor en el array.

Nota: Llamar a bsearch() en un array sin ordenar da como resultado un comportamiento inesperado.


void clear() 🔗

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


int count(value: String) const 🔗

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


PackedStringArray duplicate() 🔗

Creates a copy of the array, and returns it.


bool erase(value: String) 🔗

Elimina la primera aparición de un valor del array y devuelve true. Si el valor no existe en el array, no sucede nada y se devuelve false. Para eliminar un elemento por índice, usa remove_at() en su lugar.


void fill(value: String) 🔗

Asigna el valor dado a todos los elementos del array. Esto normalmente se puede usar junto con resize() para crear un array con un tamaño dado y elementos inicializados.


int find(value: String, from: int = 0) const 🔗

Busca un valor en el array y devuelve su índice o -1 si no lo encuentra. Opcionalmente, se puede pasar el índice de búsqueda inicial.


String get(index: int) const 🔗

Returns the String at the given index in the array. Returns an empty string and prints an error if the access is out of bounds. Negative indices are not supported; they will always consider the value to be out of bounds and return an empty string.

This is similar to using the [] operator (array[index]), except that operator supports negative indices and causes a debugger break if out-of-bounds access is performed.


bool has(value: String) const 🔗

Returns true if the array contains value.


int insert(at_index: int, value: String) 🔗

Inserta un nuevo elemento en una posición determinada del array. La posición debe ser válida, o al final del array (idx == size()).


bool is_empty() const 🔗

Devuelve true si el array es vacio.


bool push_back(value: String) 🔗

Añade un elemento de string al final de la array.


void remove_at(index: int) 🔗

Elimina un elemento del array por indice.


int resize(new_size: int) 🔗

Sets the size of the array. If the array is grown, reserves elements at the end of the array. If the array is shrunk, truncates the array to the new size. Calling resize() once and assigning the new values is faster than adding new elements one by one.

Returns @GlobalScope.OK on success, or one of the following Error constants if this method fails: @GlobalScope.ERR_INVALID_PARAMETER if the size is negative, or @GlobalScope.ERR_OUT_OF_MEMORY if allocations fail. Use size() to find the actual size of the array after resize.


void reverse() 🔗

Invierte el orden de los elementos en el array.


int rfind(value: String, from: int = -1) const 🔗

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 set(index: int, value: String) 🔗

Cambia la String en el índice dado.


int size() const 🔗

Devuelve el numer de elementos en el array.


PackedStringArray slice(begin: int, end: int = 2147483647) const 🔗

Returns the slice of the PackedStringArray, from begin (inclusive) to end (exclusive), as a new PackedStringArray.

The absolute value of begin and end will be clamped to the array size, so the default value for end makes it slice to the size of the array by default (i.e. arr.slice(1) is a shorthand for arr.slice(1, arr.size())).

If either begin or end are negative, they will be relative to the end of the array (i.e. arr.slice(0, -2) is a shorthand for arr.slice(0, arr.size() - 2)).


void sort() 🔗

Sorts the elements of the array in ascending order.


PackedByteArray to_byte_array() const 🔗

Returns a PackedByteArray with each string encoded as UTF-8. Strings are null terminated.


Descripciones de Operadores

bool operator !=(right: PackedStringArray) 🔗

Returns true if contents of the arrays differ.


PackedStringArray operator +(right: PackedStringArray) 🔗

Returns a new PackedStringArray with contents of right added at the end of this array. For better performance, consider using append_array() instead.


bool operator ==(right: PackedStringArray) 🔗

Returns true if contents of both arrays are the same, i.e. they have all equal Strings at the corresponding indices.


String operator [](index: int) 🔗

Returns the String at index index. Negative indices can be used to access the elements starting from the end. Using index out of array's bounds will result in an error.