PackedVector2Array

A packed Array of Vector2s.

Description

An Array specifically designed to hold Vector2. Packs data tightly, so it saves memory for large array sizes.

Tutorials

• 2D Navigation Astar Demo

Constructors

PackedVector2Array	PackedVector2Array ( )
PackedVector2Array	PackedVector2Array ( PackedVector2Array from )
PackedVector2Array	PackedVector2Array ( Array from )

Methods

bool	append ( Vector2 value )
void	append_array ( PackedVector2Array array )
int	bsearch ( Vector2 value, bool before=true )
PackedVector2Array	duplicate ( )
void	fill ( Vector2 value )
bool	has ( Vector2 value ) const
int	insert ( int at_index, Vector2 value )
bool	is_empty ( ) const
bool	push_back ( Vector2 value )
void	remove ( int index )
int	resize ( int new_size )
void	reverse ( )
void	set ( int index, Vector2 value )
int	size ( ) const
void	sort ( )
PackedVector2Array	subarray ( int from, int to ) const
PackedByteArray	to_byte_array ( ) const

Operators

bool	operator != ( )
bool	operator != ( PackedVector2Array right )
PackedVector2Array	operator * ( Transform2D right )
PackedVector2Array	operator + ( PackedVector2Array right )
bool	operator == ( )
bool	operator == ( PackedVector2Array right )
Vector2	operator [] ( int index )

Constructor Descriptions

• PackedVector2Array PackedVector2Array ( )

Constructs an empty PackedVector2Array.

---

• PackedVector2Array PackedVector2Array ( PackedVector2Array from )

Constructs a PackedVector2Array as a copy of the given PackedVector2Array.

---

• PackedVector2Array PackedVector2Array ( Array from )

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

Method Descriptions

• bool append ( Vector2 value )

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

---

• void append_array ( PackedVector2Array array )

Appends a PackedVector2Array at the end of this array.

---

• int bsearch ( Vector2 value, bool before=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.

---

• PackedVector2Array duplicate ( )

Creates a copy of the array, and returns it.

---

• void fill ( Vector2 value )

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

---

• bool has ( Vector2 value ) const

Returns true if the array contains value.

---

• int insert ( int at_index, Vector2 value )

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()).

---

• bool is_empty ( ) const

Returns true if the array is empty.

---

• bool push_back ( Vector2 value )

Inserts a Vector2 at the end.

---

• void remove ( int index )

Removes an element from the array by index.

---

• int resize ( int new_size )

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.

---

• void reverse ( )

Reverses the order of the elements in the array.

---

• void set ( int index, Vector2 value )

Changes the Vector2 at the given index.

---

• int size ( ) const

Returns the size of the array.

---

• void sort ( )

Sorts the elements of the array in ascending order.

---

• PackedVector2Array subarray ( int from, int to ) const

---

• PackedByteArray to_byte_array ( ) const

Operator Descriptions

• bool operator != ( )

---

• bool operator != ( PackedVector2Array right )

---

• PackedVector2Array operator * ( Transform2D right )

---

• PackedVector2Array operator + ( PackedVector2Array right )

---

• bool operator == ( )

---

• bool operator == ( PackedVector2Array right )

---

• Vector2 operator [] ( int index )