PackedVector2Array

Un array empaquetado de Vector2s.

Descripción

An array specifically designed to hold Vector2. 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. PackedVector2Array versus Array[Vector2]). 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

PackedVector2Array

PackedVector2Array()

PackedVector2Array

PackedVector2Array(from: PackedVector2Array)

PackedVector2Array

PackedVector2Array(from: Array)

Métodos

bool

append(value: Vector2)

void

append_array(array: PackedVector2Array)

int

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

void

clear()

int

count(value: Vector2) const

PackedVector2Array

duplicate()

bool

erase(value: Vector2)

void

fill(value: Vector2)

int

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

Vector2

get(index: int) const

bool

has(value: Vector2) const

int

insert(at_index: int, value: Vector2)

bool

is_empty() const

bool

push_back(value: Vector2)

void

remove_at(index: int)

int

resize(new_size: int)

void

reverse()

int

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

void

set(index: int, value: Vector2)

int

size() const

PackedVector2Array

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

void

sort()

PackedByteArray

to_byte_array() const

Operadores

bool

operator !=(right: PackedVector2Array)

PackedVector2Array

operator *(right: Transform2D)

PackedVector2Array

operator +(right: PackedVector2Array)

bool

operator ==(right: PackedVector2Array)

Vector2

operator [](index: int)


Descripciones de Constructores

PackedVector2Array PackedVector2Array() 🔗

Construye un PackedVector2Array vacío.


PackedVector2Array PackedVector2Array(from: PackedVector2Array)

Construye un PackedVector2Array como una copia del PackedVector2Array dado.


PackedVector2Array PackedVector2Array(from: Array)

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

Note: When initializing a PackedVector2Array with elements, it must be initialized with an Array of Vector2 values:

var array = PackedVector2Array([Vector2(12, 34), Vector2(56, 78)])

Descripciones de Métodos

bool append(value: Vector2) 🔗

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


void append_array(array: PackedVector2Array) 🔗

Añade un PackedVector2Array al final de este array.


int bsearch(value: Vector2, before: bool = 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. Optionally, a before specifier can be passed. If false, the returned index comes after all existing entries of the value in the array.

Note: Calling bsearch() on an unsorted array results in unexpected behavior.

Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.


void clear() 🔗

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


int count(value: Vector2) const 🔗

Returns the number of times an element is in the array.

Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.


PackedVector2Array duplicate() 🔗

Creates a copy of the array, and returns it.


bool erase(value: Vector2) 🔗

Removes the first occurrence of a value from the array and returns true. If the value does not exist in the array, nothing happens and false is returned. To remove an element by index, use remove_at() instead.

Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.


void fill(value: Vector2) 🔗

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: Vector2, from: int = 0) const 🔗

Searches the array for a value and returns its index or -1 if not found. Optionally, the initial search index can be passed.

Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.


Vector2 get(index: int) const 🔗

Returns the Vector2 at the given index in the array. If index out-of-bounds or negative, this method fails and returns Vector2(0, 0).

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: Vector2) const 🔗

Returns true if the array contains value.

Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.


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

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: Vector2) 🔗

Inserta un Vector2 al final.


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: Vector2, 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.

Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.


void set(index: int, value: Vector2) 🔗

Cambia el Vector2 en el índice dado.


int size() const 🔗

Devuelve el numer de elementos en el array.


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

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

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.

Note: Vectors with @GDScript.NAN elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.


PackedByteArray to_byte_array() const 🔗

Returns a PackedByteArray with each vector encoded as bytes.


Descripciones de Operadores

bool operator !=(right: PackedVector2Array) 🔗

Returns true if contents of the arrays differ.


PackedVector2Array operator *(right: Transform2D) 🔗

Returns a new PackedVector2Array with all vectors in this array inversely transformed (multiplied) by the given Transform2D transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not).

array * transform is equivalent to transform.inverse() * array. See Transform2D.inverse().

For transforming by inverse of an affine transformation (e.g. with scaling) transform.affine_inverse() * array can be used instead. See Transform2D.affine_inverse().


PackedVector2Array operator +(right: PackedVector2Array) 🔗

Devuelve un nuevo PackedVector2Array 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: PackedVector2Array) 🔗

Devuelve true si el contenido de ambos arrays es el mismo, es decir, tienen todos los Vector2 iguales en los índices correspondientes.


Vector2 operator [](index: int) 🔗

Devuelve el Vector2 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.