class_packedvector2array.rst 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/PackedVector2Array.xml.
  6. .. _class_PackedVector2Array:
  7. PackedVector2Array
  8. ==================
  9. A packed array of :ref:`Vector2<class_Vector2>`\ s.
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. An array specifically designed to hold :ref:`Vector2<class_Vector2>`. Packs data tightly, so it saves memory for large array sizes.
  14. \ **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 :ref:`Array.map<class_Array_method_map>`. Typed arrays are in turn faster to iterate on and modify than untyped arrays.
  15. \ **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 :ref:`duplicate<class_PackedVector2Array_method_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.
  16. .. note::
  17. There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.
  18. .. rst-class:: classref-introduction-group
  19. Tutorials
  20. ---------
  21. - `Grid-based Navigation with AStarGrid2D Demo <https://godotengine.org/asset-library/asset/2723>`__
  22. .. rst-class:: classref-reftable-group
  23. Constructors
  24. ------------
  25. .. table::
  26. :widths: auto
  27. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`PackedVector2Array<class_PackedVector2Array_constructor_PackedVector2Array>`\ (\ ) |
  29. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`PackedVector2Array<class_PackedVector2Array_constructor_PackedVector2Array>`\ (\ from\: :ref:`PackedVector2Array<class_PackedVector2Array>`\ ) |
  31. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`PackedVector2Array<class_PackedVector2Array_constructor_PackedVector2Array>`\ (\ from\: :ref:`Array<class_Array>`\ ) |
  33. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. .. rst-class:: classref-reftable-group
  35. Methods
  36. -------
  37. .. table::
  38. :widths: auto
  39. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`bool<class_bool>` | :ref:`append<class_PackedVector2Array_method_append>`\ (\ value\: :ref:`Vector2<class_Vector2>`\ ) |
  41. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  42. | |void| | :ref:`append_array<class_PackedVector2Array_method_append_array>`\ (\ array\: :ref:`PackedVector2Array<class_PackedVector2Array>`\ ) |
  43. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`int<class_int>` | :ref:`bsearch<class_PackedVector2Array_method_bsearch>`\ (\ value\: :ref:`Vector2<class_Vector2>`, before\: :ref:`bool<class_bool>` = true\ ) |
  45. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  46. | |void| | :ref:`clear<class_PackedVector2Array_method_clear>`\ (\ ) |
  47. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`int<class_int>` | :ref:`count<class_PackedVector2Array_method_count>`\ (\ value\: :ref:`Vector2<class_Vector2>`\ ) |const| |
  49. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`duplicate<class_PackedVector2Array_method_duplicate>`\ (\ ) |
  51. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  52. | |void| | :ref:`fill<class_PackedVector2Array_method_fill>`\ (\ value\: :ref:`Vector2<class_Vector2>`\ ) |
  53. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`int<class_int>` | :ref:`find<class_PackedVector2Array_method_find>`\ (\ value\: :ref:`Vector2<class_Vector2>`, from\: :ref:`int<class_int>` = 0\ ) |const| |
  55. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`Vector2<class_Vector2>` | :ref:`get<class_PackedVector2Array_method_get>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  57. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`bool<class_bool>` | :ref:`has<class_PackedVector2Array_method_has>`\ (\ value\: :ref:`Vector2<class_Vector2>`\ ) |const| |
  59. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`int<class_int>` | :ref:`insert<class_PackedVector2Array_method_insert>`\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`Vector2<class_Vector2>`\ ) |
  61. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`bool<class_bool>` | :ref:`is_empty<class_PackedVector2Array_method_is_empty>`\ (\ ) |const| |
  63. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`bool<class_bool>` | :ref:`push_back<class_PackedVector2Array_method_push_back>`\ (\ value\: :ref:`Vector2<class_Vector2>`\ ) |
  65. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  66. | |void| | :ref:`remove_at<class_PackedVector2Array_method_remove_at>`\ (\ index\: :ref:`int<class_int>`\ ) |
  67. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`int<class_int>` | :ref:`resize<class_PackedVector2Array_method_resize>`\ (\ new_size\: :ref:`int<class_int>`\ ) |
  69. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  70. | |void| | :ref:`reverse<class_PackedVector2Array_method_reverse>`\ (\ ) |
  71. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`int<class_int>` | :ref:`rfind<class_PackedVector2Array_method_rfind>`\ (\ value\: :ref:`Vector2<class_Vector2>`, from\: :ref:`int<class_int>` = -1\ ) |const| |
  73. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  74. | |void| | :ref:`set<class_PackedVector2Array_method_set>`\ (\ index\: :ref:`int<class_int>`, value\: :ref:`Vector2<class_Vector2>`\ ) |
  75. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`int<class_int>` | :ref:`size<class_PackedVector2Array_method_size>`\ (\ ) |const| |
  77. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`slice<class_PackedVector2Array_method_slice>`\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const| |
  79. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  80. | |void| | :ref:`sort<class_PackedVector2Array_method_sort>`\ (\ ) |
  81. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`to_byte_array<class_PackedVector2Array_method_to_byte_array>`\ (\ ) |const| |
  83. +-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
  84. .. rst-class:: classref-reftable-group
  85. Operators
  86. ---------
  87. .. table::
  88. :widths: auto
  89. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`bool<class_bool>` | :ref:`operator !=<class_PackedVector2Array_operator_neq_PackedVector2Array>`\ (\ right\: :ref:`PackedVector2Array<class_PackedVector2Array>`\ ) |
  91. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`operator *<class_PackedVector2Array_operator_mul_Transform2D>`\ (\ right\: :ref:`Transform2D<class_Transform2D>`\ ) |
  93. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`operator +<class_PackedVector2Array_operator_sum_PackedVector2Array>`\ (\ right\: :ref:`PackedVector2Array<class_PackedVector2Array>`\ ) |
  95. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`bool<class_bool>` | :ref:`operator ==<class_PackedVector2Array_operator_eq_PackedVector2Array>`\ (\ right\: :ref:`PackedVector2Array<class_PackedVector2Array>`\ ) |
  97. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`Vector2<class_Vector2>` | :ref:`operator []<class_PackedVector2Array_operator_idx_int>`\ (\ index\: :ref:`int<class_int>`\ ) |
  99. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  100. .. rst-class:: classref-section-separator
  101. ----
  102. .. rst-class:: classref-descriptions-group
  103. Constructor Descriptions
  104. ------------------------
  105. .. _class_PackedVector2Array_constructor_PackedVector2Array:
  106. .. rst-class:: classref-constructor
  107. :ref:`PackedVector2Array<class_PackedVector2Array>` **PackedVector2Array**\ (\ ) :ref:`🔗<class_PackedVector2Array_constructor_PackedVector2Array>`
  108. Constructs an empty **PackedVector2Array**.
  109. .. rst-class:: classref-item-separator
  110. ----
  111. .. rst-class:: classref-constructor
  112. :ref:`PackedVector2Array<class_PackedVector2Array>` **PackedVector2Array**\ (\ from\: :ref:`PackedVector2Array<class_PackedVector2Array>`\ )
  113. Constructs a **PackedVector2Array** as a copy of the given **PackedVector2Array**.
  114. .. rst-class:: classref-item-separator
  115. ----
  116. .. rst-class:: classref-constructor
  117. :ref:`PackedVector2Array<class_PackedVector2Array>` **PackedVector2Array**\ (\ from\: :ref:`Array<class_Array>`\ )
  118. Constructs a new **PackedVector2Array**. Optionally, you can pass in a generic :ref:`Array<class_Array>` that will be converted.
  119. \ **Note:** When initializing a **PackedVector2Array** with elements, it must be initialized with an :ref:`Array<class_Array>` of :ref:`Vector2<class_Vector2>` values:
  120. ::
  121. var array = PackedVector2Array([Vector2(12, 34), Vector2(56, 78)])
  122. .. rst-class:: classref-section-separator
  123. ----
  124. .. rst-class:: classref-descriptions-group
  125. Method Descriptions
  126. -------------------
  127. .. _class_PackedVector2Array_method_append:
  128. .. rst-class:: classref-method
  129. :ref:`bool<class_bool>` **append**\ (\ value\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_PackedVector2Array_method_append>`
  130. Appends an element at the end of the array (alias of :ref:`push_back<class_PackedVector2Array_method_push_back>`).
  131. .. rst-class:: classref-item-separator
  132. ----
  133. .. _class_PackedVector2Array_method_append_array:
  134. .. rst-class:: classref-method
  135. |void| **append_array**\ (\ array\: :ref:`PackedVector2Array<class_PackedVector2Array>`\ ) :ref:`🔗<class_PackedVector2Array_method_append_array>`
  136. Appends a **PackedVector2Array** at the end of this array.
  137. .. rst-class:: classref-item-separator
  138. ----
  139. .. _class_PackedVector2Array_method_bsearch:
  140. .. rst-class:: classref-method
  141. :ref:`int<class_int>` **bsearch**\ (\ value\: :ref:`Vector2<class_Vector2>`, before\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_PackedVector2Array_method_bsearch>`
  142. 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.
  143. \ **Note:** Calling :ref:`bsearch<class_PackedVector2Array_method_bsearch>` on an unsorted array results in unexpected behavior.
  144. \ **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.
  145. .. rst-class:: classref-item-separator
  146. ----
  147. .. _class_PackedVector2Array_method_clear:
  148. .. rst-class:: classref-method
  149. |void| **clear**\ (\ ) :ref:`🔗<class_PackedVector2Array_method_clear>`
  150. Clears the array. This is equivalent to using :ref:`resize<class_PackedVector2Array_method_resize>` with a size of ``0``.
  151. .. rst-class:: classref-item-separator
  152. ----
  153. .. _class_PackedVector2Array_method_count:
  154. .. rst-class:: classref-method
  155. :ref:`int<class_int>` **count**\ (\ value\: :ref:`Vector2<class_Vector2>`\ ) |const| :ref:`🔗<class_PackedVector2Array_method_count>`
  156. Returns the number of times an element is in the array.
  157. \ **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.
  158. .. rst-class:: classref-item-separator
  159. ----
  160. .. _class_PackedVector2Array_method_duplicate:
  161. .. rst-class:: classref-method
  162. :ref:`PackedVector2Array<class_PackedVector2Array>` **duplicate**\ (\ ) :ref:`🔗<class_PackedVector2Array_method_duplicate>`
  163. Creates a copy of the array, and returns it.
  164. .. rst-class:: classref-item-separator
  165. ----
  166. .. _class_PackedVector2Array_method_fill:
  167. .. rst-class:: classref-method
  168. |void| **fill**\ (\ value\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_PackedVector2Array_method_fill>`
  169. 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.
  170. .. rst-class:: classref-item-separator
  171. ----
  172. .. _class_PackedVector2Array_method_find:
  173. .. rst-class:: classref-method
  174. :ref:`int<class_int>` **find**\ (\ value\: :ref:`Vector2<class_Vector2>`, from\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_PackedVector2Array_method_find>`
  175. Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed.
  176. \ **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.
  177. .. rst-class:: classref-item-separator
  178. ----
  179. .. _class_PackedVector2Array_method_get:
  180. .. rst-class:: classref-method
  181. :ref:`Vector2<class_Vector2>` **get**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PackedVector2Array_method_get>`
  182. Returns the :ref:`Vector2<class_Vector2>` at the given ``index`` in the array. This is the same as using the ``[]`` operator (``array[index]``).
  183. .. rst-class:: classref-item-separator
  184. ----
  185. .. _class_PackedVector2Array_method_has:
  186. .. rst-class:: classref-method
  187. :ref:`bool<class_bool>` **has**\ (\ value\: :ref:`Vector2<class_Vector2>`\ ) |const| :ref:`🔗<class_PackedVector2Array_method_has>`
  188. Returns ``true`` if the array contains ``value``.
  189. \ **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.
  190. .. rst-class:: classref-item-separator
  191. ----
  192. .. _class_PackedVector2Array_method_insert:
  193. .. rst-class:: classref-method
  194. :ref:`int<class_int>` **insert**\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_PackedVector2Array_method_insert>`
  195. 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()``).
  196. .. rst-class:: classref-item-separator
  197. ----
  198. .. _class_PackedVector2Array_method_is_empty:
  199. .. rst-class:: classref-method
  200. :ref:`bool<class_bool>` **is_empty**\ (\ ) |const| :ref:`🔗<class_PackedVector2Array_method_is_empty>`
  201. Returns ``true`` if the array is empty.
  202. .. rst-class:: classref-item-separator
  203. ----
  204. .. _class_PackedVector2Array_method_push_back:
  205. .. rst-class:: classref-method
  206. :ref:`bool<class_bool>` **push_back**\ (\ value\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_PackedVector2Array_method_push_back>`
  207. Inserts a :ref:`Vector2<class_Vector2>` at the end.
  208. .. rst-class:: classref-item-separator
  209. ----
  210. .. _class_PackedVector2Array_method_remove_at:
  211. .. rst-class:: classref-method
  212. |void| **remove_at**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedVector2Array_method_remove_at>`
  213. Removes an element from the array by index.
  214. .. rst-class:: classref-item-separator
  215. ----
  216. .. _class_PackedVector2Array_method_resize:
  217. .. rst-class:: classref-method
  218. :ref:`int<class_int>` **resize**\ (\ new_size\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedVector2Array_method_resize>`
  219. 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 :ref:`resize<class_PackedVector2Array_method_resize>` once and assigning the new values is faster than adding new elements one by one.
  220. .. rst-class:: classref-item-separator
  221. ----
  222. .. _class_PackedVector2Array_method_reverse:
  223. .. rst-class:: classref-method
  224. |void| **reverse**\ (\ ) :ref:`🔗<class_PackedVector2Array_method_reverse>`
  225. Reverses the order of the elements in the array.
  226. .. rst-class:: classref-item-separator
  227. ----
  228. .. _class_PackedVector2Array_method_rfind:
  229. .. rst-class:: classref-method
  230. :ref:`int<class_int>` **rfind**\ (\ value\: :ref:`Vector2<class_Vector2>`, from\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_PackedVector2Array_method_rfind>`
  231. 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.
  232. \ **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.
  233. .. rst-class:: classref-item-separator
  234. ----
  235. .. _class_PackedVector2Array_method_set:
  236. .. rst-class:: classref-method
  237. |void| **set**\ (\ index\: :ref:`int<class_int>`, value\: :ref:`Vector2<class_Vector2>`\ ) :ref:`🔗<class_PackedVector2Array_method_set>`
  238. Changes the :ref:`Vector2<class_Vector2>` at the given index.
  239. .. rst-class:: classref-item-separator
  240. ----
  241. .. _class_PackedVector2Array_method_size:
  242. .. rst-class:: classref-method
  243. :ref:`int<class_int>` **size**\ (\ ) |const| :ref:`🔗<class_PackedVector2Array_method_size>`
  244. Returns the number of elements in the array.
  245. .. rst-class:: classref-item-separator
  246. ----
  247. .. _class_PackedVector2Array_method_slice:
  248. .. rst-class:: classref-method
  249. :ref:`PackedVector2Array<class_PackedVector2Array>` **slice**\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const| :ref:`🔗<class_PackedVector2Array_method_slice>`
  250. Returns the slice of the **PackedVector2Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedVector2Array**.
  251. 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())``).
  252. 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)``).
  253. .. rst-class:: classref-item-separator
  254. ----
  255. .. _class_PackedVector2Array_method_sort:
  256. .. rst-class:: classref-method
  257. |void| **sort**\ (\ ) :ref:`🔗<class_PackedVector2Array_method_sort>`
  258. Sorts the elements of the array in ascending order.
  259. \ **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.
  260. .. rst-class:: classref-item-separator
  261. ----
  262. .. _class_PackedVector2Array_method_to_byte_array:
  263. .. rst-class:: classref-method
  264. :ref:`PackedByteArray<class_PackedByteArray>` **to_byte_array**\ (\ ) |const| :ref:`🔗<class_PackedVector2Array_method_to_byte_array>`
  265. Returns a :ref:`PackedByteArray<class_PackedByteArray>` with each vector encoded as bytes.
  266. .. rst-class:: classref-section-separator
  267. ----
  268. .. rst-class:: classref-descriptions-group
  269. Operator Descriptions
  270. ---------------------
  271. .. _class_PackedVector2Array_operator_neq_PackedVector2Array:
  272. .. rst-class:: classref-operator
  273. :ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`PackedVector2Array<class_PackedVector2Array>`\ ) :ref:`🔗<class_PackedVector2Array_operator_neq_PackedVector2Array>`
  274. Returns ``true`` if contents of the arrays differ.
  275. .. rst-class:: classref-item-separator
  276. ----
  277. .. _class_PackedVector2Array_operator_mul_Transform2D:
  278. .. rst-class:: classref-operator
  279. :ref:`PackedVector2Array<class_PackedVector2Array>` **operator ***\ (\ right\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`🔗<class_PackedVector2Array_operator_mul_Transform2D>`
  280. Returns a new **PackedVector2Array** with all vectors in this array inversely transformed (multiplied) by the given :ref:`Transform2D<class_Transform2D>` transformation matrix, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not).
  281. \ ``array * transform`` is equivalent to ``transform.inverse() * array``. See :ref:`Transform2D.inverse<class_Transform2D_method_inverse>`.
  282. For transforming by inverse of an affine transformation (e.g. with scaling) ``transform.affine_inverse() * array`` can be used instead. See :ref:`Transform2D.affine_inverse<class_Transform2D_method_affine_inverse>`.
  283. .. rst-class:: classref-item-separator
  284. ----
  285. .. _class_PackedVector2Array_operator_sum_PackedVector2Array:
  286. .. rst-class:: classref-operator
  287. :ref:`PackedVector2Array<class_PackedVector2Array>` **operator +**\ (\ right\: :ref:`PackedVector2Array<class_PackedVector2Array>`\ ) :ref:`🔗<class_PackedVector2Array_operator_sum_PackedVector2Array>`
  288. 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.
  289. .. rst-class:: classref-item-separator
  290. ----
  291. .. _class_PackedVector2Array_operator_eq_PackedVector2Array:
  292. .. rst-class:: classref-operator
  293. :ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`PackedVector2Array<class_PackedVector2Array>`\ ) :ref:`🔗<class_PackedVector2Array_operator_eq_PackedVector2Array>`
  294. 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.
  295. .. rst-class:: classref-item-separator
  296. ----
  297. .. _class_PackedVector2Array_operator_idx_int:
  298. .. rst-class:: classref-operator
  299. :ref:`Vector2<class_Vector2>` **operator []**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedVector2Array_operator_idx_int>`
  300. 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.
  301. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  302. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  303. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  304. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  305. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  306. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  307. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  308. .. |void| replace:: :abbr:`void (No return value.)`