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...
PackedVector3Array
Un array empaquetado de Vector3s.
Descripción
An array specifically designed to hold Vector3. 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. PackedVector3Array versus Array[Vector3]). 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
PackedVector3Array(from: Array) |
Métodos
void |
append_array(array: PackedVector3Array) |
void |
clear() |
duplicate() const |
|
void |
|
is_empty() const |
|
void |
|
void |
reverse() |
void |
|
size() const |
|
void |
sort() |
to_byte_array() const |
Operadores
operator !=(right: PackedVector3Array) |
|
operator *(right: Transform3D) |
|
operator +(right: PackedVector3Array) |
|
operator ==(right: PackedVector3Array) |
|
operator [](index: int) |
Descripciones de Constructores
PackedVector3Array PackedVector3Array() 🔗
Construye un PackedVector3Array vacío.
PackedVector3Array PackedVector3Array(from: PackedVector3Array)
Construye un PackedVector3Array como una copia del PackedVector3Array dado.
PackedVector3Array PackedVector3Array(from: Array)
Construye un nuevo PackedVector3Array. Opcionalmente, puedes pasar un Array genérico que será convertido.
Nota: Al inicializar un PackedVector3Array con elementos, debe ser inicializado con un Array de valores Vector3:
var array = PackedVector3Array([Vector3(12, 34, 56), Vector3(78, 90, 12)])
Descripciones de Métodos
Concatena un elemento al final del array (alias de push_back()).
void append_array(array: PackedVector3Array) 🔗
Añade un PackedVector3Array al final de este array.
int bsearch(value: Vector3, before: bool = true) const 🔗
Encuentra el índice de un valor existente (o el índice de inserción que mantiene el orden, si el valor aún no está presente en el array) usando búsqueda binaria. Opcionalmente, se puede pasar un especificador before. Si es false, el índice devuelto vendrá después de todas las entradas existentes del valor en el array.
Nota: Llamar a bsearch() en un array sin ordenar resultará en un comportamiento inesperado.
Nota: Los vectores con elementos @GDScript.NAN no se comportan igual que otros vectores. Por lo tanto, los resultados de este método pueden no ser precisos si se incluyen NaNs.
void clear() 🔗
Limpia el array. Esto es equivalente a usar resize() con un tamaño de 0.
int count(value: Vector3) const 🔗
Devuelve el número de veces que un elemento se encuentra en el array.
Nota: Los vectores con elementos @GDScript.NAN no se comportan igual que otros vectores. Por lo tanto, los resultados de este método pueden no ser precisos si se incluyen NaNs.
PackedVector3Array duplicate() const 🔗
Creates a copy of the array, and returns it.
Elimina la primera ocurrencia de un valor del array y devuelve true. Si el valor no existe en el array, no ocurre nada y se devuelve false. Para eliminar un elemento por índice, usa remove_at() en su lugar.
Nota: Los vectores con elementos @GDScript.NAN no se comportan igual que otros vectores. Por lo tanto, los resultados de este método pueden no ser precisos si se incluyen NaNs.
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: Vector3, from: int = 0) const 🔗
Busca el array por un valor y devuelve su índice o -1 si no se encuentra. Opcionalmente, se puede pasar el índice de búsqueda inicial.
Nota: Los vectores con elementos @GDScript.NAN no se comportan igual que otros vectores. Por lo tanto, los resultados de este método podrían no ser precisos si se incluyen NaNs.
Vector3 get(index: int) const 🔗
Devuelve el Vector3 en el index dado en el array. Si index está fuera de los límites o es negativo, este método falla y devuelve Vector3(0, 0, 0).
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: Vector3) const 🔗
Devuelve true si el array contiene value.
Nota: Los vectores con elementos @GDScript.NAN no se comportan igual que otros vectores. Por lo tanto, los resultados de este método pueden no ser precisos si se incluyen NaNs.
int insert(at_index: int, value: Vector3) 🔗
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: Vector3) 🔗
Inserta un Vector3 al final.
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: Vector3, 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.
Nota: Los vectores con elementos @GDScript.NAN no se comportan igual que otros vectores. Por lo tanto, los resultados de este método pueden no ser precisos si se incluyen NaNs.
void set(index: int, value: Vector3) 🔗
Cambia el Vector3 en el índice dado.
Devuelve el numer de elementos en el array.
PackedVector3Array slice(begin: int, end: int = 2147483647) const 🔗
Devuelve la porción del PackedVector3Array, desde begin (inclusivo) hasta end (exclusivo), como un nuevo PackedVector3Array.
El valor absoluto de begin y end se ajustará al tamaño del array, por lo que el valor por defecto de end hace que se corte hasta el final 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.
Nota: Los vectores con elementos @GDScript.NAN no se comportan igual que otros vectores. Por lo tanto, los resultados de este método pueden no ser precisos si se incluyen NaNs.
PackedByteArray to_byte_array() const 🔗
Devuelve un PackedByteArray con cada vector codificado como bytes.
Descripciones de Operadores
bool operator !=(right: PackedVector3Array) 🔗
Devuelve true si los contenidos de los arrays difieren.
PackedVector3Array operator *(right: Transform3D) 🔗
Devuelve un nuevo PackedVector3Array con todos los vectores de este array transformados inversamente (multiplicados) por la matriz de transformación Transform3D dada, bajo la suposición de que la base de la transformación es ortonormal (es decir, la rotación/reflexión está bien, pero el escalado/sesgado no).
array * transform es equivalente a transform.inverse() * array. Véase Transform3D.inverse().
Para transformar por la inversa de una transformación afín (p. ej. con escalado) se puede usar en su lugar transform.affine_inverse() * array. Véase Transform3D.affine_inverse().
PackedVector3Array operator +(right: PackedVector3Array) 🔗
Devuelve un nuevo PackedVector3Array 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: PackedVector3Array) 🔗
Devuelve true si el contenido de ambos arrays es el mismo, es decir, tienen todos los Vector3s iguales en los índices correspondientes.
Vector3 operator [](index: int) 🔗
Devuelve el Vector3 en el índice index. Se pueden usar índices negativos para acceder a los elementos desde el final. Usar un índice fuera de los límites del array resultará en un error.