: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/Vector2i.xml. .. _class_Vector2i: Vector2i ======== A 2D vector using integer coordinates. .. rst-class:: classref-introduction-group Description ----------- A 2-element structure that can be used to represent 2D grid coordinates or any other pair of integers. It uses integer coordinates and is therefore preferable to :ref:`Vector2` when exact precision is required. Note that the values are limited to 32 bits, and unlike :ref:`Vector2` this cannot be configured with an engine build option. Use :ref:`int` or :ref:`PackedInt64Array` if 64-bit values are needed. \ **Note:** In a boolean context, a Vector2i will evaluate to ``false`` if it's equal to ``Vector2i(0, 0)``. Otherwise, a Vector2i will always evaluate to ``true``. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Math documentation index <../tutorials/math/index>` - :doc:`Vector math <../tutorials/math/vector_math>` - `3Blue1Brown Essence of Linear Algebra `__ .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------+-------------------------------------+-------+ | :ref:`int` | :ref:`x` | ``0`` | +-----------------------+-------------------------------------+-------+ | :ref:`int` | :ref:`y` | ``0`` | +-----------------------+-------------------------------------+-------+ .. rst-class:: classref-reftable-group Constructors ------------ .. table:: :widths: auto +---------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`Vector2i` **(** **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`Vector2i` **(** :ref:`Vector2i` from **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`Vector2i` **(** :ref:`Vector2` from **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`Vector2i` **(** :ref:`int` x, :ref:`int` y **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`abs` **(** **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`aspect` **(** **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`clamp` **(** :ref:`Vector2i` min, :ref:`Vector2i` max **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`float` | :ref:`length` **(** **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`length_squared` **(** **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`max_axis_index` **(** **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`min_axis_index` **(** **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`sign` **(** **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`snapped` **(** :ref:`Vector2i` step **)** |const| | +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Operators --------- .. table:: :widths: auto +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator !=` **(** :ref:`Vector2i` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`operator %` **(** :ref:`Vector2i` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`operator %` **(** :ref:`int` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`operator *` **(** :ref:`Vector2i` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`operator *` **(** :ref:`float` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`operator *` **(** :ref:`int` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`operator +` **(** :ref:`Vector2i` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`operator -` **(** :ref:`Vector2i` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`operator /` **(** :ref:`Vector2i` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`operator /` **(** :ref:`float` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`operator /` **(** :ref:`int` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator \<` **(** :ref:`Vector2i` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator \<=` **(** :ref:`Vector2i` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator ==` **(** :ref:`Vector2i` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator >` **(** :ref:`Vector2i` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`operator >=` **(** :ref:`Vector2i` right **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`operator []` **(** :ref:`int` index **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`operator unary+` **(** **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2i` | :ref:`operator unary-` **(** **)** | +---------------------------------+-------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_Vector2i_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_Vector2i_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_Vector2i_constant_ZERO: .. rst-class:: classref-constant **ZERO** = ``Vector2i(0, 0)`` Zero vector, a vector with all components set to ``0``. .. _class_Vector2i_constant_ONE: .. rst-class:: classref-constant **ONE** = ``Vector2i(1, 1)`` One vector, a vector with all components set to ``1``. .. _class_Vector2i_constant_LEFT: .. rst-class:: classref-constant **LEFT** = ``Vector2i(-1, 0)`` Left unit vector. Represents the direction of left. .. _class_Vector2i_constant_RIGHT: .. rst-class:: classref-constant **RIGHT** = ``Vector2i(1, 0)`` Right unit vector. Represents the direction of right. .. _class_Vector2i_constant_UP: .. rst-class:: classref-constant **UP** = ``Vector2i(0, -1)`` Up unit vector. Y is down in 2D, so this vector points -Y. .. _class_Vector2i_constant_DOWN: .. rst-class:: classref-constant **DOWN** = ``Vector2i(0, 1)`` Down unit vector. Y is down in 2D, so this vector points +Y. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_Vector2i_property_x: .. rst-class:: classref-property :ref:`int` **x** = ``0`` The vector's X component. Also accessible by using the index position ``[0]``. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_property_y: .. rst-class:: classref-property :ref:`int` **y** = ``0`` The vector's Y component. Also accessible by using the index position ``[1]``. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constructor Descriptions ------------------------ .. _class_Vector2i_constructor_Vector2i: .. rst-class:: classref-constructor :ref:`Vector2i` **Vector2i** **(** **)** Constructs a default-initialized **Vector2i** with all components set to ``0``. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Vector2i` **Vector2i** **(** :ref:`Vector2i` from **)** Constructs a **Vector2i** as a copy of the given **Vector2i**. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Vector2i` **Vector2i** **(** :ref:`Vector2` from **)** Constructs a new **Vector2i** from the given :ref:`Vector2` by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of :ref:`Vector2.ceil`, :ref:`Vector2.floor` or :ref:`Vector2.round` to this constructor instead. .. rst-class:: classref-item-separator ---- .. rst-class:: classref-constructor :ref:`Vector2i` **Vector2i** **(** :ref:`int` x, :ref:`int` y **)** Constructs a new **Vector2i** from the given ``x`` and ``y``. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_Vector2i_method_abs: .. rst-class:: classref-method :ref:`Vector2i` **abs** **(** **)** |const| Returns a new vector with all components in absolute values (i.e. positive). .. rst-class:: classref-item-separator ---- .. _class_Vector2i_method_aspect: .. rst-class:: classref-method :ref:`float` **aspect** **(** **)** |const| Returns the aspect ratio of this vector, the ratio of :ref:`x` to :ref:`y`. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_method_clamp: .. rst-class:: classref-method :ref:`Vector2i` **clamp** **(** :ref:`Vector2i` min, :ref:`Vector2i` 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_Vector2i_method_length: .. rst-class:: classref-method :ref:`float` **length** **(** **)** |const| Returns the length (magnitude) of this vector. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_method_length_squared: .. rst-class:: classref-method :ref:`int` **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_Vector2i_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_Vector2i_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_Y`. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_method_sign: .. rst-class:: classref-method :ref:`Vector2i` **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` on each component. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_method_snapped: .. rst-class:: classref-method :ref:`Vector2i` **snapped** **(** :ref:`Vector2i` step **)** |const| Returns a new vector with each component snapped to the closest multiple of the corresponding component in ``step``. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Operator Descriptions --------------------- .. _class_Vector2i_operator_neq_Vector2i: .. rst-class:: classref-operator :ref:`bool` **operator !=** **(** :ref:`Vector2i` right **)** Returns ``true`` if the vectors are not equal. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_mod_Vector2i: .. rst-class:: classref-operator :ref:`Vector2i` **operator %** **(** :ref:`Vector2i` right **)** Gets the remainder of each component of the **Vector2i** with the components of the given **Vector2i**. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using :ref:`@GlobalScope.posmod` instead if you want to handle negative numbers. :: print(Vector2i(10, -20) % Vector2i(7, 8)) # Prints "(3, -4)" .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_mod_int: .. rst-class:: classref-operator :ref:`Vector2i` **operator %** **(** :ref:`int` right **)** Gets the remainder of each component of the **Vector2i** with the given :ref:`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` instead if you want to handle negative numbers. :: print(Vector2i(10, -20) % 7) # Prints "(3, -6)" .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_mul_Vector2i: .. rst-class:: classref-operator :ref:`Vector2i` **operator *** **(** :ref:`Vector2i` right **)** Multiplies each component of the **Vector2i** by the components of the given **Vector2i**. :: print(Vector2i(10, 20) * Vector2i(3, 4)) # Prints "(30, 80)" .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_mul_float: .. rst-class:: classref-operator :ref:`Vector2` **operator *** **(** :ref:`float` right **)** Multiplies each component of the **Vector2i** by the given :ref:`float`. Returns a :ref:`Vector2`. :: print(Vector2i(10, 15) * 0.9) # Prints "(9, 13.5)" .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_mul_int: .. rst-class:: classref-operator :ref:`Vector2i` **operator *** **(** :ref:`int` right **)** Multiplies each component of the **Vector2i** by the given :ref:`int`. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_sum_Vector2i: .. rst-class:: classref-operator :ref:`Vector2i` **operator +** **(** :ref:`Vector2i` right **)** Adds each component of the **Vector2i** by the components of the given **Vector2i**. :: print(Vector2i(10, 20) + Vector2i(3, 4)) # Prints "(13, 24)" .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_dif_Vector2i: .. rst-class:: classref-operator :ref:`Vector2i` **operator -** **(** :ref:`Vector2i` right **)** Subtracts each component of the **Vector2i** by the components of the given **Vector2i**. :: print(Vector2i(10, 20) - Vector2i(3, 4)) # Prints "(7, 16)" .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_div_Vector2i: .. rst-class:: classref-operator :ref:`Vector2i` **operator /** **(** :ref:`Vector2i` right **)** Divides each component of the **Vector2i** by the components of the given **Vector2i**. :: print(Vector2i(10, 20) / Vector2i(2, 5)) # Prints "(5, 4)" .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_div_float: .. rst-class:: classref-operator :ref:`Vector2` **operator /** **(** :ref:`float` right **)** Divides each component of the **Vector2i** by the given :ref:`float`. Returns a :ref:`Vector2`. :: print(Vector2i(10, 20) / 2.9) # Prints "(5, 10)" .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_div_int: .. rst-class:: classref-operator :ref:`Vector2i` **operator /** **(** :ref:`int` right **)** Divides each component of the **Vector2i** by the given :ref:`int`. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_lt_Vector2i: .. rst-class:: classref-operator :ref:`bool` **operator <** **(** :ref:`Vector2i` right **)** Compares two **Vector2i** 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. This operator is useful for sorting vectors. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_lte_Vector2i: .. rst-class:: classref-operator :ref:`bool` **operator <=** **(** :ref:`Vector2i` right **)** Compares two **Vector2i** 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. This operator is useful for sorting vectors. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_eq_Vector2i: .. rst-class:: classref-operator :ref:`bool` **operator ==** **(** :ref:`Vector2i` right **)** Returns ``true`` if the vectors are equal. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_gt_Vector2i: .. rst-class:: classref-operator :ref:`bool` **operator >** **(** :ref:`Vector2i` right **)** Compares two **Vector2i** 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. This operator is useful for sorting vectors. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_gte_Vector2i: .. rst-class:: classref-operator :ref:`bool` **operator >=** **(** :ref:`Vector2i` right **)** Compares two **Vector2i** 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. This operator is useful for sorting vectors. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_idx_int: .. rst-class:: classref-operator :ref:`int` **operator []** **(** :ref:`int` index **)** Access vector components using their ``index``. ``v[0]`` is equivalent to ``v.x``, and ``v[1]`` is equivalent to ``v.y``. .. rst-class:: classref-item-separator ---- .. _class_Vector2i_operator_unplus: .. rst-class:: classref-operator :ref:`Vector2i` **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_Vector2i_operator_unminus: .. rst-class:: classref-operator :ref:`Vector2i` **operator unary-** **(** **)** Returns the negative value of the **Vector2i**. This is the same as writing ``Vector2i(-v.x, -v.y)``. This operation flips the direction of the vector while keeping the same magnitude. .. |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.)`