mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
classref: Sync with current master branch (705b7a0)
This commit is contained in:
@@ -126,7 +126,7 @@ Constructor Descriptions
|
||||
|
||||
.. rst-class:: classref-constructor
|
||||
|
||||
:ref:`PackedFloat32Array<class_PackedFloat32Array>` **PackedFloat32Array**\ (\ )
|
||||
:ref:`PackedFloat32Array<class_PackedFloat32Array>` **PackedFloat32Array**\ (\ ) :ref:`🔗<class_PackedFloat32Array_constructor_PackedFloat32Array>`
|
||||
|
||||
Constructs an empty **PackedFloat32Array**.
|
||||
|
||||
@@ -163,7 +163,7 @@ Method Descriptions
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **append**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
:ref:`bool<class_bool>` **append**\ (\ value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat32Array_method_append>`
|
||||
|
||||
Appends an element at the end of the array (alias of :ref:`push_back<class_PackedFloat32Array_method_push_back>`).
|
||||
|
||||
@@ -175,7 +175,7 @@ Appends an element at the end of the array (alias of :ref:`push_back<class_Packe
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **append_array**\ (\ array\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ )
|
||||
|void| **append_array**\ (\ array\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`🔗<class_PackedFloat32Array_method_append_array>`
|
||||
|
||||
Appends a **PackedFloat32Array** at the end of this array.
|
||||
|
||||
@@ -187,7 +187,7 @@ Appends a **PackedFloat32Array** at the end of this array.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **bsearch**\ (\ value\: :ref:`float<class_float>`, before\: :ref:`bool<class_bool>` = true\ )
|
||||
:ref:`int<class_int>` **bsearch**\ (\ value\: :ref:`float<class_float>`, before\: :ref:`bool<class_bool>` = true\ ) :ref:`🔗<class_PackedFloat32Array_method_bsearch>`
|
||||
|
||||
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.
|
||||
|
||||
@@ -203,7 +203,7 @@ Finds the index of an existing value (or the insertion index that maintains sort
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **clear**\ (\ )
|
||||
|void| **clear**\ (\ ) :ref:`🔗<class_PackedFloat32Array_method_clear>`
|
||||
|
||||
Clears the array. This is equivalent to using :ref:`resize<class_PackedFloat32Array_method_resize>` with a size of ``0``.
|
||||
|
||||
@@ -215,7 +215,7 @@ Clears the array. This is equivalent to using :ref:`resize<class_PackedFloat32Ar
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **count**\ (\ value\: :ref:`float<class_float>`\ ) |const|
|
||||
:ref:`int<class_int>` **count**\ (\ value\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_count>`
|
||||
|
||||
Returns the number of times an element is in the array.
|
||||
|
||||
@@ -229,7 +229,7 @@ Returns the number of times an element is in the array.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`PackedFloat32Array<class_PackedFloat32Array>` **duplicate**\ (\ )
|
||||
:ref:`PackedFloat32Array<class_PackedFloat32Array>` **duplicate**\ (\ ) :ref:`🔗<class_PackedFloat32Array_method_duplicate>`
|
||||
|
||||
Creates a copy of the array, and returns it.
|
||||
|
||||
@@ -241,7 +241,7 @@ Creates a copy of the array, and returns it.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **fill**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
|void| **fill**\ (\ value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat32Array_method_fill>`
|
||||
|
||||
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.
|
||||
|
||||
@@ -253,7 +253,7 @@ Assigns the given value to all elements in the array. This can typically be used
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **find**\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = 0\ ) |const|
|
||||
:ref:`int<class_int>` **find**\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = 0\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_find>`
|
||||
|
||||
Searches the array for a value and returns its index or ``-1`` if not found. Optionally, the initial search index can be passed.
|
||||
|
||||
@@ -267,7 +267,7 @@ Searches the array for a value and returns its index or ``-1`` if not found. Opt
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **has**\ (\ value\: :ref:`float<class_float>`\ ) |const|
|
||||
:ref:`bool<class_bool>` **has**\ (\ value\: :ref:`float<class_float>`\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_has>`
|
||||
|
||||
Returns ``true`` if the array contains ``value``.
|
||||
|
||||
@@ -281,7 +281,7 @@ Returns ``true`` if the array contains ``value``.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **insert**\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ )
|
||||
:ref:`int<class_int>` **insert**\ (\ at_index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat32Array_method_insert>`
|
||||
|
||||
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()``).
|
||||
|
||||
@@ -293,7 +293,7 @@ Inserts a new element at a given position in the array. The position must be val
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **is_empty**\ (\ ) |const|
|
||||
:ref:`bool<class_bool>` **is_empty**\ (\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_is_empty>`
|
||||
|
||||
Returns ``true`` if the array is empty.
|
||||
|
||||
@@ -305,7 +305,7 @@ Returns ``true`` if the array is empty.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`bool<class_bool>` **push_back**\ (\ value\: :ref:`float<class_float>`\ )
|
||||
:ref:`bool<class_bool>` **push_back**\ (\ value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat32Array_method_push_back>`
|
||||
|
||||
Appends an element at the end of the array.
|
||||
|
||||
@@ -317,7 +317,7 @@ Appends an element at the end of the array.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **remove_at**\ (\ index\: :ref:`int<class_int>`\ )
|
||||
|void| **remove_at**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedFloat32Array_method_remove_at>`
|
||||
|
||||
Removes an element from the array by index.
|
||||
|
||||
@@ -329,7 +329,7 @@ Removes an element from the array by index.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **resize**\ (\ new_size\: :ref:`int<class_int>`\ )
|
||||
:ref:`int<class_int>` **resize**\ (\ new_size\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedFloat32Array_method_resize>`
|
||||
|
||||
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.
|
||||
|
||||
@@ -341,7 +341,7 @@ Sets the size of the array. If the array is grown, reserves elements at the end
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **reverse**\ (\ )
|
||||
|void| **reverse**\ (\ ) :ref:`🔗<class_PackedFloat32Array_method_reverse>`
|
||||
|
||||
Reverses the order of the elements in the array.
|
||||
|
||||
@@ -353,7 +353,7 @@ Reverses the order of the elements in the array.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **rfind**\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = -1\ ) |const|
|
||||
:ref:`int<class_int>` **rfind**\ (\ value\: :ref:`float<class_float>`, from\: :ref:`int<class_int>` = -1\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_rfind>`
|
||||
|
||||
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.
|
||||
|
||||
@@ -367,7 +367,7 @@ Searches the array in reverse order. Optionally, a start search index can be pas
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **set**\ (\ index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ )
|
||||
|void| **set**\ (\ index\: :ref:`int<class_int>`, value\: :ref:`float<class_float>`\ ) :ref:`🔗<class_PackedFloat32Array_method_set>`
|
||||
|
||||
Changes the float at the given index.
|
||||
|
||||
@@ -379,7 +379,7 @@ Changes the float at the given index.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`int<class_int>` **size**\ (\ ) |const|
|
||||
:ref:`int<class_int>` **size**\ (\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_size>`
|
||||
|
||||
Returns the number of elements in the array.
|
||||
|
||||
@@ -391,7 +391,7 @@ Returns the number of elements in the array.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`PackedFloat32Array<class_PackedFloat32Array>` **slice**\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const|
|
||||
:ref:`PackedFloat32Array<class_PackedFloat32Array>` **slice**\ (\ begin\: :ref:`int<class_int>`, end\: :ref:`int<class_int>` = 2147483647\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_slice>`
|
||||
|
||||
Returns the slice of the **PackedFloat32Array**, from ``begin`` (inclusive) to ``end`` (exclusive), as a new **PackedFloat32Array**.
|
||||
|
||||
@@ -407,7 +407,7 @@ If either ``begin`` or ``end`` are negative, they will be relative to the end of
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
|void| **sort**\ (\ )
|
||||
|void| **sort**\ (\ ) :ref:`🔗<class_PackedFloat32Array_method_sort>`
|
||||
|
||||
Sorts the elements of the array in ascending order.
|
||||
|
||||
@@ -421,7 +421,7 @@ Sorts the elements of the array in ascending order.
|
||||
|
||||
.. rst-class:: classref-method
|
||||
|
||||
:ref:`PackedByteArray<class_PackedByteArray>` **to_byte_array**\ (\ ) |const|
|
||||
:ref:`PackedByteArray<class_PackedByteArray>` **to_byte_array**\ (\ ) |const| :ref:`🔗<class_PackedFloat32Array_method_to_byte_array>`
|
||||
|
||||
Returns a copy of the data converted to a :ref:`PackedByteArray<class_PackedByteArray>`, where each element have been encoded as 4 bytes.
|
||||
|
||||
@@ -440,7 +440,7 @@ Operator Descriptions
|
||||
|
||||
.. rst-class:: classref-operator
|
||||
|
||||
:ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ )
|
||||
:ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`🔗<class_PackedFloat32Array_operator_neq_PackedFloat32Array>`
|
||||
|
||||
Returns ``true`` if contents of the arrays differ.
|
||||
|
||||
@@ -452,7 +452,7 @@ Returns ``true`` if contents of the arrays differ.
|
||||
|
||||
.. rst-class:: classref-operator
|
||||
|
||||
:ref:`PackedFloat32Array<class_PackedFloat32Array>` **operator +**\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ )
|
||||
:ref:`PackedFloat32Array<class_PackedFloat32Array>` **operator +**\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`🔗<class_PackedFloat32Array_operator_sum_PackedFloat32Array>`
|
||||
|
||||
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.
|
||||
|
||||
@@ -464,7 +464,7 @@ Returns a new **PackedFloat32Array** with contents of ``right`` added at the end
|
||||
|
||||
.. rst-class:: classref-operator
|
||||
|
||||
:ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ )
|
||||
:ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`🔗<class_PackedFloat32Array_operator_eq_PackedFloat32Array>`
|
||||
|
||||
Returns ``true`` if contents of both arrays are the same, i.e. they have all equal floats at the corresponding indices.
|
||||
|
||||
@@ -476,7 +476,7 @@ Returns ``true`` if contents of both arrays are the same, i.e. they have all equ
|
||||
|
||||
.. rst-class:: classref-operator
|
||||
|
||||
:ref:`float<class_float>` **operator []**\ (\ index\: :ref:`int<class_int>`\ )
|
||||
:ref:`float<class_float>` **operator []**\ (\ index\: :ref:`int<class_int>`\ ) :ref:`🔗<class_PackedFloat32Array_operator_idx_int>`
|
||||
|
||||
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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user