godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-04 14:11:02 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (2e7fc81)

Browse Source
This commit is contained in:
Godot Organization
2024-02-24 03:20:02 +00:00
parent 4f21f44632
commit 8978497bb6
938 changed files with 42729 additions and 36889 deletions
Download Patch File Download Diff File Expand all files Collapse all files

227
classes/class_float.rst
View File

@@ -40,17 +40,17 @@ Constructors
.. table::
:widths: auto
+---------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** **)** |
+---------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** :ref:`float<class_float>` from **)** |
+---------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** :ref:`String<class_String>` from **)** |
+---------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** :ref:`bool<class_bool>` from **)** |
+---------------------------+------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>` **(** :ref:`int<class_int>` from **)** |
+---------------------------+------------------------------------------------------------------------------------------+
+---------------------------+---------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>`\ (\ ) |
+---------------------------+---------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>`\ (\ from\: :ref:`float<class_float>`\ ) |
+---------------------------+---------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>`\ (\ from\: :ref:`String<class_String>`\ ) |
+---------------------------+---------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>`\ (\ from\: :ref:`bool<class_bool>`\ ) |
+---------------------------+---------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`float<class_float_constructor_float>`\ (\ from\: :ref:`int<class_int>`\ ) |
+---------------------------+---------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
@@ -60,71 +60,71 @@ Operators
.. table::
:widths: auto
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_float_operator_neq_float>` **(** :ref:`float<class_float>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_float_operator_neq_int>` **(** :ref:`int<class_int>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator *<class_float_operator_mul_Color>` **(** :ref:`Color<class_Color>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`Quaternion<class_Quaternion>` | :ref:`operator *<class_float_operator_mul_Quaternion>` **(** :ref:`Quaternion<class_Quaternion>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`operator *<class_float_operator_mul_Vector2>` **(** :ref:`Vector2<class_Vector2>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`operator *<class_float_operator_mul_Vector2i>` **(** :ref:`Vector2i<class_Vector2i>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`operator *<class_float_operator_mul_Vector3>` **(** :ref:`Vector3<class_Vector3>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`operator *<class_float_operator_mul_Vector3i>` **(** :ref:`Vector3i<class_Vector3i>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4<class_Vector4>` | :ref:`operator *<class_float_operator_mul_Vector4>` **(** :ref:`Vector4<class_Vector4>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4<class_Vector4>` | :ref:`operator *<class_float_operator_mul_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator *<class_float_operator_mul_float>` **(** :ref:`float<class_float>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator *<class_float_operator_mul_int>` **(** :ref:`int<class_int>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator **<class_float_operator_pow_float>` **(** :ref:`float<class_float>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator **<class_float_operator_pow_int>` **(** :ref:`int<class_int>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator +<class_float_operator_sum_float>` **(** :ref:`float<class_float>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator +<class_float_operator_sum_int>` **(** :ref:`int<class_int>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator -<class_float_operator_dif_float>` **(** :ref:`float<class_float>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator -<class_float_operator_dif_int>` **(** :ref:`int<class_int>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator /<class_float_operator_div_float>` **(** :ref:`float<class_float>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator /<class_float_operator_div_int>` **(** :ref:`int<class_int>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<<class_float_operator_lt_float>` **(** :ref:`float<class_float>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<<class_float_operator_lt_int>` **(** :ref:`int<class_int>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<=<class_float_operator_lte_float>` **(** :ref:`float<class_float>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<=<class_float_operator_lte_int>` **(** :ref:`int<class_int>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_float_operator_eq_float>` **(** :ref:`float<class_float>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_float_operator_eq_int>` **(** :ref:`int<class_int>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ><class_float_operator_gt_float>` **(** :ref:`float<class_float>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ><class_float_operator_gt_int>` **(** :ref:`int<class_int>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator >=<class_float_operator_gte_float>` **(** :ref:`float<class_float>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator >=<class_float_operator_gte_int>` **(** :ref:`int<class_int>` right **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator unary+<class_float_operator_unplus>` **(** **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator unary-<class_float_operator_unminus>` **(** **)** |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------+
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_float_operator_neq_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_float_operator_neq_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_Color>` | :ref:`operator *<class_float_operator_mul_Color>`\ (\ right\: :ref:`Color<class_Color>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Quaternion<class_Quaternion>` | :ref:`operator *<class_float_operator_mul_Quaternion>`\ (\ right\: :ref:`Quaternion<class_Quaternion>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`operator *<class_float_operator_mul_Vector2>`\ (\ right\: :ref:`Vector2<class_Vector2>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Vector2<class_Vector2>` | :ref:`operator *<class_float_operator_mul_Vector2i>`\ (\ right\: :ref:`Vector2i<class_Vector2i>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`operator *<class_float_operator_mul_Vector3>`\ (\ right\: :ref:`Vector3<class_Vector3>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Vector3<class_Vector3>` | :ref:`operator *<class_float_operator_mul_Vector3i>`\ (\ right\: :ref:`Vector3i<class_Vector3i>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4<class_Vector4>` | :ref:`operator *<class_float_operator_mul_Vector4>`\ (\ right\: :ref:`Vector4<class_Vector4>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4<class_Vector4>` | :ref:`operator *<class_float_operator_mul_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator *<class_float_operator_mul_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator *<class_float_operator_mul_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator **<class_float_operator_pow_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator **<class_float_operator_pow_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator +<class_float_operator_sum_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator +<class_float_operator_sum_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator -<class_float_operator_dif_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator -<class_float_operator_dif_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator /<class_float_operator_div_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator /<class_float_operator_div_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<<class_float_operator_lt_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<<class_float_operator_lt_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<=<class_float_operator_lte_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<=<class_float_operator_lte_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_float_operator_eq_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_float_operator_eq_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ><class_float_operator_gt_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ><class_float_operator_gt_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator >=<class_float_operator_gte_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator >=<class_float_operator_gte_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator unary+<class_float_operator_unplus>`\ (\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`operator unary-<class_float_operator_unminus>`\ (\ ) |
+-------------------------------------+-----------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@@ -139,7 +139,7 @@ Constructor Descriptions
.. rst-class:: classref-constructor
:ref:`float<class_float>` **float** **(** **)**
:ref:`float<class_float>` **float**\ (\ )
Constructs a default-initialized **float** set to ``0.0``.
@@ -149,7 +149,7 @@ Constructs a default-initialized **float** set to ``0.0``.
.. rst-class:: classref-constructor
:ref:`float<class_float>` **float** **(** :ref:`float<class_float>` from **)**
:ref:`float<class_float>` **float**\ (\ from\: :ref:`float<class_float>`\ )
Constructs a **float** as a copy of the given **float**.
@@ -159,7 +159,7 @@ Constructs a **float** as a copy of the given **float**.
.. rst-class:: classref-constructor
:ref:`float<class_float>` **float** **(** :ref:`String<class_String>` from **)**
:ref:`float<class_float>` **float**\ (\ from\: :ref:`String<class_String>`\ )
Converts a :ref:`String<class_String>` to a **float**, following the same rules as :ref:`String.to_float<class_String_method_to_float>`.
@@ -169,7 +169,7 @@ Converts a :ref:`String<class_String>` to a **float**, following the same rules
.. rst-class:: classref-constructor
:ref:`float<class_float>` **float** **(** :ref:`bool<class_bool>` from **)**
:ref:`float<class_float>` **float**\ (\ from\: :ref:`bool<class_bool>`\ )
Cast a :ref:`bool<class_bool>` value to a floating-point value, ``float(true)`` will be equal to 1.0 and ``float(false)`` will be equal to 0.0.
@@ -179,7 +179,7 @@ Cast a :ref:`bool<class_bool>` value to a floating-point value, ``float(true)``
.. rst-class:: classref-constructor
:ref:`float<class_float>` **float** **(** :ref:`int<class_int>` from **)**
:ref:`float<class_float>` **float**\ (\ from\: :ref:`int<class_int>`\ )
Cast an :ref:`int<class_int>` value to a floating-point value, ``float(1)`` will be equal to ``1.0``.
@@ -196,7 +196,7 @@ Operator Descriptions
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator !=** **(** :ref:`float<class_float>` right **)**
:ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`float<class_float>`\ )
Returns ``true`` if two floats are different from each other.
@@ -210,7 +210,7 @@ Returns ``true`` if two floats are different from each other.
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator !=** **(** :ref:`int<class_int>` right **)**
:ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`int<class_int>`\ )
Returns ``true`` if the integer has different value than the float.
@@ -222,7 +222,7 @@ Returns ``true`` if the integer has different value than the float.
.. rst-class:: classref-operator
:ref:`Color<class_Color>` **operator *** **(** :ref:`Color<class_Color>` right **)**
:ref:`Color<class_Color>` **operator ***\ (\ right\: :ref:`Color<class_Color>`\ )
Multiplies each component of the :ref:`Color<class_Color>`, including the alpha, by the given **float**.
@@ -238,7 +238,7 @@ Multiplies each component of the :ref:`Color<class_Color>`, including the alpha,
.. rst-class:: classref-operator
:ref:`Quaternion<class_Quaternion>` **operator *** **(** :ref:`Quaternion<class_Quaternion>` right **)**
:ref:`Quaternion<class_Quaternion>` **operator ***\ (\ right\: :ref:`Quaternion<class_Quaternion>`\ )
Multiplies each component of the :ref:`Quaternion<class_Quaternion>` by the given **float**. This operation is not meaningful on its own, but it can be used as a part of a larger expression.
@@ -250,7 +250,7 @@ Multiplies each component of the :ref:`Quaternion<class_Quaternion>` by the give
.. rst-class:: classref-operator
:ref:`Vector2<class_Vector2>` **operator *** **(** :ref:`Vector2<class_Vector2>` right **)**
:ref:`Vector2<class_Vector2>` **operator ***\ (\ right\: :ref:`Vector2<class_Vector2>`\ )
Multiplies each component of the :ref:`Vector2<class_Vector2>` by the given **float**.
@@ -266,7 +266,7 @@ Multiplies each component of the :ref:`Vector2<class_Vector2>` by the given **fl
.. rst-class:: classref-operator
:ref:`Vector2<class_Vector2>` **operator *** **(** :ref:`Vector2i<class_Vector2i>` right **)**
:ref:`Vector2<class_Vector2>` **operator ***\ (\ right\: :ref:`Vector2i<class_Vector2i>`\ )
Multiplies each component of the :ref:`Vector2i<class_Vector2i>` by the given **float**. Returns a :ref:`Vector2<class_Vector2>`.
@@ -282,7 +282,7 @@ Multiplies each component of the :ref:`Vector2i<class_Vector2i>` by the given **
.. rst-class:: classref-operator
:ref:`Vector3<class_Vector3>` **operator *** **(** :ref:`Vector3<class_Vector3>` right **)**
:ref:`Vector3<class_Vector3>` **operator ***\ (\ right\: :ref:`Vector3<class_Vector3>`\ )
Multiplies each component of the :ref:`Vector3<class_Vector3>` by the given **float**.
@@ -294,7 +294,7 @@ Multiplies each component of the :ref:`Vector3<class_Vector3>` by the given **fl
.. rst-class:: classref-operator
:ref:`Vector3<class_Vector3>` **operator *** **(** :ref:`Vector3i<class_Vector3i>` right **)**
:ref:`Vector3<class_Vector3>` **operator ***\ (\ right\: :ref:`Vector3i<class_Vector3i>`\ )
Multiplies each component of the :ref:`Vector3i<class_Vector3i>` by the given **float**. Returns a :ref:`Vector3<class_Vector3>`.
@@ -310,7 +310,7 @@ Multiplies each component of the :ref:`Vector3i<class_Vector3i>` by the given **
.. rst-class:: classref-operator
:ref:`Vector4<class_Vector4>` **operator *** **(** :ref:`Vector4<class_Vector4>` right **)**
:ref:`Vector4<class_Vector4>` **operator ***\ (\ right\: :ref:`Vector4<class_Vector4>`\ )
Multiplies each component of the :ref:`Vector4<class_Vector4>` by the given **float**.
@@ -322,7 +322,7 @@ Multiplies each component of the :ref:`Vector4<class_Vector4>` by the given **fl
.. rst-class:: classref-operator
:ref:`Vector4<class_Vector4>` **operator *** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`Vector4<class_Vector4>` **operator ***\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Multiplies each component of the :ref:`Vector4i<class_Vector4i>` by the given **float**. Returns a :ref:`Vector4<class_Vector4>`.
@@ -338,7 +338,7 @@ Multiplies each component of the :ref:`Vector4i<class_Vector4i>` by the given **
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator *** **(** :ref:`float<class_float>` right **)**
:ref:`float<class_float>` **operator ***\ (\ right\: :ref:`float<class_float>`\ )
Multiplies two **float**\ s.
@@ -350,7 +350,7 @@ Multiplies two **float**\ s.
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator *** **(** :ref:`int<class_int>` right **)**
:ref:`float<class_float>` **operator ***\ (\ right\: :ref:`int<class_int>`\ )
Multiplies a **float** and an :ref:`int<class_int>`. The result is a **float**.
@@ -362,7 +362,7 @@ Multiplies a **float** and an :ref:`int<class_int>`. The result is a **float**.
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator **** **(** :ref:`float<class_float>` right **)**
:ref:`float<class_float>` **operator ****\ (\ right\: :ref:`float<class_float>`\ )
Raises a **float** to a power of a **float**.
@@ -378,7 +378,7 @@ Raises a **float** to a power of a **float**.
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator **** **(** :ref:`int<class_int>` right **)**
:ref:`float<class_float>` **operator ****\ (\ right\: :ref:`int<class_int>`\ )
Raises a **float** to a power of an :ref:`int<class_int>`. The result is a **float**.
@@ -394,7 +394,7 @@ Raises a **float** to a power of an :ref:`int<class_int>`. The result is a **flo
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator +** **(** :ref:`float<class_float>` right **)**
:ref:`float<class_float>` **operator +**\ (\ right\: :ref:`float<class_float>`\ )
Adds two floats.
@@ -406,7 +406,7 @@ Adds two floats.
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator +** **(** :ref:`int<class_int>` right **)**
:ref:`float<class_float>` **operator +**\ (\ right\: :ref:`int<class_int>`\ )
Adds a **float** and an :ref:`int<class_int>`. The result is a **float**.
@@ -418,7 +418,7 @@ Adds a **float** and an :ref:`int<class_int>`. The result is a **float**.
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator -** **(** :ref:`float<class_float>` right **)**
:ref:`float<class_float>` **operator -**\ (\ right\: :ref:`float<class_float>`\ )
Subtracts a float from a float.
@@ -430,7 +430,7 @@ Subtracts a float from a float.
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator -** **(** :ref:`int<class_int>` right **)**
:ref:`float<class_float>` **operator -**\ (\ right\: :ref:`int<class_int>`\ )
Subtracts an :ref:`int<class_int>` from a **float**. The result is a **float**.
@@ -442,7 +442,7 @@ Subtracts an :ref:`int<class_int>` from a **float**. The result is a **float**.
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator /** **(** :ref:`float<class_float>` right **)**
:ref:`float<class_float>` **operator /**\ (\ right\: :ref:`float<class_float>`\ )
Divides two floats.
@@ -454,7 +454,7 @@ Divides two floats.
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator /** **(** :ref:`int<class_int>` right **)**
:ref:`float<class_float>` **operator /**\ (\ right\: :ref:`int<class_int>`\ )
Divides a **float** by an :ref:`int<class_int>`. The result is a **float**.
@@ -466,7 +466,7 @@ Divides a **float** by an :ref:`int<class_int>`. The result is a **float**.
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator <** **(** :ref:`float<class_float>` right **)**
:ref:`bool<class_bool>` **operator <**\ (\ right\: :ref:`float<class_float>`\ )
Returns ``true`` if the left float is less than the right one.
@@ -480,7 +480,7 @@ Returns ``true`` if the left float is less than the right one.
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator <** **(** :ref:`int<class_int>` right **)**
:ref:`bool<class_bool>` **operator <**\ (\ right\: :ref:`int<class_int>`\ )
Returns ``true`` if this **float** is less than the given :ref:`int<class_int>`.
@@ -492,7 +492,7 @@ Returns ``true`` if this **float** is less than the given :ref:`int<class_int>`.
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator <=** **(** :ref:`float<class_float>` right **)**
:ref:`bool<class_bool>` **operator <=**\ (\ right\: :ref:`float<class_float>`\ )
Returns ``true`` if the left float is less than or equal to the right one.
@@ -506,7 +506,7 @@ Returns ``true`` if the left float is less than or equal to the right one.
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator <=** **(** :ref:`int<class_int>` right **)**
:ref:`bool<class_bool>` **operator <=**\ (\ right\: :ref:`int<class_int>`\ )
Returns ``true`` if this **float** is less than or equal to the given :ref:`int<class_int>`.
@@ -518,7 +518,7 @@ Returns ``true`` if this **float** is less than or equal to the given :ref:`int<
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator ==** **(** :ref:`float<class_float>` right **)**
:ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`float<class_float>`\ )
Returns ``true`` if both floats are exactly equal.
@@ -534,7 +534,7 @@ Returns ``true`` if both floats are exactly equal.
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator ==** **(** :ref:`int<class_int>` right **)**
:ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`int<class_int>`\ )
Returns ``true`` if the **float** and the given :ref:`int<class_int>` are equal.
@@ -546,7 +546,7 @@ Returns ``true`` if the **float** and the given :ref:`int<class_int>` are equal.
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator >** **(** :ref:`float<class_float>` right **)**
:ref:`bool<class_bool>` **operator >**\ (\ right\: :ref:`float<class_float>`\ )
Returns ``true`` if the left float is greater than the right one.
@@ -560,7 +560,7 @@ Returns ``true`` if the left float is greater than the right one.
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator >** **(** :ref:`int<class_int>` right **)**
:ref:`bool<class_bool>` **operator >**\ (\ right\: :ref:`int<class_int>`\ )
Returns ``true`` if this **float** is greater than the given :ref:`int<class_int>`.
@@ -572,7 +572,7 @@ Returns ``true`` if this **float** is greater than the given :ref:`int<class_int
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator >=** **(** :ref:`float<class_float>` right **)**
:ref:`bool<class_bool>` **operator >=**\ (\ right\: :ref:`float<class_float>`\ )
Returns ``true`` if the left float is greater than or equal to the right one.
@@ -586,7 +586,7 @@ Returns ``true`` if the left float is greater than or equal to the right one.
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator >=** **(** :ref:`int<class_int>` right **)**
:ref:`bool<class_bool>` **operator >=**\ (\ right\: :ref:`int<class_int>`\ )
Returns ``true`` if this **float** is greater than or equal to the given :ref:`int<class_int>`.
@@ -598,7 +598,7 @@ Returns ``true`` if this **float** is greater than or equal to the given :ref:`i
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator unary+** **(** **)**
:ref:`float<class_float>` **operator unary+**\ (\ )
Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable.
@@ -610,7 +610,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing,
.. rst-class:: classref-operator
:ref:`float<class_float>` **operator unary-** **(** **)**
:ref:`float<class_float>` **operator unary-**\ (\ )
Returns the negative value of the **float**. If positive, turns the number negative. If negative, turns the number positive. With floats, the number zero can be either positive or negative.
@@ -621,3 +621,4 @@ Returns the negative value of the **float**. If positive, turns the number negat
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`