| github_url: | hide |
|---|
A packed array of :ref:`Vector2<class_Vector2>`s.
.. rst-class:: classref-introduction-group
An array specifically designed to hold :ref:`Vector2<class_Vector2>`. Packs data tightly, so it saves memory for large array sizes.
Note
There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.
.. rst-class:: classref-introduction-group
.. rst-class:: classref-reftable-group
.. rst-class:: classref-reftable-group
.. rst-class:: classref-reftable-group
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-constructor
:ref:`PackedVector2Array<class_PackedVector2Array>` PackedVector2Array ( )
Constructs an empty PackedVector2Array.
.. rst-class:: classref-item-separator
.. rst-class:: classref-constructor
:ref:`PackedVector2Array<class_PackedVector2Array>` PackedVector2Array ( :ref:`PackedVector2Array<class_PackedVector2Array>` from )
Constructs a PackedVector2Array as a copy of the given PackedVector2Array.
.. rst-class:: classref-item-separator
.. rst-class:: classref-constructor
:ref:`PackedVector2Array<class_PackedVector2Array>` PackedVector2Array ( :ref:`Array<class_Array>` from )
Constructs a new PackedVector2Array. Optionally, you can pass in a generic :ref:`Array<class_Array>` that will be converted.
Note: When initializing a PackedVector2Array with elements, it must be initialized with an :ref:`Array<class_Array>` of :ref:`Vector2<class_Vector2>` values:
var array = PackedVector2Array([Vector2(12, 34), Vector2(56, 78)])
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-method
:ref:`bool<class_bool>` append ( :ref:`Vector2<class_Vector2>` value )
Appends an element at the end of the array (alias of :ref:`push_back<class_PackedVector2Array_method_push_back>`).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void append_array ( :ref:`PackedVector2Array<class_PackedVector2Array>` array )
Appends a PackedVector2Array at the end of this array.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` bsearch ( :ref:`Vector2<class_Vector2>` value, :ref:`bool<class_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 :ref:`bsearch<class_PackedVector2Array_method_bsearch>` on an unsorted array results in unexpected behavior.
Note: Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void clear ( )
Clears the array. This is equivalent to using :ref:`resize<class_PackedVector2Array_method_resize>` with a size of 0.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` count ( :ref:`Vector2<class_Vector2>` value ) |const|
Returns the number of times an element is in the array.
Note: Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`PackedVector2Array<class_PackedVector2Array>` duplicate ( )
Creates a copy of the array, and returns it.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void fill ( :ref:`Vector2<class_Vector2>` value )
Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize<class_PackedVector2Array_method_resize>` to create an array with a given size and initialized elements.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` find ( :ref:`Vector2<class_Vector2>` value, :ref:`int<class_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 :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`bool<class_bool>` has ( :ref:`Vector2<class_Vector2>` value ) |const|
Returns true if the array contains value.
Note: Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` insert ( :ref:`int<class_int>` at_index, :ref:`Vector2<class_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()).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`bool<class_bool>` is_empty ( ) |const|
Returns true if the array is empty.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`bool<class_bool>` push_back ( :ref:`Vector2<class_Vector2>` value )
Inserts a :ref:`Vector2<class_Vector2>` at the end.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void remove_at ( :ref:`int<class_int>` index )
Removes an element from the array by index.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` resize ( :ref:`int<class_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.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void reverse ( )
Reverses the order of the elements in the array.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` rfind ( :ref:`Vector2<class_Vector2>` value, :ref:`int<class_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 :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void set ( :ref:`int<class_int>` index, :ref:`Vector2<class_Vector2>` value )
Changes the :ref:`Vector2<class_Vector2>` at the given index.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`int<class_int>` size ( ) |const|
Returns the number of elements in the array.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`PackedVector2Array<class_PackedVector2Array>` slice ( :ref:`int<class_int>` begin, :ref:`int<class_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)).
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
void sort ( )
Sorts the elements of the array in ascending order.
Note: Vectors with :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` elements don't behave the same as other vectors. Therefore, the results from this method may not be accurate if NaNs are included.
.. rst-class:: classref-item-separator
.. rst-class:: classref-method
:ref:`PackedByteArray<class_PackedByteArray>` to_byte_array ( ) |const|
Returns a :ref:`PackedByteArray<class_PackedByteArray>` with each vector encoded as bytes.
.. rst-class:: classref-section-separator
.. rst-class:: classref-descriptions-group
.. rst-class:: classref-operator
:ref:`bool<class_bool>` operator != ( :ref:`PackedVector2Array<class_PackedVector2Array>` right )
Returns true if contents of the arrays differ.
.. rst-class:: classref-item-separator
.. rst-class:: classref-operator
:ref:`PackedVector2Array<class_PackedVector2Array>` operator * ( :ref:`Transform2D<class_Transform2D>` right )
Transforms (multiplies) all vectors in the array by the :ref:`Transform2D<class_Transform2D>` matrix.
.. rst-class:: classref-item-separator
.. rst-class:: classref-operator
:ref:`PackedVector2Array<class_PackedVector2Array>` operator + ( :ref:`PackedVector2Array<class_PackedVector2Array>` right )
Returns a new PackedVector2Array with contents of right added at the end of this array. For better performance, consider using :ref:`append_array<class_PackedVector2Array_method_append_array>` instead.
.. rst-class:: classref-item-separator
.. rst-class:: classref-operator
:ref:`bool<class_bool>` operator == ( :ref:`PackedVector2Array<class_PackedVector2Array>` right )
Returns true if contents of both arrays are the same, i.e. they have all equal :ref:`Vector2<class_Vector2>`s at the corresponding indices.
.. rst-class:: classref-item-separator
.. rst-class:: classref-operator
:ref:`Vector2<class_Vector2>` operator [] ( :ref:`int<class_int>` index )
Returns the :ref:`Vector2<class_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.