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...
PackedColorArray
Un array empaquetado de Colors.
Descripción
An array specifically designed to hold Color. Packs data tightly, so it saves memory for large array sizes.
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. PackedColorArray versus Array[Color]). 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.
Note: In a boolean context, a packed array will evaluate to false if it's empty. Otherwise, a packed array will always evaluate to true.
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.
Constructores
PackedColorArray(from: PackedColorArray) |
|
PackedColorArray(from: Array) |
Métodos
void |
append_array(array: PackedColorArray) |
void |
clear() |
duplicate() const |
|
void |
|
is_empty() const |
|
void |
|
void |
reverse() |
void |
|
size() const |
|
void |
sort() |
to_byte_array() const |
Operadores
operator !=(right: PackedColorArray) |
|
operator +(right: PackedColorArray) |
|
operator ==(right: PackedColorArray) |
|
operator [](index: int) |
Descripciones de Constructores
PackedColorArray PackedColorArray() 🔗
Construye un PackedColorArray vacío.
PackedColorArray PackedColorArray(from: PackedColorArray)
Construye un PackedColorArray como una copia del PackedColorArray dado.
PackedColorArray PackedColorArray(from: Array)
Construye un nuevo PackedColorArray. Opcionalmente, puedes pasar un Array genérico que será convertido.
Nota: Al inicializar un PackedColorArray con elementos, debe ser inicializado con un Array de valores Color:
var array = PackedColorArray([Color(0.1, 0.2, 0.3), Color(0.4, 0.5, 0.6)])
Descripciones de Métodos
Concatena un elemento al final del array (alias de push_back()).
void append_array(array: PackedColorArray) 🔗
Añade un PackedColorArray al final de este array.
int bsearch(value: Color, before: bool = true) const 🔗
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: Color) const 🔗
Devuelve el numer de veces que un elemento es encuentra en el array.
PackedColorArray duplicate() const 🔗
Creates a copy of the array, and returns it.
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.
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: Color, 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.
Devuelve el Color en el index dado en el array. Si index está fuera de los límites o es negativo, este método falla y devuelve Color(0, 0, 0, 1).
Este método es similar (pero no idéntico) al operador []. En particular, cuando este método falla, no pausa la ejecución del proyecto si se ejecuta desde el editor.
bool has(value: Color) const 🔗
Devuelve true si el array contiene value.
int insert(at_index: int, value: Color) 🔗
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()).
Devuelve true si el array es vacio.
bool push_back(value: Color) 🔗
Añade un valor al array.
Elimina un elemento del array por indice.
Establece el tamaño del array. Si el array aumenta de tamaño, reserva elementos al final del array. Si el array se encoge, trunca el array al nuevo tamaño. Llamar a resize() una vez y asignar los nuevos valores es más rápido que añadir nuevos elementos uno por uno.
Devuelve @GlobalScope.OK si tiene éxito, o una de las siguientes constantes Error si este método falla: @GlobalScope.ERR_INVALID_PARAMETER si el tamaño es negativo, o @GlobalScope.ERR_OUT_OF_MEMORY si las asignaciones fallan. Usa size() para encontrar el tamaño real del array después del redimensionamiento.
void reverse() 🔗
Invierte el orden de los elementos en el array.
int rfind(value: Color, from: int = -1) const 🔗
Busca el array en orden inverso. Opcionalmente, se puede pasar un índice de búsqueda inicial. Si es negativo, el índice inicial se considera relativo al final del array.
void set(index: int, value: Color) 🔗
Cambia el Color en el índice dado.
Devuelve el numer de elementos en el array.
PackedColorArray slice(begin: int, end: int = 2147483647) const 🔗
Devuelve la porción del PackedColorArray, desde begin (inclusivo) hasta end (exclusive), como un nuevo PackedColorArray.
El valor absoluto de begin y end se ajustará al tamaño del array, por lo que el valor predeterminado para end hace que se divida hasta el tamaño del array por defecto (es decir, arr.slice(1) es una abreviatura de arr.slice(1, arr.size())).
Si begin o end son negativos, serán relativos al final del array (es decir, arr.slice(0, -2) es una abreviatura de arr.slice(0, arr.size() - 2)).
void sort() 🔗
Ordena los elementos del array en orden ascendente.
PackedByteArray to_byte_array() const 🔗
Devuelve un PackedByteArray con cada color codificado como bytes.
Descripciones de Operadores
bool operator !=(right: PackedColorArray) 🔗
Devuelve true si los contenidos de los arrays difieren.
PackedColorArray operator +(right: PackedColorArray) 🔗
Devuelve un nuevo PackedColorArray con el contenido de right añadido al final de este array. Para un mejor rendimiento, considera usar append_array() en su lugar.
bool operator ==(right: PackedColorArray) 🔗
Devuelve true si el contenido de ambos arrays es el mismo, es decir, tienen todos los Colors iguales en los índices correspondientes.
Color operator [](index: int) 🔗
Devuelve el Color en el índice index. Se pueden usar índices negativos para acceder a los elementos empezando por el final. Usar un índice fuera de los límites del array resultará en un error.