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.
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() |
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)
Constructs a PackedColorArray as a copy of the given PackedColorArray.
PackedColorArray PackedColorArray(from: Array)
Constructs a new PackedColorArray. Optionally, you can pass in a generic Array that will be converted.
Note: When initializing a PackedColorArray with elements, it must be initialized with an Array of Color values:
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) 🔗
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() 🔗
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.
Returns the Color at the given index in the array. If index out-of-bounds or negative, this method fails and returns Color(0, 0, 0, 1).
This method is similar (but not identical) to the [] operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
bool has(value: Color) const 🔗
Returns true if the array contains 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.
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: Color, 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: Color) 🔗
Cambia el Color en el índice dado.
Devuelve el numer de elementos en el array.
PackedColorArray slice(begin: int, end: int = 2147483647) const 🔗
Returns the slice of the PackedColorArray, from begin (inclusive) to end (exclusive), as a new PackedColorArray.
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 color encoded as bytes.
Descripciones de Operadores
bool operator !=(right: PackedColorArray) 🔗
Returns true if contents of the arrays differ.
PackedColorArray operator +(right: PackedColorArray) 🔗
Returns a new PackedColorArray with contents of right added at the end of this array. For better performance, consider using append_array() instead.
bool operator ==(right: PackedColorArray) 🔗
Returns true if contents of both arrays are the same, i.e. they have all equal Colors at the corresponding indices.
Color operator [](index: int) 🔗
Returns the Color 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.