:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.0/doc/classes/Vector4.xml. .. _class_Vector4: Vector4 ======= A 4D vector using floating point coordinates. .. rst-class:: classref-introduction-group Description ----------- A 4-element structure that can be used to represent 4D coordinates or any other quadruplet of numeric values. It uses floating-point coordinates. By default, these floating-point values use 32-bit precision, unlike :ref:`float` which is always 64-bit. If double precision is needed, compile the engine with the option ``precision=double``. See :ref:`Vector4i` for its integer counterpart. \ **Note:** In a boolean context, a Vector4 will evaluate to ``false`` if it's equal to ``Vector4(0, 0, 0, 0)``. Otherwise, a Vector4 will always evaluate to ``true``. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +---------------------------+------------------------------------+---------+ | :ref:`float` | :ref:`w` | ``0.0`` | +---------------------------+------------------------------------+---------+ | :ref:`float` | :ref:`x` | ``0.0`` | +---------------------------+------------------------------------+---------+ | :ref:`float` | :ref:`y` | ``0.0`` | +---------------------------+------------------------------------+---------+ | :ref:`float` | :ref:`z` | ``0.0`` | +---------------------------+------------------------------------+---------+ .. rst-class:: classref-reftable-group Constructors ------------ .. table:: :widths: auto +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`Vector4` **(** **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`Vector4` **(** :ref:`Vector4` from **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`Vector4` **(** :ref:`Vector4i` from **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`Vector4` **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`abs` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`ceil` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`clamp` **(** :ref:`Vector4` min, :ref:`Vector4` max **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`cubic_interpolate` **(** :ref:`Vector4` b, :ref:`Vector4` pre_a, :ref:`Vector4` post_b, :ref:`float` weight **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`cubic_interpolate_in_time` **(** :ref:`Vector4` b, :ref:`Vector4` pre_a, :ref:`Vector4` post_b, :ref:`float` weight, :ref:`float` b_t, :ref:`float` pre_a_t, :ref:`float` post_b_t **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`direction_to` **(** :ref:`Vector4` to **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`distance_squared_to` **(** :ref:`Vector4` to **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`distance_to` **(** :ref:`Vector4` to **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`dot` **(** :ref:`Vector4` with **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`floor` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`inverse` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_equal_approx` **(** :ref:`Vector4` to **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_finite` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_normalized` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_zero_approx` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length_squared` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`lerp` **(** :ref:`Vector4` to, :ref:`float` weight **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`max_axis_index` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`min_axis_index` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`normalized` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`posmod` **(** :ref:`float` mod **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`posmodv` **(** :ref:`Vector4` modv **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`round` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`sign` **(** **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`snapped` **(** :ref:`Vector4` step **)** |const| | +-------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Operators --------- .. table:: :widths: auto +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator !=` **(** :ref:`Vector4` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator *` **(** :ref:`Projection` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator *` **(** :ref:`Vector4` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator *` **(** :ref:`float` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator *` **(** :ref:`int` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator +` **(** :ref:`Vector4` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator -` **(** :ref:`Vector4` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator /` **(** :ref:`Vector4` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator /` **(** :ref:`float` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator /` **(** :ref:`int` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator \<` **(** :ref:`Vector4` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator \<=` **(** :ref:`Vector4` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator ==` **(** :ref:`Vector4` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator >` **(** :ref:`Vector4` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator >=` **(** :ref:`Vector4` right **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`operator []` **(** :ref:`int` index **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator unary+` **(** **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ | :ref:`Vector4` | :ref:`operator unary-` **(** **)** | +-------------------------------+----------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_Vector4_constant_AXIS_X: .. rst-class:: classref-constant **AXIS_X** = ``0`` Enumerated value for the X axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. .. _class_Vector4_constant_AXIS_Y: .. rst-class:: classref-constant **AXIS_Y** = ``1`` Enumerated value for the Y axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. .. _class_Vector4_constant_AXIS_Z: .. rst-class:: classref-constant **AXIS_Z** = ``2`` Enumerated value for the Z axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. .. _class_Vector4_constant_AXIS_W: .. rst-class:: classref-constant **AXIS_W** = ``3`` Enumerated value for the W axis. Returned by :ref:`max_axis_index` and :ref:`min_axis_index`. .. _class_Vector4_constant_ZERO: .. rst-class:: classref-constant **ZERO** = ``Vector4(0, 0, 0, 0)`` Zero vector, a vector with all components set to ``0``. .. _class_Vector4_constant_ONE: .. rst-class:: classref-constant **ONE** = ``Vector4(1, 1, 1, 1)`` One vector, a vector with all components set to ``1``. .. _class_Vector4_constant_INF: .. rst-class:: classref-constant **INF** = ``Vector4(inf, inf, inf, inf)`` Infinity vector, a vector with all components set to :ref:`@GDScript.INF`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Vector4_property_w: .. rst-class:: classref-property :ref:`float` **w** = ``0.0`` The vector's W component. Also accessible by using the index position ``[3]``. .. rst-class:: classref-item-separator ---- .. _class_Vector4_property_x: .. rst-class:: classref-property :ref:`float` **x** = ``0.0`` The vector's X component. Also accessible by using the index position ``[0]``. .. rst-class:: classref-item-separator ---- .. _class_Vector4_property_y: .. rst-class:: classref-property :ref:`float` **y** = ``0.0`` The vector's Y component. Also accessible by using the index position ``[1]``. .. rst-class:: classref-item-separator ---- .. _class_Vector4_property_z: .. rst-class:: classref-property :ref:`float` **z** = ``0.0`` The vector's Z component. Also accessible by using the index position ``[2]``. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constructor Descriptions ------------------------ .. _class_Vector4_constructor_Vector4: .. rst-class:: classref-constructor :ref:`Vector4` **Vector4** **(** **)** Constructs a default-initialized **Vector4** with all components set to ``0``. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Vector4` **Vector4** **(** :ref:`Vector4` from **)** Constructs a **Vector4** as a copy of the given **Vector4**. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Vector4` **Vector4** **(** :ref:`Vector4i` from **)** Constructs a new **Vector4** from the given :ref:`Vector4i`. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Vector4` **Vector4** **(** :ref:`float` x, :ref:`float` y, :ref:`float` z, :ref:`float` w **)** Returns a **Vector4** with the given components. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Vector4_method_abs: .. rst-class:: classref-method :ref:`Vector4` **abs** **(** **)** |const| Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_ceil: .. rst-class:: classref-method :ref:`Vector4` **ceil** **(** **)** |const| Returns a new vector with all components rounded up (towards positive infinity). .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_clamp: .. rst-class:: classref-method :ref:`Vector4` **clamp** **(** :ref:`Vector4` min, :ref:`Vector4` max **)** |const| Returns a new vector with all components clamped between the components of ``min`` and ``max``, by running :ref:`@GlobalScope.clamp` on each component. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_cubic_interpolate: .. rst-class:: classref-method :ref:`Vector4` **cubic_interpolate** **(** :ref:`Vector4` b, :ref:`Vector4` pre_a, :ref:`Vector4` post_b, :ref:`float` weight **)** |const| Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_cubic_interpolate_in_time: .. rst-class:: classref-method :ref:`Vector4` **cubic_interpolate_in_time** **(** :ref:`Vector4` b, :ref:`Vector4` pre_a, :ref:`Vector4` post_b, :ref:`float` weight, :ref:`float` b_t, :ref:`float` pre_a_t, :ref:`float` post_b_t **)** |const| Performs a cubic interpolation between this vector and ``b`` using ``pre_a`` and ``post_b`` as handles, and returns the result at position ``weight``. ``weight`` is on the range of 0.0 to 1.0, representing the amount of interpolation. It can perform smoother interpolation than ``cubic_interpolate()`` by the time values. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_direction_to: .. rst-class:: classref-method :ref:`Vector4` **direction_to** **(** :ref:`Vector4` to **)** |const| Returns the normalized vector pointing from this vector to ``to``. This is equivalent to using ``(b - a).normalized()``. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_distance_squared_to: .. rst-class:: classref-method :ref:`float` **distance_squared_to** **(** :ref:`Vector4` to **)** |const| Returns the squared distance between this vector and ``to``. This method runs faster than :ref:`distance_to`, so prefer it if you need to compare vectors or need the squared distance for some formula. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_distance_to: .. rst-class:: classref-method :ref:`float` **distance_to** **(** :ref:`Vector4` to **)** |const| Returns the distance between this vector and ``to``. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_dot: .. rst-class:: classref-method :ref:`float` **dot** **(** :ref:`Vector4` with **)** |const| Returns the dot product of this vector and ``with``. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_floor: .. rst-class:: classref-method :ref:`Vector4` **floor** **(** **)** |const| Returns a new vector with all components rounded down (towards negative infinity). .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_inverse: .. rst-class:: classref-method :ref:`Vector4` **inverse** **(** **)** |const| Returns the inverse of the vector. This is the same as ``Vector4(1.0 / v.x, 1.0 / v.y, 1.0 / v.z, 1.0 / v.w)``. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_is_equal_approx: .. rst-class:: classref-method :ref:`bool` **is_equal_approx** **(** :ref:`Vector4` to **)** |const| Returns ``true`` if this vector and ``to`` are approximately equal, by running :ref:`@GlobalScope.is_equal_approx` on each component. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_is_finite: .. rst-class:: classref-method :ref:`bool` **is_finite** **(** **)** |const| Returns ``true`` if this vector is finite, by calling :ref:`@GlobalScope.is_finite` on each component. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_is_normalized: .. rst-class:: classref-method :ref:`bool` **is_normalized** **(** **)** |const| Returns ``true`` if the vector is normalized, i.e. its length is approximately equal to 1. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_is_zero_approx: .. rst-class:: classref-method :ref:`bool` **is_zero_approx** **(** **)** |const| Returns ``true`` if this vector's values are approximately zero, by running :ref:`@GlobalScope.is_zero_approx` on each component. This method is faster than using :ref:`is_equal_approx` with one value as a zero vector. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_length: .. rst-class:: classref-method :ref:`float` **length** **(** **)** |const| Returns the length (magnitude) of this vector. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_length_squared: .. rst-class:: classref-method :ref:`float` **length_squared** **(** **)** |const| Returns the squared length (squared magnitude) of this vector. This method runs faster than :ref:`length`, so prefer it if you need to compare vectors or need the squared distance for some formula. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_lerp: .. rst-class:: classref-method :ref:`Vector4` **lerp** **(** :ref:`Vector4` to, :ref:`float` weight **)** |const| Returns the result of the linear interpolation between this vector and ``to`` by amount ``weight``. ``weight`` is on the range of ``0.0`` to ``1.0``, representing the amount of interpolation. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_max_axis_index: .. rst-class:: classref-method :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_min_axis_index: .. rst-class:: classref-method :ref:`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`. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_normalized: .. rst-class:: classref-method :ref:`Vector4` **normalized** **(** **)** |const| Returns the result of scaling the vector to unit length. Equivalent to ``v / v.length()``. See also :ref:`is_normalized`. \ **Note:** This function may return incorrect values if the input vector length is near zero. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_posmod: .. rst-class:: classref-method :ref:`Vector4` **posmod** **(** :ref:`float` mod **)** |const| Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``mod``. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_posmodv: .. rst-class:: classref-method :ref:`Vector4` **posmodv** **(** :ref:`Vector4` modv **)** |const| Returns a vector composed of the :ref:`@GlobalScope.fposmod` of this vector's components and ``modv``'s components. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_round: .. rst-class:: classref-method :ref:`Vector4` **round** **(** **)** |const| Returns a new vector with all components rounded to the nearest integer, with halfway cases rounded away from zero. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_sign: .. rst-class:: classref-method :ref:`Vector4` **sign** **(** **)** |const| Returns a new vector with each component set to ``1.0`` if it's positive, ``-1.0`` if it's negative, and ``0.0`` if it's zero. The result is identical to calling :ref:`@GlobalScope.sign` on each component. .. rst-class:: classref-item-separator ---- .. _class_Vector4_method_snapped: .. rst-class:: classref-method :ref:`Vector4` **snapped** **(** :ref:`Vector4` step **)** |const| Returns a new vector with each component snapped to the nearest multiple of the corresponding component in ``step``. This can also be used to round the components to an arbitrary number of decimals. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Operator Descriptions --------------------- .. _class_Vector4_operator_neq_Vector4: .. rst-class:: classref-operator :ref:`bool` **operator !=** **(** :ref:`Vector4` right **)** Returns ``true`` if the vectors are not equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. \ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included. .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_mul_Projection: .. rst-class:: classref-operator :ref:`Vector4` **operator *** **(** :ref:`Projection` right **)** Inversely transforms (multiplies) the **Vector4** by the given :ref:`Projection` matrix. .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_mul_Vector4: .. rst-class:: classref-operator :ref:`Vector4` **operator *** **(** :ref:`Vector4` right **)** Multiplies each component of the **Vector4** by the components of the given **Vector4**. :: print(Vector4(10, 20, 30, 40) * Vector4(3, 4, 5, 6)) # Prints "(30, 80, 150, 240)" .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_mul_float: .. rst-class:: classref-operator :ref:`Vector4` **operator *** **(** :ref:`float` right **)** Multiplies each component of the **Vector4** by the given :ref:`float`. :: print(Vector4(10, 20, 30, 40) * 2) # Prints "(20, 40, 60, 80)" .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_mul_int: .. rst-class:: classref-operator :ref:`Vector4` **operator *** **(** :ref:`int` right **)** Multiplies each component of the **Vector4** by the given :ref:`int`. .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_sum_Vector4: .. rst-class:: classref-operator :ref:`Vector4` **operator +** **(** :ref:`Vector4` right **)** Adds each component of the **Vector4** by the components of the given **Vector4**. :: print(Vector4(10, 20, 30, 40) + Vector4(3, 4, 5, 6)) # Prints "(13, 24, 35, 46)" .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_dif_Vector4: .. rst-class:: classref-operator :ref:`Vector4` **operator -** **(** :ref:`Vector4` right **)** Subtracts each component of the **Vector4** by the components of the given **Vector4**. :: print(Vector4(10, 20, 30, 40) - Vector4(3, 4, 5, 6)) # Prints "(7, 16, 25, 34)" .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_div_Vector4: .. rst-class:: classref-operator :ref:`Vector4` **operator /** **(** :ref:`Vector4` right **)** Divides each component of the **Vector4** by the components of the given **Vector4**. :: print(Vector4(10, 20, 30, 40) / Vector4(2, 5, 3, 4)) # Prints "(5, 4, 10, 10)" .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_div_float: .. rst-class:: classref-operator :ref:`Vector4` **operator /** **(** :ref:`float` right **)** Divides each component of the **Vector4** by the given :ref:`float`. :: print(Vector4(10, 20, 30, 40) / 2 # Prints "(5, 10, 15, 20)" .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_div_int: .. rst-class:: classref-operator :ref:`Vector4` **operator /** **(** :ref:`int` right **)** Divides each component of the **Vector4** by the given :ref:`int`. .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_lt_Vector4: .. rst-class:: classref-operator :ref:`bool` **operator <** **(** :ref:`Vector4` right **)** Compares two **Vector4** 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. \ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included. .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_lte_Vector4: .. rst-class:: classref-operator :ref:`bool` **operator <=** **(** :ref:`Vector4` right **)** Compares two **Vector4** 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. \ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included. .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_eq_Vector4: .. rst-class:: classref-operator :ref:`bool` **operator ==** **(** :ref:`Vector4` right **)** Returns ``true`` if the vectors are exactly equal. \ **Note:** Due to floating-point precision errors, consider using :ref:`is_equal_approx` instead, which is more reliable. \ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included. .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_gt_Vector4: .. rst-class:: classref-operator :ref:`bool` **operator >** **(** :ref:`Vector4` right **)** Compares two **Vector4** 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. \ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included. .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_gte_Vector4: .. rst-class:: classref-operator :ref:`bool` **operator >=** **(** :ref:`Vector4` right **)** Compares two **Vector4** 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. \ **Note:** Vectors with :ref:`@GDScript.NAN` elements don't behave the same as other vectors. Therefore, the results from this operator may not be accurate if NaNs are included. .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_idx_int: .. rst-class:: classref-operator :ref:`float` **operator []** **(** :ref:`int` index **)** 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``. .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_unplus: .. rst-class:: classref-operator :ref:`Vector4` **operator unary+** **(** **)** Returns the same value as if the ``+`` was not there. Unary ``+`` does nothing, but sometimes it can make your code more readable. .. rst-class:: classref-item-separator ---- .. _class_Vector4_operator_unminus: .. rst-class:: classref-operator :ref:`Vector4` **operator unary-** **(** **)** Returns the negative value of the **Vector4**. This is the same as writing ``Vector4(-v.x, -v.y, -v.z, -v.w)``. This operation flips the direction of the vector while keeping the same magnitude. With floats, the number zero can be either positive or negative. .. |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.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |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.)`