Class PackedVector2Array

A packed array of Vector2s.

PackedVector2Array

Remarks

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. The returned packed array of these are a copies, and changing it will not affect the original value. To update a built-in property you need to modify the returned array, and then assign it to the property again.

See Also

Grid-based Navigation with AStarGrid2D Demo

Constructors

PackedVector2Array

Constructs an empty PackedVector2Array.

PackedVector2Array PackedVector2Array

PackedVector2Array(PackedVector2Array)

Constructs a PackedVector2Array as a copy of the given PackedVector2Array.

PackedVector2Array PackedVector2Array(PackedVector2Array from)

Parameters

from PackedVector2Array

PackedVector2Array(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)])

PackedVector2Array PackedVector2Array(Array from)

Parameters

from Array

Methods

append(Vector2)

Appends an element at the end of the array (alias of PackedVector2Array.push_back).

bool append(Vector2 value)

Parameters

value Vector2

append_array(PackedVector2Array)

Appends a PackedVector2Array at the end of this array.

void append_array(PackedVector2Array array)

Parameters

array PackedVector2Array

bsearch(Vector2, bool)

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 PackedVector2Array.bsearch on an unsorted array results in unexpected behavior.

Note: Vectors with 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 bsearch(Vector2 value, bool before)

Parameters

value Vector2

before bool

clear

Clears the array. This is equivalent to using PackedVector2Array.resize with a size of 0.

void clear

count(Vector2)

Qualifiers: const

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

Note: Vectors with 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 count(Vector2 value)

Parameters

value Vector2

duplicate

Creates a copy of the array, and returns it.

PackedVector2Array duplicate

fill(Vector2)

Assigns the given value to all elements in the array. This can typically be used together with PackedVector2Array.resize to create an array with a given size and initialized elements.

void fill(Vector2 value)

Parameters

value Vector2

find(Vector2, int)

Qualifiers: 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 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 find(Vector2 value, int from)

Parameters

value Vector2

from int

get(int)

Qualifiers: const

Returns the Vector2 at the given index in the array. This is the same as using the [] operator (array[index]).

Vector2 get(int index)

Parameters

index int

has(Vector2)

Qualifiers: const

Returns true if the array contains value.

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

bool has(Vector2 value)

Parameters

value Vector2

insert(int, Vector2)

Inserts a new element at a given position in the array. The position must be valid, or at the end of the array (idx == size()).

int insert(int at_index, Vector2 value)

Parameters

at_index int

value Vector2

is_empty

Qualifiers: const

Returns true if the array is empty.

bool is_empty

push_back(Vector2)

Inserts a Vector2 at the end.

bool push_back(Vector2 value)

Parameters

value Vector2

remove_at(int)

Removes an element from the array by index.

void remove_at(int index)

Parameters

index int

resize(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 PackedVector2Array.resize once and assigning the new values is faster than adding new elements one by one.

int resize(int new_size)

Parameters

new_size int

reverse

Reverses the order of the elements in the array.

void reverse

rfind(Vector2, int)

Qualifiers: 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 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 rfind(Vector2 value, int from)

Parameters

value Vector2

from int

set(int, Vector2)

Changes the Vector2 at the given index.

void set(int index, Vector2 value)

Parameters

index int

value Vector2

size

Qualifiers: const

Returns the number of elements in the array.

int size

slice(int, int)

Qualifiers: 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)).

PackedVector2Array slice(int begin, int end)

Parameters

begin int

end int

sort

Sorts the elements of the array in ascending order.

Note: Vectors with 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 sort

to_byte_array

Qualifiers: const

Returns a PackedByteArray with each vector encoded as bytes.

PackedByteArray to_byte_array

Operators

!= (PackedVector2Array)

Returns true if contents of the arrays differ.

bool != (PackedVector2Array right)

Parameters

right PackedVector2Array

* (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 inverse.

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

PackedVector2Array * (Transform2D right)

Parameters

right Transform2D

+ (PackedVector2Array)

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

PackedVector2Array + (PackedVector2Array right)

Parameters

right PackedVector2Array

== (PackedVector2Array)

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

bool == (PackedVector2Array right)

Parameters

right PackedVector2Array

[] (int)

Returns the Vector2 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.

Vector2 [] (int index)

Parameters

index int