A 3D vector using integer coordinates.
A 3-element structure that can be used to represent 3D grid coordinates or any other triplet of integers.
It uses integer coordinates and is therefore preferable to Vector3 when exact precision is required. Note that the values are limited to 32 bits, and unlike Vector3 this cannot be configured with an engine build option. Use int or PackedInt64Array if 64-bit values are needed.
Note: In a boolean context, a Vector3i will evaluate to false if it's equal to Vector3i(0, 0, 0). Otherwise, a Vector3i will always evaluate to true.
Returns a new vector with all components clamped between the components of min and max, by running clamp() on each component.
Returns a new vector with all components clamped between min and max, by running clamp() on each component.
Returns the squared Euclidean distance between this vector and to.
This method runs faster than distance_to(), so prefer it if you need to compare vectors or need the squared distance for some formula.
Returns the squared length (squared magnitude) of this vector.
This method runs faster than length(), so prefer it if you need to compare vectors or need the squared distance for some formula.
Returns the component-wise maximum of this and with, equivalent to Vector3i(maxi(x, with.x), maxi(y, with.y), maxi(z, with.z)).
Returns the axis of the vector's highest value. See AXIS_* constants. If all components are equal, this method returns AXIS_X.
Returns the component-wise maximum of this and with, equivalent to Vector3i(maxi(x, with), maxi(y, with), maxi(z, with)).
Returns the component-wise minimum of this and with, equivalent to Vector3i(mini(x, with.x), mini(y, with.y), mini(z, with.z)).
Returns the axis of the vector's lowest value. See AXIS_* constants. If all components are equal, this method returns AXIS_Z.
Returns the component-wise minimum of this and with, equivalent to Vector3i(mini(x, with), mini(y, with), mini(z, with)).
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 sign() on each component.
Returns a new vector with each component snapped to the closest multiple of the corresponding component in step.
AXIS_X = 0Enumerated value for the X axis. Returned by max_axis_index() and min_axis_index().
AXIS_Y = 1Enumerated value for the Y axis. Returned by max_axis_index() and min_axis_index().
AXIS_Z = 2Enumerated value for the Z axis. Returned by max_axis_index() and min_axis_index().
Min vector, a vector with all components equal to INT32_MIN. Can be used as a negative integer equivalent of Vector3.INF.
Max vector, a vector with all components equal to INT32_MAX. Can be used as an integer equivalent of Vector3.INF.
Left unit vector. Represents the local direction of left, and the global direction of west.
Right unit vector. Represents the local direction of right, and the global direction of east.