PoolVector2Array

PoolVector2Array

A pooled array of Vector2s.

Description

An array specifically designed to hold Vector2. Optimized for memory usage, does not fragment the memory.

Note: This type is passed by value and not by reference. This means that when mutating a class property of type PoolVector2Array or mutating a PoolVector2Array within an Array or Dictionary, changes will be lost:

var array = [PoolVector2Array()]
array[0].push_back(Vector2(12, 34))
print(array)  # [[]] (empty PoolVector2Array within an Array)

Instead, the entire PoolVector2Array property must be reassigned with = for it to be changed:

var array = [PoolVector2Array()]
var pool_array = array[0]
pool_array.push_back(Vector2(12, 34))
array[0] = pool_array
print(array)  # [[(12, 34)]] (PoolVector2Array with 1 element inside an Array)

Tutorials

2D Navigation Astar Demo

Methods

PoolVector2Array	PoolVector2Array ( Array from )
void	append ( Vector2 vector2 )
void	append_array ( PoolVector2Array array )
int	count ( Vector2 value )
bool	empty ( )
void	fill ( Vector2 vector2 )
int	find ( Vector2 value, int from=0 )
bool	has ( Vector2 value )
int	insert ( int idx, Vector2 vector2 )
void	invert ( )
void	push_back ( Vector2 vector2 )
void	remove ( int idx )
void	resize ( int idx )
int	rfind ( Vector2 value, int from=-1 )
void	set ( int idx, Vector2 vector2 )
int	size ( )
void	sort ( )

Method Descriptions

PoolVector2Array PoolVector2Array ( Array from )

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

void append ( Vector2 vector2 )

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

void append_array ( PoolVector2Array array )

Appends a PoolVector2Array at the end of this array.

int count ( Vector2 value )

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

bool empty ( )

Returns true if the array is empty.

void fill ( Vector2 vector2 )

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.

int find ( Vector2 value, int from=0 )

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

bool has ( Vector2 value )

Returns true if the array contains the given value.

Note: This is equivalent to using the in operator.

int insert ( int idx, Vector2 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()).

void invert ( )

Reverses the order of the elements in the array.

void push_back ( Vector2 vector2 )

Inserts a Vector2 at the end.

void remove ( int idx )

Removes an element from the array by index.

void resize ( int idx )

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.

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

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. If the adjusted start index is out of bounds, this method searches from the end of the array.

void set ( int idx, Vector2 vector2 )

Changes the Vector2 at the given index.

int size ( )

Returns the number of elements in the array.

void sort ( )

Sorts the elements of the array in ascending order.