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

• Math documentation index

• Vector math

• 3Blue1Brown Essence of Linear Algebra

Properties

int	x	0
int	y	0

Constructors

Vector2i	Vector2i ( )
Vector2i	Vector2i ( Vector2i from )
Vector2i	Vector2i ( Vector2 from )
Vector2i	Vector2i ( int x, int y )

Methods

Vector2i	abs ( ) const
float	aspect ( ) const
Vector2i	clamp ( Vector2i min, Vector2i max ) const
float	length ( ) const
int	length_squared ( ) const
int	max_axis_index ( ) const
int	min_axis_index ( ) const
Vector2i	sign ( ) const
Vector2i	snapped ( Vector2i step ) const

Operators

bool	operator != ( Vector2i right )
Vector2i	operator % ( Vector2i right )
Vector2i	operator % ( int right )
Vector2i	operator * ( Vector2i right )
Vector2	operator * ( float right )
Vector2i	operator * ( int right )
Vector2i	operator + ( Vector2i right )
Vector2i	operator - ( Vector2i right )
Vector2i	operator / ( Vector2i right )
Vector2	operator / ( float right )
Vector2i	operator / ( int right )
bool	operator < ( Vector2i right )
bool	operator <= ( Vector2i right )
bool	operator == ( Vector2i right )
bool	operator > ( Vector2i right )
bool	operator >= ( Vector2i right )
int	operator [] ( int