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.
Note
There are notable differences when using this API with C#. See C# API differences to GDScript for more information.
Tutorials¶
Constructors¶
PackedVector2Array ( PackedVector2Array from ) |
|
PackedVector2Array ( Array from ) |
Methods¶
void |
append_array ( PackedVector2Array array ) |
void |
clear ( ) |
duplicate ( ) |
|
void |
|
is_empty ( ) const |
|
void |
|
void |
reverse ( ) |
void |
|
size ( ) const |
|
void |
sort ( ) |
to_byte_array ( ) const |
Operators¶
operator != ( PackedVector2Array right ) |
|
operator * ( Transform2D right ) |
|
operator + ( PackedVector2Array right ) |
|
operator == ( PackedVector2Array right ) |
|
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.
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)])
Method Descriptions¶
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.
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 ( )
Clears the array. This is equivalent to using resize with a size of 0.
int count ( Vector2 value ) 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.
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.
int find ( Vector2 value, int from=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.
bool has ( Vector2 value ) 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 ( 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_at ( int index )
Removes an element from the array by index.
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.
int rfind ( Vector2 value, int from=-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 ( int index, Vector2 value )
Changes the Vector2 at the given index.
int size ( ) const
Returns the number of elements in the array.
PackedVector2Array slice ( int begin, int end=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.
Operator Descriptions¶
bool operator != ( PackedVector2Array right )
Returns true if contents of the arrays differ.
PackedVector2Array operator * ( Transform2D right )
Transforms (multiplies) all vectors in the array by the Transform2D matrix.
PackedVector2Array operator + ( PackedVector2Array right )
Returns a new PackedVector2Array with contents of right added at the end of this array. For better performance, consider using append_array instead.
bool operator == ( PackedVector2Array right )
Returns true if contents of both arrays are the same, i.e. they have all equal Vector2s at the corresponding indices.
Vector2 operator [] ( int index )
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.