class_packedfloat32array.rst 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528
  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/PackedFloat32Array.xml.
  6. .. _class_PackedFloat32Array:
  7. PackedFloat32Array
  8. ==================
  9. A packed array of 32-bit floating-point values.
  10. .. rst-class:: classref-introduction-group
  11. Description
  12. -----------
  13. An array specifically designed to hold 32-bit floating-point values (float). Packs data tightly, so it saves memory for large array sizes.
  14. If you need to pack 64-bit floats tightly, see :ref:`PackedFloat64Array<class_PackedFloat64Array>`.
  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_PackedFloat32Array_method_duplicate>`. This is *not* the case for built-in properties and methods. In these cases the returned packed array is a copy, and changing it will *not* affect the original value. To update a built-in property of this type, 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-reftable-group
  19. Constructors
  20. ------------
  21. .. table::
  22. :widths: auto
  23. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`PackedFloat32Array<class_PackedFloat32Array_constructor_PackedFloat32Array>`\ (\ ) |
  25. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`PackedFloat32Array<class_PackedFloat32Array_constructor_PackedFloat32Array>`\ (\ from\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  27. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`PackedFloat32Array<class_PackedFloat32Array_constructor_PackedFloat32Array>`\ (\ from\: :ref:`Array<class_Array>`\ ) |
  29. +-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. .. rst-class:: classref-reftable-group
  31. Methods
  32. -------
  33. .. table::
  34. :widths: auto
  35. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  36. | :ref:`bool<class_bool>` | :ref:`append<class_PackedFloat32Array_method_append>`\ (\ value\: :ref:`float<class_float>`\ ) |
  37. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  38. | |void| | :ref:`append_array<class_PackedFloat32Array_method_append_array>`\ (\ array\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  39. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  40. | :ref:`int<class_int>` | :ref:`bsearch<class_PackedFloat32Array_method_bsearch>`\ (\ value\: :ref:`float<class_float>`, before\: :ref:`bool<class_bool>` = true\ ) |
  41. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  42. | |void| | :ref:`clear<class_PackedFloat32Array_method_clear>`\ (\ ) |
  43. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`int<class_int>` | :ref:`count<class_PackedFloat32Array_method_count>`\ (\ value\: :ref:`float<class_float>`\ ) |const| |
  45. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`duplicate<class_PackedFloat32Array_method_duplicate>`\ (\ ) |
  47. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`bool<class_bool>` | :ref:`erase<class_PackedFloat32Array_method_erase>`\ (\ value\: :ref:`float<class_float>`\ ) |
  49. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  50. | |void| | :ref:`fill<class_PackedFloat32Array_method_fill>`\ (\ value\: :ref:`float<class_float>`\ ) |
  51. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`int<class_int>` | :ref:`find<class_PackedFloat32Array_method_find>`\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = 0\ ) |const| |
  53. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`float<class_float>` | :ref:`get<class_PackedFloat32Array_method_get>`\ (\ index\: :ref:`int<class_int>`\ ) |const| |
  55. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`bool<class_bool>` | :ref:`has<class_PackedFloat32Array_method_has>`\ (\ value\: :ref:`float<class_float>`\ ) |const| |
  57. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`int<class_int>` | :ref:`insert<class_PackedFloat32Array_method_insert>`\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ ) |
  59. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`bool<class_bool>` | :ref:`is_empty<class_PackedFloat32Array_method_is_empty>`\ (\ ) |const| |
  61. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`bool<class_bool>` | :ref:`push_back<class_PackedFloat32Array_method_push_back>`\ (\ value\: :ref:`float<class_float>`\ ) |
  63. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  64. | |void| | :ref:`remove_at<class_PackedFloat32Array_method_remove_at>`\ (\ index\: :ref:`int<class_int>`\ ) |
  65. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`int<class_int>` | :ref:`resize<class_PackedFloat32Array_method_resize>`\ (\ new_size\: :ref:`int<class_int>`\ ) |
  67. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  68. | |void| | :ref:`reverse<class_PackedFloat32Array_method_reverse>`\ (\ ) |
  69. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`int<class_int>` | :ref:`rfind<class_PackedFloat32Array_method_rfind>`\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = -1\ ) |const| |
  71. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  72. | |void| | :ref:`set<class_PackedFloat32Array_method_set>`\ (\ index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ ) |
  73. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`int<class_int>` | :ref:`size<class_PackedFloat32Array_method_size>`\ (\ ) |const| |
  75. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`slice<class_PackedFloat32Array_method_slice>`\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const| |
  77. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  78. | |void| | :ref:`sort<class_PackedFloat32Array_method_sort>`\ (\ ) |
  79. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`to_byte_array<class_PackedFloat32Array_method_to_byte_array>`\ (\ ) |const| |
  81. +-----------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
  82. .. rst-class:: classref-reftable-group
  83. Operators
  84. ---------
  85. .. table::
  86. :widths: auto
  87. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`bool<class_bool>` | :ref:`operator !=<class_PackedFloat32Array_operator_neq_PackedFloat32Array>`\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  89. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`PackedFloat32Array<class_PackedFloat32Array>` | :ref:`operator +<class_PackedFloat32Array_operator_sum_PackedFloat32Array>`\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  91. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`bool<class_bool>` | :ref:`operator ==<class_PackedFloat32Array_operator_eq_PackedFloat32Array>`\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  93. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`float<class_float>` | :ref:`operator []<class_PackedFloat32Array_operator_idx_int>`\ (\ index\: :ref:`int<class_int>`\ ) |
  95. +-----------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
  96. .. rst-class:: classref-section-separator
  97. ----
  98. .. rst-class:: classref-descriptions-group
  99. Constructor Descriptions
  100. ------------------------
  101. .. _class_PackedFloat32Array_constructor_PackedFloat32Array:
  102. .. rst-class:: classref-constructor
  103. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **PackedFloat32Array**\ (\ ) :ref:`🔗<class_PackedFloat32Array_constructor_PackedFloat32Array>`
  104. Constructs an empty **PackedFloat32Array**.
  105. .. rst-class:: classref-item-separator
  106. ----
  107. .. rst-class:: classref-constructor
  108. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **PackedFloat32Array**\ (\ from\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ )
  109. Constructs a **PackedFloat32Array** as a copy of the given **PackedFloat32Array**.
  110. .. rst-class:: classref-item-separator
  111. ----
  112. .. rst-class:: classref-constructor
  113. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **PackedFloat32Array**\ (\ from\: :ref:`Array<class_Array>`\ )
  114. Constructs a new **PackedFloat32Array**. Optionally, you can pass in a generic :ref:`Array<class_Array>` that will be converted.
  115. .. rst-class:: classref-section-separator
  116. ----
  117. .. rst-class:: classref-descriptions-group
  118. Method Descriptions
  119. -------------------
  120. .. _class_PackedFloat32Array_method_append:
  121. .. rst-class:: classref-method
  122. :ref:`bool<class_bool>` **append**\ (\ value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat32Array_method_append>`
  123. Appends an element at the end of the array (alias of :ref:`push_back()<class_PackedFloat32Array_method_push_back>`).
  124. .. rst-class:: classref-item-separator
  125. ----
  126. .. _class_PackedFloat32Array_method_append_array:
  127. .. rst-class:: classref-method
  128. |void| **append_array**\ (\ array\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`🔗<class_PackedFloat32Array_method_append_array>`
  129. Appends a **PackedFloat32Array** at the end of this array.
  130. .. rst-class:: classref-item-separator
  131. ----
  132. .. _class_PackedFloat32Array_method_bsearch:
  133. .. rst-class:: classref-method
  134. :ref:`int<class_int>` **bsearch**\ (\ value\: :ref:`float<class_float>`, before\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_PackedFloat32Array_method_bsearch>`
  135. 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.
  136. \ **Note:** Calling :ref:`bsearch()<class_PackedFloat32Array_method_bsearch>` on an unsorted array results in unexpected behavior.
  137. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  138. .. rst-class:: classref-item-separator
  139. ----
  140. .. _class_PackedFloat32Array_method_clear:
  141. .. rst-class:: classref-method
  142. |void| **clear**\ (\ ) :ref:`🔗<class_PackedFloat32Array_method_clear>`
  143. Clears the array. This is equivalent to using :ref:`resize()<class_PackedFloat32Array_method_resize>` with a size of ``0``.
  144. .. rst-class:: classref-item-separator
  145. ----
  146. .. _class_PackedFloat32Array_method_count:
  147. .. rst-class:: classref-method
  148. :ref:`int<class_int>` **count**\ (\ value\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_count>`
  149. Returns the number of times an element is in the array.
  150. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  151. .. rst-class:: classref-item-separator
  152. ----
  153. .. _class_PackedFloat32Array_method_duplicate:
  154. .. rst-class:: classref-method
  155. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **duplicate**\ (\ ) :ref:`🔗<class_PackedFloat32Array_method_duplicate>`
  156. Creates a copy of the array, and returns it.
  157. .. rst-class:: classref-item-separator
  158. ----
  159. .. _class_PackedFloat32Array_method_erase:
  160. .. rst-class:: classref-method
  161. :ref:`bool<class_bool>` **erase**\ (\ value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat32Array_method_erase>`
  162. Removes the first occurrence of a value from the array and returns ``true``. If the value does not exist in the array, nothing happens and ``false`` is returned. To remove an element by index, use :ref:`remove_at()<class_PackedFloat32Array_method_remove_at>` instead.
  163. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  164. .. rst-class:: classref-item-separator
  165. ----
  166. .. _class_PackedFloat32Array_method_fill:
  167. .. rst-class:: classref-method
  168. |void| **fill**\ (\ value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat32Array_method_fill>`
  169. Assigns the given value to all elements in the array. This can typically be used together with :ref:`resize()<class_PackedFloat32Array_method_resize>` to create an array with a given size and initialized elements.
  170. .. rst-class:: classref-item-separator
  171. ----
  172. .. _class_PackedFloat32Array_method_find:
  173. .. rst-class:: classref-method
  174. :ref:`int<class_int>` **find**\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_PackedFloat32Array_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:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  177. .. rst-class:: classref-item-separator
  178. ----
  179. .. _class_PackedFloat32Array_method_get:
  180. .. rst-class:: classref-method
  181. :ref:`float<class_float>` **get**\ (\ index\: :ref:`int<class_int>`\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_get>`
  182. Returns the 32-bit float at the given ``index`` in the array. If ``index`` out-of-bounds or negative, this method fails and returns ``0.0``.
  183. This method is similar (but not identical) to the ``[]`` operator. Most notably, when this method fails, it doesn't pause project execution if run from the editor.
  184. .. rst-class:: classref-item-separator
  185. ----
  186. .. _class_PackedFloat32Array_method_has:
  187. .. rst-class:: classref-method
  188. :ref:`bool<class_bool>` **has**\ (\ value\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_has>`
  189. Returns ``true`` if the array contains ``value``.
  190. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  191. .. rst-class:: classref-item-separator
  192. ----
  193. .. _class_PackedFloat32Array_method_insert:
  194. .. rst-class:: classref-method
  195. :ref:`int<class_int>` **insert**\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat32Array_method_insert>`
  196. 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()``).
  197. .. rst-class:: classref-item-separator
  198. ----
  199. .. _class_PackedFloat32Array_method_is_empty:
  200. .. rst-class:: classref-method
  201. :ref:`bool<class_bool>` **is_empty**\ (\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_is_empty>`
  202. Returns ``true`` if the array is empty.
  203. .. rst-class:: classref-item-separator
  204. ----
  205. .. _class_PackedFloat32Array_method_push_back:
  206. .. rst-class:: classref-method
  207. :ref:`bool<class_bool>` **push_back**\ (\ value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat32Array_method_push_back>`
  208. Appends an element at the end of the array.
  209. .. rst-class:: classref-item-separator
  210. ----
  211. .. _class_PackedFloat32Array_method_remove_at:
  212. .. rst-class:: classref-method
  213. |void| **remove_at**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedFloat32Array_method_remove_at>`
  214. Removes an element from the array by index.
  215. .. rst-class:: classref-item-separator
  216. ----
  217. .. _class_PackedFloat32Array_method_resize:
  218. .. rst-class:: classref-method
  219. :ref:`int<class_int>` **resize**\ (\ new_size\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedFloat32Array_method_resize>`
  220. 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_PackedFloat32Array_method_resize>` once and assigning the new values is faster than adding new elements one by one.
  221. Returns :ref:`@GlobalScope.OK<class_@GlobalScope_constant_OK>` on success, or one of the following :ref:`Error<enum_@GlobalScope_Error>` constants if this method fails: :ref:`@GlobalScope.ERR_INVALID_PARAMETER<class_@GlobalScope_constant_ERR_INVALID_PARAMETER>` if the size is negative, or :ref:`@GlobalScope.ERR_OUT_OF_MEMORY<class_@GlobalScope_constant_ERR_OUT_OF_MEMORY>` if allocations fail. Use :ref:`size()<class_PackedFloat32Array_method_size>` to find the actual size of the array after resize.
  222. .. rst-class:: classref-item-separator
  223. ----
  224. .. _class_PackedFloat32Array_method_reverse:
  225. .. rst-class:: classref-method
  226. |void| **reverse**\ (\ ) :ref:`🔗<class_PackedFloat32Array_method_reverse>`
  227. Reverses the order of the elements in the array.
  228. .. rst-class:: classref-item-separator
  229. ----
  230. .. _class_PackedFloat32Array_method_rfind:
  231. .. rst-class:: classref-method
  232. :ref:`int<class_int>` **rfind**\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_rfind>`
  233. 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.
  234. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  235. .. rst-class:: classref-item-separator
  236. ----
  237. .. _class_PackedFloat32Array_method_set:
  238. .. rst-class:: classref-method
  239. |void| **set**\ (\ index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat32Array_method_set>`
  240. Changes the float at the given index.
  241. .. rst-class:: classref-item-separator
  242. ----
  243. .. _class_PackedFloat32Array_method_size:
  244. .. rst-class:: classref-method
  245. :ref:`int<class_int>` **size**\ (\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_size>`
  246. Returns the number of elements in the array.
  247. .. rst-class:: classref-item-separator
  248. ----
  249. .. _class_PackedFloat32Array_method_slice:
  250. .. rst-class:: classref-method
  251. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **slice**\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_slice>`
  252. Returns the slice of the **PackedFloat32Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedFloat32Array**.
  253. 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())``).
  254. 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)``).
  255. .. rst-class:: classref-item-separator
  256. ----
  257. .. _class_PackedFloat32Array_method_sort:
  258. .. rst-class:: classref-method
  259. |void| **sort**\ (\ ) :ref:`🔗<class_PackedFloat32Array_method_sort>`
  260. Sorts the elements of the array in ascending order.
  261. \ **Note:** :ref:`@GDScript.NAN<class_@GDScript_constant_NAN>` doesn't behave the same as other numbers. Therefore, the results from this method may not be accurate if NaNs are included.
  262. .. rst-class:: classref-item-separator
  263. ----
  264. .. _class_PackedFloat32Array_method_to_byte_array:
  265. .. rst-class:: classref-method
  266. :ref:`PackedByteArray<class_PackedByteArray>` **to_byte_array**\ (\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_to_byte_array>`
  267. Returns a copy of the data converted to a :ref:`PackedByteArray<class_PackedByteArray>`, where each element has been encoded as 4 bytes.
  268. The size of the new array will be ``float32_array.size() * 4``.
  269. .. rst-class:: classref-section-separator
  270. ----
  271. .. rst-class:: classref-descriptions-group
  272. Operator Descriptions
  273. ---------------------
  274. .. _class_PackedFloat32Array_operator_neq_PackedFloat32Array:
  275. .. rst-class:: classref-operator
  276. :ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`🔗<class_PackedFloat32Array_operator_neq_PackedFloat32Array>`
  277. Returns ``true`` if contents of the arrays differ.
  278. .. rst-class:: classref-item-separator
  279. ----
  280. .. _class_PackedFloat32Array_operator_sum_PackedFloat32Array:
  281. .. rst-class:: classref-operator
  282. :ref:`PackedFloat32Array<class_PackedFloat32Array>` **operator +**\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`🔗<class_PackedFloat32Array_operator_sum_PackedFloat32Array>`
  283. Returns a new **PackedFloat32Array** with contents of ``right`` added at the end of this array. For better performance, consider using :ref:`append_array()<class_PackedFloat32Array_method_append_array>` instead.
  284. .. rst-class:: classref-item-separator
  285. ----
  286. .. _class_PackedFloat32Array_operator_eq_PackedFloat32Array:
  287. .. rst-class:: classref-operator
  288. :ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`🔗<class_PackedFloat32Array_operator_eq_PackedFloat32Array>`
  289. Returns ``true`` if contents of both arrays are the same, i.e. they have all equal floats at the corresponding indices.
  290. .. rst-class:: classref-item-separator
  291. ----
  292. .. _class_PackedFloat32Array_operator_idx_int:
  293. .. rst-class:: classref-operator
  294. :ref:`float<class_float>` **operator []**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedFloat32Array_operator_idx_int>`
  295. Returns the :ref:`float<class_float>` 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.
  296. Note that :ref:`float<class_float>` type is 64-bit, unlike the values stored in the array.
  297. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  298. .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
  299. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  300. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  301. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  302. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  303. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  304. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  305. .. |void| replace:: :abbr:`void (No return value.)`