Up to date
This page is up to date for Godot 4.2.
If you still find outdated information, please open an issue.
Vector2i¶
A 2D vector using integer coordinates.
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 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 true.
Tutorials¶
Properties¶
|
||
|
Constructors¶
Vector2i ( ) |
|
Methods¶
abs ( ) const |
|
aspect ( ) const |
|
length ( ) const |
|
length_squared ( ) const |
|
max_axis_index ( ) const |
|
min_axis_index ( ) const |
|
sign ( ) const |
|
Operators¶
operator != ( Vector2i right ) |
|
operator % ( Vector2i right ) |
|
operator % ( int right ) |
|
operator * ( Vector2i right ) |
|
operator * ( float right ) |
|
operator * ( int right ) |
|
operator + ( Vector2i right ) |
|
operator - ( Vector2i right ) |
|
operator / ( Vector2i right ) |
|
operator / ( float right ) |
|
operator / ( int right ) |
|
operator < ( Vector2i right ) |
|
operator <= ( Vector2i right ) |
|
operator == ( Vector2i right ) |
|
operator > ( Vector2i right ) |
|
operator >= ( Vector2i right ) |
|
operator [] ( int index ) |
|
operator unary+ ( ) |
|
operator unary- ( ) |
Constants¶
AXIS_X = 0
Enumerated value for the X axis. Returned by max_axis_index and min_axis_index.
AXIS_Y = 1
Enumerated value for the Y axis. Returned by max_axis_index and min_axis_index.
ZERO = Vector2i(0, 0)
Zero vector, a vector with all components set to 0.
ONE = Vector2i(1, 1)
One vector, a vector with all components set to 1.
MIN = Vector2i(-2147483648, -2147483648)
Min vector, a vector with all components equal to INT32_MIN. Can be used as a negative integer equivalent of Vector2.INF.
MAX = Vector2i(2147483647, 2147483647)
Max vector, a vector with all components equal to INT32_MAX. Can be used as an integer equivalent of Vector2.INF.
LEFT = Vector2i(-1, 0)
Left unit vector. Represents the direction of left.
RIGHT = Vector2i(1, 0)
Right unit vector. Represents the direction of right.
UP = Vector2i(0, -1)
Up unit vector. Y is down in 2D, so this vector points -Y.
DOWN = Vector2i(0, 1)
Down unit vector. Y is down in 2D, so this vector points +Y.
Property Descriptions¶
int x = 0
The vector's X component. Also accessible by using the index position [0].
int y = 0
The vector's Y component. Also accessible by using the index position [1].
Constructor Descriptions¶
Vector2i Vector2i ( )
Constructs a default-initialized Vector2i with all components set to 0.
Vector2i Vector2i ( Vector2i from )
Constructs a Vector2i as a copy of the given Vector2i.
Vector2i Vector2i ( Vector2 from )
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.
Vector2i Vector2i ( int x, int y )
Constructs a new Vector2i from the given x and y.
Method Descriptions¶
Vector2i abs ( ) const
Returns a new vector with all components in absolute values (i.e. positive).
float aspect ( ) const
Returns the aspect ratio of this vector, the ratio of x to y.
Vector2i clamp ( Vector2i min, Vector2i max ) const
Returns a new vector with all components clamped between the components of min and 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 ( )