classref: Sync with latest 4.0-dev

This commit is contained in:
Rémi Verschelde
2021-11-15 12:28:38 +01:00
parent d6d97aaf5e
commit 30193215cf
829 changed files with 12891 additions and 7761 deletions
+105 -93
View File
@@ -1,6 +1,6 @@
:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the PackedFloat64Array.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
@@ -18,85 +18,96 @@ An :ref:`Array<class_Array>` specifically designed to hold 64-bit floating-point
If you only need to pack 32-bit floats tightly, see :ref:`PackedFloat32Array<class_PackedFloat32Array>` for a more memory-friendly alternative.
Constructors
------------
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`PackedFloat64Array<class_PackedFloat64Array_constructor_PackedFloat64Array>` **(** **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`PackedFloat64Array<class_PackedFloat64Array_constructor_PackedFloat64Array>` **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` from **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`PackedFloat64Array<class_PackedFloat64Array_constructor_PackedFloat64Array>` **(** :ref:`Array<class_Array>` from **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
Methods
-------
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`PackedFloat64Array<class_PackedFloat64Array_method_PackedFloat64Array>` **(** **)** |constructor| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`PackedFloat64Array<class_PackedFloat64Array_method_PackedFloat64Array>` **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` from **)** |constructor| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`PackedFloat64Array<class_PackedFloat64Array_method_PackedFloat64Array>` **(** :ref:`Array<class_Array>` from **)** |constructor| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`append<class_PackedFloat64Array_method_append>` **(** :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`append_array<class_PackedFloat64Array_method_append_array>` **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` array **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`bsearch<class_PackedFloat64Array_method_bsearch>` **(** :ref:`float<class_float>` value, :ref:`bool<class_bool>` before=true **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`duplicate<class_PackedFloat64Array_method_duplicate>` **(** **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fill<class_PackedFloat64Array_method_fill>` **(** :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_PackedFloat64Array_method_has>` **(** :ref:`float<class_float>` value **)** |const| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`insert<class_PackedFloat64Array_method_insert>` **(** :ref:`int<class_int>` at_index, :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_empty<class_PackedFloat64Array_method_is_empty>` **(** **)** |const| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | **operator !=** **(** **)** |operator| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | **operator !=** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)** |operator| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | **operator +** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)** |operator| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | **operator ==** **(** **)** |operator| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | **operator ==** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)** |operator| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | **operator []** **(** :ref:`int<class_int>` index **)** |operator| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`push_back<class_PackedFloat64Array_method_push_back>` **(** :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove<class_PackedFloat64Array_method_remove>` **(** :ref:`int<class_int>` index **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`resize<class_PackedFloat64Array_method_resize>` **(** :ref:`int<class_int>` new_size **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reverse<class_PackedFloat64Array_method_reverse>` **(** **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set<class_PackedFloat64Array_method_set>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_PackedFloat64Array_method_size>` **(** **)** |const| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sort<class_PackedFloat64Array_method_sort>` **(** **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`subarray<class_PackedFloat64Array_method_subarray>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)** |const| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`to_byte_array<class_PackedFloat64Array_method_to_byte_array>` **(** **)** |const| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`append<class_PackedFloat64Array_method_append>` **(** :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`append_array<class_PackedFloat64Array_method_append_array>` **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` array **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`bsearch<class_PackedFloat64Array_method_bsearch>` **(** :ref:`float<class_float>` value, :ref:`bool<class_bool>` before=true **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`duplicate<class_PackedFloat64Array_method_duplicate>` **(** **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`fill<class_PackedFloat64Array_method_fill>` **(** :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has<class_PackedFloat64Array_method_has>` **(** :ref:`float<class_float>` value **)** |const| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`insert<class_PackedFloat64Array_method_insert>` **(** :ref:`int<class_int>` at_index, :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_empty<class_PackedFloat64Array_method_is_empty>` **(** **)** |const| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`push_back<class_PackedFloat64Array_method_push_back>` **(** :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`remove<class_PackedFloat64Array_method_remove>` **(** :ref:`int<class_int>` index **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`resize<class_PackedFloat64Array_method_resize>` **(** :ref:`int<class_int>` new_size **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`reverse<class_PackedFloat64Array_method_reverse>` **(** **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set<class_PackedFloat64Array_method_set>` **(** :ref:`int<class_int>` index, :ref:`float<class_float>` value **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`size<class_PackedFloat64Array_method_size>` **(** **)** |const| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`sort<class_PackedFloat64Array_method_sort>` **(** **)** |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`subarray<class_PackedFloat64Array_method_subarray>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)** |const| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`to_byte_array<class_PackedFloat64Array_method_to_byte_array>` **(** **)** |const| |
+-----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
Method Descriptions
-------------------
Operators
---------
.. _class_PackedFloat64Array_method_PackedFloat64Array:
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_PackedFloat64Array_operator_neq_bool>` **(** **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_PackedFloat64Array_operator_neq_bool>` **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`operator +<class_PackedFloat64Array_operator_sum_PackedFloat64Array>` **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_PackedFloat64Array_operator_eq_bool>` **(** **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_PackedFloat64Array_operator_eq_bool>` **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator []<class_PackedFloat64Array_operator_idx_float>` **(** :ref:`int<class_int>` index **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
- :ref:`PackedFloat64Array<class_PackedFloat64Array>` **PackedFloat64Array** **(** **)** |constructor|
Constructor Descriptions
------------------------
.. _class_PackedFloat64Array_constructor_PackedFloat64Array:
- :ref:`PackedFloat64Array<class_PackedFloat64Array>` **PackedFloat64Array** **(** **)**
Constructs an empty ``PackedFloat64Array``.
----
- :ref:`PackedFloat64Array<class_PackedFloat64Array>` **PackedFloat64Array** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` from **)** |constructor|
- :ref:`PackedFloat64Array<class_PackedFloat64Array>` **PackedFloat64Array** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` from **)**
Constructs a ``PackedFloat64Array`` as a copy of the given ``PackedFloat64Array``.
----
- :ref:`PackedFloat64Array<class_PackedFloat64Array>` **PackedFloat64Array** **(** :ref:`Array<class_Array>` from **)** |constructor|
- :ref:`PackedFloat64Array<class_PackedFloat64Array>` **PackedFloat64Array** **(** :ref:`Array<class_Array>` from **)**
Constructs a new ``PackedFloat64Array``. Optionally, you can pass in a generic :ref:`Array<class_Array>` that will be converted.
----
Method Descriptions
-------------------
.. _class_PackedFloat64Array_method_append:
@@ -164,38 +175,6 @@ Returns ``true`` if the array is empty.
----
.. _class_PackedFloat64Array_method_operator !=:
- :ref:`bool<class_bool>` **operator !=** **(** **)** |operator|
----
- :ref:`bool<class_bool>` **operator !=** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)** |operator|
----
.. _class_PackedFloat64Array_method_operator +:
- :ref:`PackedFloat64Array<class_PackedFloat64Array>` **operator +** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)** |operator|
----
.. _class_PackedFloat64Array_method_operator ==:
- :ref:`bool<class_bool>` **operator ==** **(** **)** |operator|
----
- :ref:`bool<class_bool>` **operator ==** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)** |operator|
----
.. _class_PackedFloat64Array_method_operator []:
- :ref:`float<class_float>` **operator []** **(** :ref:`int<class_int>` index **)** |operator|
----
.. _class_PackedFloat64Array_method_push_back:
- :ref:`bool<class_bool>` **push_back** **(** :ref:`float<class_float>` value **)**
@@ -266,6 +245,39 @@ Returns a copy of the data converted to a :ref:`PackedByteArray<class_PackedByte
The size of the new array will be ``float64_array.size() * 8``.
Operator Descriptions
---------------------
.. _class_PackedFloat64Array_operator_neq_bool:
- :ref:`bool<class_bool>` **operator !=** **(** **)**
----
- :ref:`bool<class_bool>` **operator !=** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)**
----
.. _class_PackedFloat64Array_operator_sum_PackedFloat64Array:
- :ref:`PackedFloat64Array<class_PackedFloat64Array>` **operator +** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)**
----
.. _class_PackedFloat64Array_operator_eq_bool:
- :ref:`bool<class_bool>` **operator ==** **(** **)**
----
- :ref:`bool<class_bool>` **operator ==** **(** :ref:`PackedFloat64Array<class_PackedFloat64Array>` right **)**
----
.. _class_PackedFloat64Array_operator_idx_float:
- :ref:`float<class_float>` **operator []** **(** :ref:`int<class_int>` index **)**
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`