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.
Constructs a default-initialized Vector3i with all components set to 0
.
Constructs a Vector3i as a copy of the given Vector3i.
Constructs a new Vector3i from the given Vector3 by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of Vector3.ceil, Vector3.floor or Vector3.round to this constructor instead.
Returns a Vector3i with the given components.
Returns true
if the vectors are not equal.
Gets the remainder of each component of the Vector3i with the components of the given Vector3i. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using @GlobalScope.posmod instead if you want to handle negative numbers.
Gets the remainder of each component of the Vector3i with the given int. This operation uses truncated division, which is often not desired as it does not work well with negative numbers. Consider using @GlobalScope.posmod instead if you want to handle negative numbers.
Multiplies each component of the Vector3i by the components of the given Vector3i.
Multiplies each component of the Vector3i by the given float. Returns a Vector3.
Multiplies each component of the Vector3i by the given int.
Adds each component of the Vector3i by the components of the given Vector3i.
Subtracts each component of the Vector3i by the components of the given Vector3i.
Divides each component of the Vector3i by the components of the given Vector3i.
Divides each component of the Vector3i by the given float. Returns a Vector3.
Divides each component of the Vector3i by the given int.
Compares two Vector3i 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, and then with the Z values. This operator is useful for sorting vectors.
Compares two Vector3i 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, and then with the Z values. This operator is useful for sorting vectors.
Returns true
if the vectors are equal.
Compares two Vector3i 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, and then with the Z values. This operator is useful for sorting vectors.
Compares two Vector3i 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, and then with the Z values. This operator is useful for sorting vectors.
Access vector components using their index
. v[0]
is equivalent to v.x
, v[1]
is equivalent to v.y
, and v[2]
is equivalent to v.z
.
Returns the same value as if the +
was not there. Unary +
does nothing, but sometimes it can make your code more readable.
Returns the negative value of the Vector3i. This is the same as writing Vector3i(-v.x, -v.y, -v.z)
. This operation flips the direction of the vector while keeping the same magnitude.
The vector's X component. Also accessible by using the index position [0]
.
The vector's Y component. Also accessible by using the index position [1]
.
The vector's Z component. Also accessible by using the index position [2]
.
Returns a new vector with all components in absolute values (i.e. positive).
Returns a new vector with all components clamped between the components of min
and max
, by running @GlobalScope.clamp on each component.
Returns the squared 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 distance between this vector and to
.
Returns the length (magnitude) of this vector.
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 axis of the vector's highest value. See AXIS_*
constants. If all components are equal, this method returns AXIS_X.
Returns the axis of the vector's lowest value. See AXIS_*
constants. If all components are equal, this method returns AXIS_Z.
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 @GlobalScope.sign on each component.
Returns a new vector with each component snapped to the closest multiple of the corresponding component in step
.