Attention: Here be dragons
This is the
(unstable) version of this documentation, which may document features
not available in or compatible with released stable versions of Godot.
A 2D vector using integer coordinates.
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 Vector2 when exact precision is required. Note that the values are limited to 32 bits, and unlike Vector2 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 Vector2i will evaluate to
false if it's equal to
Vector2i(0, 0). Otherwise, a Vector2i will always evaluate to
Vector2i ( )
abs ( ) const
aspect ( ) const
length ( ) const
length_squared ( ) const
max_axis_index ( ) const
min_axis_index ( ) const
sign ( ) const
operator unary+ ( )
operator unary- ( )
Zero vector, a vector with all components set to
One vector, a vector with all components set to
Min vector, a vector with all components equal to
INT32_MIN. Can be used as a negative integer equivalent of Vector2.INF.
Max vector, a vector with all components equal to
INT32_MAX. Can be used as an integer equivalent of Vector2.INF.
Left unit vector. Represents the direction of left.
Right unit vector. Represents the direction of right.
Up unit vector. Y is down in 2D, so this vector points -Y.
Down unit vector. Y is down in 2D, so this vector points +Y.
int x =
The vector's X component. Also accessible by using the index position
int y =
The vector's Y component. Also accessible by using the index position
Vector2i Vector2i ( )
Constructs a default-initialized Vector2i with all components set to
Constructs a Vector2i as a copy of the given Vector2i.
Constructs a new Vector2i from the given Vector2 by truncating components' fractional parts (rounding towards zero). For a different behavior consider passing the result of Vector2.ceil, Vector2.floor or Vector2.round to this constructor instead.
Constructs a new Vector2i from the given
Vector2i abs ( ) const
Returns a new vector with all components in absolute values (i.e. positive).
float aspect ( ) const
Returns a new vector with all components clamped between the components of
max, by running @GlobalScope.clamp on each component.
float length ( ) const
Returns the length (magnitude) of this vector.
int length_squared ( ) const
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.
int max_axis_index ( ) const
Returns the axis of the vector's highest value. See