:github_url: hide

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Vector3i.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Vector3i:

Vector3i
========

Vector used for 3D math using integer coordinates.

Description
-----------

3-element structure that can be used to represent positions in 3D space or any other pair of numeric values.

It uses integer coordinates.

Tutorials
---------

- :doc:`../tutorials/math/index`

Methods
-------

+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3i<class_Vector3i>` | :ref:`Vector3i<class_Vector3i_method_Vector3i>` **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)** |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Vector3i<class_Vector3i>` | :ref:`Vector3i<class_Vector3i_method_Vector3i>` **(** :ref:`Vector3<class_Vector3>` from **)**                                        |
+---------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+

Constants
---------

.. _class_Vector3i_constant_AXIS_X:

.. _class_Vector3i_constant_AXIS_Y:

.. _class_Vector3i_constant_AXIS_Z:

.. _class_Vector3i_constant_ZERO:

.. _class_Vector3i_constant_ONE:

.. _class_Vector3i_constant_LEFT:

.. _class_Vector3i_constant_RIGHT:

.. _class_Vector3i_constant_UP:

.. _class_Vector3i_constant_DOWN:

.. _class_Vector3i_constant_FORWARD:

.. _class_Vector3i_constant_BACK:

- **AXIS_X** = **0** --- Enumerated value for the X axis.

- **AXIS_Y** = **1** --- Enumerated value for the Y axis.

- **AXIS_Z** = **2** --- Enumerated value for the Z axis.

- **ZERO** = **Vector3i( 0, 0, 0 )** --- Zero vector.

- **ONE** = **Vector3i( 1, 1, 1 )** --- One vector.

- **LEFT** = **Vector3i( -1, 0, 0 )** --- Left unit vector.

- **RIGHT** = **Vector3i( 1, 0, 0 )** --- Right unit vector.

- **UP** = **Vector3i( 0, 1, 0 )** --- Up unit vector.

- **DOWN** = **Vector3i( 0, -1, 0 )** --- Down unit vector.

- **FORWARD** = **Vector3i( 0, 0, -1 )** --- Forward unit vector.

- **BACK** = **Vector3i( 0, 0, 1 )** --- Back unit vector.

Method Descriptions
-------------------

.. _class_Vector3i_method_Vector3i:

- :ref:`Vector3i<class_Vector3i>` **Vector3i** **(** :ref:`int<class_int>` x, :ref:`int<class_int>` y, :ref:`int<class_int>` z **)**

Returns a ``Vector3i`` with the given components.

----

- :ref:`Vector3i<class_Vector3i>` **Vector3i** **(** :ref:`Vector3<class_Vector3>` from **)**

Constructs a new ``Vector3i`` from :ref:`Vector3<class_Vector3>`. The floating point coordinates will be truncated.