godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +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

205
classes/class_vector4i.rst
View File

@@ -49,15 +49,15 @@ Constructors
.. table::
:widths: auto
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>` **(** **)** |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` from **)** |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>` **(** :ref:`Vector4<class_Vector4>` from **)** |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` w **)** |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>`\ (\ ) |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>`\ (\ from\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>`\ (\ from\: :ref:`Vector4<class_Vector4>`\ ) |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`Vector4i<class_Vector4i_constructor_Vector4i>`\ (\ x\: :ref:`int<class_int>`, y\: :ref:`int<class_int>`, z\: :ref:`int<class_int>`, w\: :ref:`int<class_int>`\ ) |
+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
@@ -67,27 +67,27 @@ Methods
.. table::
:widths: auto
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`abs<class_Vector4i_method_abs>` **(** **)** |const| |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`clamp<class_Vector4i_method_clamp>` **(** :ref:`Vector4i<class_Vector4i>` min, :ref:`Vector4i<class_Vector4i>` max **)** |const| |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`distance_squared_to<class_Vector4i_method_distance_squared_to>` **(** :ref:`Vector4i<class_Vector4i>` to **)** |const| |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`distance_to<class_Vector4i_method_distance_to>` **(** :ref:`Vector4i<class_Vector4i>` to **)** |const| |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`length<class_Vector4i_method_length>` **(** **)** |const| |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`length_squared<class_Vector4i_method_length_squared>` **(** **)** |const| |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`max_axis_index<class_Vector4i_method_max_axis_index>` **(** **)** |const| |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`min_axis_index<class_Vector4i_method_min_axis_index>` **(** **)** |const| |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`sign<class_Vector4i_method_sign>` **(** **)** |const| |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`snapped<class_Vector4i_method_snapped>` **(** :ref:`Vector4i<class_Vector4i>` step **)** |const| |
+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`abs<class_Vector4i_method_abs>`\ (\ ) |const| |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`clamp<class_Vector4i_method_clamp>`\ (\ min\: :ref:`Vector4i<class_Vector4i>`, max\: :ref:`Vector4i<class_Vector4i>`\ ) |const| |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`distance_squared_to<class_Vector4i_method_distance_squared_to>`\ (\ to\: :ref:`Vector4i<class_Vector4i>`\ ) |const| |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`distance_to<class_Vector4i_method_distance_to>`\ (\ to\: :ref:`Vector4i<class_Vector4i>`\ ) |const| |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`float<class_float>` | :ref:`length<class_Vector4i_method_length>`\ (\ ) |const| |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`length_squared<class_Vector4i_method_length_squared>`\ (\ ) |const| |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`max_axis_index<class_Vector4i_method_max_axis_index>`\ (\ ) |const| |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`min_axis_index<class_Vector4i_method_min_axis_index>`\ (\ ) |const| |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`sign<class_Vector4i_method_sign>`\ (\ ) |const| |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`snapped<class_Vector4i_method_snapped>`\ (\ step\: :ref:`Vector4i<class_Vector4i>`\ ) |const| |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-reftable-group
@@ -97,45 +97,45 @@ Operators
.. table::
:widths: auto
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_Vector4i_operator_neq_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator %<class_Vector4i_operator_mod_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator %<class_Vector4i_operator_mod_int>` **(** :ref:`int<class_int>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator *<class_Vector4i_operator_mul_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4<class_Vector4>` | :ref:`operator *<class_Vector4i_operator_mul_float>` **(** :ref:`float<class_float>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator *<class_Vector4i_operator_mul_int>` **(** :ref:`int<class_int>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator +<class_Vector4i_operator_sum_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator -<class_Vector4i_operator_dif_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator /<class_Vector4i_operator_div_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4<class_Vector4>` | :ref:`operator /<class_Vector4i_operator_div_float>` **(** :ref:`float<class_float>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator /<class_Vector4i_operator_div_int>` **(** :ref:`int<class_int>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<<class_Vector4i_operator_lt_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<=<class_Vector4i_operator_lte_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_Vector4i_operator_eq_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ><class_Vector4i_operator_gt_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator >=<class_Vector4i_operator_gte_Vector4i>` **(** :ref:`Vector4i<class_Vector4i>` right **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`operator []<class_Vector4i_operator_idx_int>` **(** :ref:`int<class_int>` index **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator unary+<class_Vector4i_operator_unplus>` **(** **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator unary-<class_Vector4i_operator_unminus>` **(** **)** |
+---------------------------------+-------------------------------------------------------------------------------------------------------------+
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator !=<class_Vector4i_operator_neq_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator %<class_Vector4i_operator_mod_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator %<class_Vector4i_operator_mod_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator *<class_Vector4i_operator_mul_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4<class_Vector4>` | :ref:`operator *<class_Vector4i_operator_mul_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator *<class_Vector4i_operator_mul_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator +<class_Vector4i_operator_sum_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator -<class_Vector4i_operator_dif_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator /<class_Vector4i_operator_div_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4<class_Vector4>` | :ref:`operator /<class_Vector4i_operator_div_float>`\ (\ right\: :ref:`float<class_float>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator /<class_Vector4i_operator_div_int>`\ (\ right\: :ref:`int<class_int>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<<class_Vector4i_operator_lt_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator \<=<class_Vector4i_operator_lte_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ==<class_Vector4i_operator_eq_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator ><class_Vector4i_operator_gt_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`operator >=<class_Vector4i_operator_gte_Vector4i>`\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`operator []<class_Vector4i_operator_idx_int>`\ (\ index\: :ref:`int<class_int>`\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator unary+<class_Vector4i_operator_unplus>`\ (\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
| :ref:`Vector4i<class_Vector4i>` | :ref:`operator unary-<class_Vector4i_operator_unminus>`\ (\ ) |
+---------------------------------+----------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
@@ -276,7 +276,7 @@ Constructor Descriptions
.. rst-class:: classref-constructor
:ref:`Vector4i<class_Vector4i>` **Vector4i** **(** **)**
:ref:`Vector4i<class_Vector4i>` **Vector4i**\ (\ )
Constructs a default-initialized **Vector4i** with all components set to ``0``.
@@ -286,7 +286,7 @@ Constructs a default-initialized **Vector4i** with all components set to ``0``.
.. rst-class:: classref-constructor
:ref:`Vector4i<class_Vector4i>` **Vector4i** **(** :ref:`Vector4i<class_Vector4i>` from **)**
:ref:`Vector4i<class_Vector4i>` **Vector4i**\ (\ from\: :ref:`Vector4i<class_Vector4i>`\ )
Constructs a **Vector4i** as a copy of the given **Vector4i**.
@@ -296,7 +296,7 @@ Constructs a **Vector4i** as a copy of the given **Vector4i**.
.. rst-class:: classref-constructor
:ref:`Vector4i<class_Vector4i>` **Vector4i** **(** :ref:`Vector4<class_Vector4>` from **)**
:ref:`Vector4i<class_Vector4i>` **Vector4i**\ (\ from\: :ref:`Vector4<class_Vector4>`\ )
Constructs a new **Vector4i** from the given :ref:`Vector4<class_Vector4>` by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of :ref:`Vector4.ceil<class_Vector4_method_ceil>`, :ref:`Vector4.floor<class_Vector4_method_floor>` or :ref:`Vector4.round<class_Vector4_method_round>` to this constructor instead.
@@ -306,7 +306,7 @@ Constructs a new **Vector4i** from the given :ref:`Vector4<class_Vector4>` by tr
.. rst-class:: classref-constructor
:ref:`Vector4i<class_Vector4i>` **Vector4i** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z, :ref:`int<class_int>` w **)**
:ref:`Vector4i<class_Vector4i>` **Vector4i**\ (\ x\: :ref:`int<class_int>`, y\: :ref:`int<class_int>`, z\: :ref:`int<class_int>`, w\: :ref:`int<class_int>`\ )
Returns a **Vector4i** with the given components.
@@ -323,7 +323,7 @@ Method Descriptions
.. rst-class:: classref-method
:ref:`Vector4i<class_Vector4i>` **abs** **(** **)** |const|
:ref:`Vector4i<class_Vector4i>` **abs**\ (\ ) |const|
Returns a new vector with all components in absolute values (i.e. positive).
@@ -335,7 +335,7 @@ Returns a new vector with all components in absolute values (i.e. positive).
.. rst-class:: classref-method
:ref:`Vector4i<class_Vector4i>` **clamp** **(** :ref:`Vector4i<class_Vector4i>` min, :ref:`Vector4i<class_Vector4i>` max **)** |const|
:ref:`Vector4i<class_Vector4i>` **clamp**\ (\ min\: :ref:`Vector4i<class_Vector4i>`, max\: :ref:`Vector4i<class_Vector4i>`\ ) |const|
Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp<class_@GlobalScope_method_clamp>` on each component.
@@ -347,7 +347,7 @@ Returns a new vector with all components clamped between the components of ``min
.. rst-class:: classref-method
:ref:`int<class_int>` **distance_squared_to** **(** :ref:`Vector4i<class_Vector4i>` to **)** |const|
:ref:`int<class_int>` **distance_squared_to**\ (\ to\: :ref:`Vector4i<class_Vector4i>`\ ) |const|
Returns the squared distance between this vector and ``to``.
@@ -361,7 +361,7 @@ This method runs faster than :ref:`distance_to<class_Vector4i_method_distance_to
.. rst-class:: classref-method
:ref:`float<class_float>` **distance_to** **(** :ref:`Vector4i<class_Vector4i>` to **)** |const|
:ref:`float<class_float>` **distance_to**\ (\ to\: :ref:`Vector4i<class_Vector4i>`\ ) |const|
Returns the distance between this vector and ``to``.
@@ -373,7 +373,7 @@ Returns the distance between this vector and ``to``.
.. rst-class:: classref-method
:ref:`float<class_float>` **length** **(** **)** |const|
:ref:`float<class_float>` **length**\ (\ ) |const|
Returns the length (magnitude) of this vector.
@@ -385,7 +385,7 @@ Returns the length (magnitude) of this vector.
.. rst-class:: classref-method
:ref:`int<class_int>` **length_squared** **(** **)** |const|
:ref:`int<class_int>` **length_squared**\ (\ ) |const|
Returns the squared length (squared magnitude) of this vector.
@@ -399,7 +399,7 @@ This method runs faster than :ref:`length<class_Vector4i_method_length>`, so pre
.. rst-class:: classref-method
:ref:`int<class_int>` **max_axis_index** **(** **)** |const|
:ref:`int<class_int>` **max_axis_index**\ (\ ) |const|
Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_X<class_Vector4i_constant_AXIS_X>`.
@@ -411,7 +411,7 @@ Returns the axis of the vector's highest value. See ``AXIS_*`` constants. If all
.. rst-class:: classref-method
:ref:`int<class_int>` **min_axis_index** **(** **)** |const|
:ref:`int<class_int>` **min_axis_index**\ (\ ) |const|
Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all components are equal, this method returns :ref:`AXIS_W<class_Vector4i_constant_AXIS_W>`.
@@ -423,7 +423,7 @@ Returns the axis of the vector's lowest value. See ``AXIS_*`` constants. If all
.. rst-class:: classref-method
:ref:`Vector4i<class_Vector4i>` **sign** **(** **)** |const|
:ref:`Vector4i<class_Vector4i>` **sign**\ (\ ) |const|
Returns a new vector with each component set to ``1`` if it's positive, ``-1`` if it's negative, and ``0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign<class_@GlobalScope_method_sign>` on each component.
@@ -435,7 +435,7 @@ Returns a new vector with each component set to ``1`` if it's positive, ``-1`` i
.. rst-class:: classref-method
:ref:`Vector4i<class_Vector4i>` **snapped** **(** :ref:`Vector4i<class_Vector4i>` step **)** |const|
:ref:`Vector4i<class_Vector4i>` **snapped**\ (\ step\: :ref:`Vector4i<class_Vector4i>`\ ) |const|
Returns a new vector with each component snapped to the closest multiple of the corresponding component in ``step``.
@@ -452,7 +452,7 @@ Operator Descriptions
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator !=** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`bool<class_bool>` **operator !=**\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Returns ``true`` if the vectors are not equal.
@@ -464,7 +464,7 @@ Returns ``true`` if the vectors are not equal.
.. rst-class:: classref-operator
:ref:`Vector4i<class_Vector4i>` **operator %** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`Vector4i<class_Vector4i>` **operator %**\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Gets the remainder of each component of the **Vector4i** with the components of the given **Vector4i**. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod<class_@GlobalScope_method_posmod>` instead if you want to handle negative numbers.
@@ -480,7 +480,7 @@ Gets the remainder of each component of the **Vector4i** with the components of
.. rst-class:: classref-operator
:ref:`Vector4i<class_Vector4i>` **operator %** **(** :ref:`int<class_int>` right **)**
:ref:`Vector4i<class_Vector4i>` **operator %**\ (\ right\: :ref:`int<class_int>`\ )
Gets the remainder of each component of the **Vector4i** with the the given :ref:`int<class_int>`. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod<class_@GlobalScope_method_posmod>` instead if you want to handle negative numbers.
@@ -496,7 +496,7 @@ Gets the remainder of each component of the **Vector4i** with the the given :ref
.. rst-class:: classref-operator
:ref:`Vector4i<class_Vector4i>` **operator *** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`Vector4i<class_Vector4i>` **operator ***\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Multiplies each component of the **Vector4i** by the components of the given **Vector4i**.
@@ -512,7 +512,7 @@ Multiplies each component of the **Vector4i** by the components of the given **V
.. rst-class:: classref-operator
:ref:`Vector4<class_Vector4>` **operator *** **(** :ref:`float<class_float>` right **)**
:ref:`Vector4<class_Vector4>` **operator ***\ (\ right\: :ref:`float<class_float>`\ )
Multiplies each component of the **Vector4i** by the given :ref:`float<class_float>`.
@@ -530,7 +530,7 @@ Returns a Vector4 value due to floating-point operations.
.. rst-class:: classref-operator
:ref:`Vector4i<class_Vector4i>` **operator *** **(** :ref:`int<class_int>` right **)**
:ref:`Vector4i<class_Vector4i>` **operator ***\ (\ right\: :ref:`int<class_int>`\ )
Multiplies each component of the **Vector4i** by the given :ref:`int<class_int>`.
@@ -542,7 +542,7 @@ Multiplies each component of the **Vector4i** by the given :ref:`int<class_int>`
.. rst-class:: classref-operator
:ref:`Vector4i<class_Vector4i>` **operator +** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`Vector4i<class_Vector4i>` **operator +**\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Adds each component of the **Vector4i** by the components of the given **Vector4i**.
@@ -558,7 +558,7 @@ Adds each component of the **Vector4i** by the components of the given **Vector4
.. rst-class:: classref-operator
:ref:`Vector4i<class_Vector4i>` **operator -** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`Vector4i<class_Vector4i>` **operator -**\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Subtracts each component of the **Vector4i** by the components of the given **Vector4i**.
@@ -574,7 +574,7 @@ Subtracts each component of the **Vector4i** by the components of the given **Ve
.. rst-class:: classref-operator
:ref:`Vector4i<class_Vector4i>` **operator /** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`Vector4i<class_Vector4i>` **operator /**\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Divides each component of the **Vector4i** by the components of the given **Vector4i**.
@@ -590,7 +590,7 @@ Divides each component of the **Vector4i** by the components of the given **Vect
.. rst-class:: classref-operator
:ref:`Vector4<class_Vector4>` **operator /** **(** :ref:`float<class_float>` right **)**
:ref:`Vector4<class_Vector4>` **operator /**\ (\ right\: :ref:`float<class_float>`\ )
Divides each component of the **Vector4i** by the given :ref:`float<class_float>`.
@@ -608,7 +608,7 @@ Returns a Vector4 value due to floating-point operations.
.. rst-class:: classref-operator
:ref:`Vector4i<class_Vector4i>` **operator /** **(** :ref:`int<class_int>` right **)**
:ref:`Vector4i<class_Vector4i>` **operator /**\ (\ right\: :ref:`int<class_int>`\ )
Divides each component of the **Vector4i** by the given :ref:`int<class_int>`.
@@ -620,7 +620,7 @@ Divides each component of the **Vector4i** by the given :ref:`int<class_int>`.
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator <** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`bool<class_bool>` **operator <**\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Compares two **Vector4i** vectors by first checking if the X value of the left vector is less than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
@@ -632,7 +632,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator <=** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`bool<class_bool>` **operator <=**\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Compares two **Vector4i** vectors by first checking if the X value of the left vector is less than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
@@ -644,7 +644,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator ==** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`bool<class_bool>` **operator ==**\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Returns ``true`` if the vectors are exactly equal.
@@ -656,7 +656,7 @@ Returns ``true`` if the vectors are exactly equal.
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator >** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`bool<class_bool>` **operator >**\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Compares two **Vector4i** vectors by first checking if the X value of the left vector is greater than the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
@@ -668,7 +668,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v
.. rst-class:: classref-operator
:ref:`bool<class_bool>` **operator >=** **(** :ref:`Vector4i<class_Vector4i>` right **)**
:ref:`bool<class_bool>` **operator >=**\ (\ right\: :ref:`Vector4i<class_Vector4i>`\ )
Compares two **Vector4i** vectors by first checking if the X value of the left vector is greater than or equal to the X value of the ``right`` vector. If the X values are exactly equal, then it repeats this check with the Y values of the two vectors, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.
@@ -680,7 +680,7 @@ Compares two **Vector4i** vectors by first checking if the X value of the left v
.. rst-class:: classref-operator
:ref:`int<class_int>` **operator []** **(** :ref:`int<class_int>` index **)**
:ref:`int<class_int>` **operator []**\ (\ index\: :ref:`int<class_int>`\ )
Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, ``v[1]`` is equivalent to ``v.y``, ``v[2]`` is equivalent to ``v.z``, and ``v[3]`` is equivalent to ``v.w``.
@@ -692,7 +692,7 @@ Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x`
.. rst-class:: classref-operator
:ref:`Vector4i<class_Vector4i>` **operator unary+** **(** **)**
:ref:`Vector4i<class_Vector4i>` **operator unary+**\ (\ )
Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable.
@@ -704,7 +704,7 @@ Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing,
.. rst-class:: classref-operator
:ref:`Vector4i<class_Vector4i>` **operator unary-** **(** **)**
:ref:`Vector4i<class_Vector4i>` **operator unary-**\ (\ )
Returns the negative value of the **Vector4i**. This is the same as writing ``Vector4i(-v.x, -v.y, -v.z, -v.w)``. This operation flips the direction of the vector while keeping the same magnitude.
@@ -715,3 +715,4 @@ Returns the negative value of the **Vector4i**. This is the same as writing ``Ve
.. |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.)`