Class Vector2i

A 2D vector using integer coordinates.

Vector2i

Remarks

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.

See Also

Math documentation index

Vector math

3Blue1Brown Essence of Linear Algebra

Constructors

Vector2i

Constructs a default-initialized Vector2i with all components set to 0.

Vector2i Vector2i

Vector2i(Vector2i)

Constructs a Vector2i as a copy of the given Vector2i.

Vector2i Vector2i(Vector2i from)

Parameters

from Vector2i

Vector2i(Vector2)

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 ceil, floor or round to this constructor instead.

Vector2i Vector2i(Vector2 from)

Parameters

from Vector2

Vector2i(int, int)

Constructs a new Vector2i from the given x and y.

Vector2i Vector2i(int x, int y)

Parameters

x int

y int

Fields

ZERO

Zero vector, a vector with all components set to 0.

const ZERO = Vector2i(0, 0)

ONE

One vector, a vector with all components set to 1.

const ONE = Vector2i(1, 1)

MIN

Min vector, a vector with all components equal to INT32_MIN. Can be used as a negative integer equivalent of INF.

const MIN = Vector2i(-2147483648, -2147483648)

MAX

Max vector, a vector with all components equal to INT32_MAX. Can be used as an integer equivalent of INF.

const MAX = Vector2i(2147483647, 2147483647)

LEFT

Left unit vector. Represents the direction of left.

const LEFT = Vector2i(-1, 0)

RIGHT

Right unit vector. Represents the direction of right.

const RIGHT = Vector2i(1, 0)

UP

Up unit vector. Y is down in 2D, so this vector points -Y.

const UP = Vector2i(0, -1)

DOWN

Down unit vector. Y is down in 2D, so this vector points +Y.

const DOWN = Vector2i(0, 1)

Properties

x

The vector's X component. Also accessible by using the index position [0].

var x : int = 0

Property Value

int

y

The vector's Y component. Also accessible by using the index position [1].

var y : int = 0

Property Value

int

Methods

abs

Qualifiers: const

Returns a new vector with all components in absolute values (i.e. positive).

Vector2i abs

aspect

Qualifiers: const

Returns the aspect ratio of this vector, the ratio of x to y.

float aspect

clamp(Vector2i, Vector2i)

Qualifiers: const

Returns a new vector with all components clamped between the components of min and max, by running @GlobalScope.clamp on each component.

Vector2i clamp(Vector2i min, Vector2i max)

Parameters

min Vector2i

max Vector2i

clampi(int, int)

Qualifiers: const

Returns a new vector with all components clamped between min and max, by running @GlobalScope.clamp on each component.

Vector2i clampi(int min, int max)

Parameters

min int

max int

distance_squared_to(Vector2i)

Qualifiers: const

Returns the squared distance between this vector and to.

This method runs faster than Vector2i.distance_to, so prefer it if you need to compare vectors or need the squared distance for some formula.

int distance_squared_to(Vector2i to)

Parameters

to Vector2i

distance_to(Vector2i)

Qualifiers: const

Returns the distance between this vector and to.

float distance_to(Vector2i to)

Parameters

to Vector2i

length

Qualifiers: const

Returns the length (magnitude) of this vector.

float length

length_squared

Qualifiers: 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 length_squared

max(Vector2i)

Qualifiers: const

Returns the component-wise maximum of this and with, equivalent to Vector2i(maxi(x, with.x), maxi(y, with.y)).

Vector2i max(Vector2i with)

Parameters

with Vector2i

max_axis_index

Qualifiers: const

Returns the axis of the vector's highest value. See AXIS_* constants. If all components are equal, this method returns Vector2i.AXIS_X.

int max_axis_index

maxi(int)

Qualifiers: const

Returns the component-wise maximum of this and with, equivalent to Vector2i(maxi(x, with), maxi(y, with)).

Vector2i maxi(int with)

Parameters

with int

min(Vector2i)

Qualifiers: const

Returns the component-wise minimum of this and with, equivalent to Vector2i(mini(x, with.x), mini(y, with.y)).

Vector2i min(Vector2i with)

Parameters

with Vector2i

min_axis_index

Qualifiers: const

Returns the axis of the vector's lowest value. See AXIS_* constants. If all components are equal, this method returns Vector2i.AXIS_Y.

int min_axis_index

mini(int)

Qualifiers: const

Returns the component-wise minimum of this and with, equivalent to Vector2i(mini(x, with), mini(y, with)).

Vector2i mini(int with)

Parameters

with int

sign

Qualifiers: const

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.

Vector2i sign

snapped(Vector2i)

Qualifiers: const

Returns a new vector with each component snapped to the closest multiple of the corresponding component in step.

Vector2i snapped(Vector2i step)

Parameters

step Vector2i

snappedi(int)

Qualifiers: const

Returns a new vector with each component snapped to the closest multiple of step.

Vector2i snappedi(int step)

Parameters

step int

Operators

!= (Vector2i)

Returns true if the vectors are not equal.

bool != (Vector2i right)

Parameters

right Vector2i

% (Vector2i)

Gets the remainder of each component of the Vector2i with the components of the given Vector2i. 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.

print(Vector2i(10, -20) % Vector2i(7, 8)) # Prints (3, -4)

Vector2i % (Vector2i right)

Parameters

right Vector2i

% (int)

Gets the remainder of each component of the Vector2i 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.

print(Vector2i(10, -20) % 7) # Prints (3, -6)

Vector2i % (int right)

Parameters

right int

* (Vector2i)

Multiplies each component of the Vector2i by the components of the given Vector2i.

print(Vector2i(10, 20) * Vector2i(3, 4)) # Prints (30, 80)

Vector2i * (Vector2i right)

Parameters

right Vector2i

* (float)

Multiplies each component of the Vector2i by the given float. Returns a Vector2.

print(Vector2i(10, 15) * 0.9) # Prints (9.0, 13.5)

Vector2 * (float right)

Parameters

right float

* (int)

Multiplies each component of the Vector2i by the given int.

Vector2i * (int right)

Parameters

right int

+ (Vector2i)

Adds each component of the Vector2i by the components of the given Vector2i.

print(Vector2i(10, 20) + Vector2i(3, 4)) # Prints (13, 24)

Vector2i + (Vector2i right)

Parameters

right Vector2i

- (Vector2i)

Subtracts each component of the Vector2i by the components of the given Vector2i.

print(Vector2i(10, 20) - Vector2i(3, 4)) # Prints (7, 16)

Vector2i - (Vector2i right)

Parameters

right Vector2i

/ (Vector2i)

Divides each component of the Vector2i by the components of the given Vector2i.

print(Vector2i(10, 20) / Vector2i(2, 5)) # Prints (5, 4)

Vector2i / (Vector2i right)

Parameters

right Vector2i

/ (float)

Divides each component of the Vector2i by the given float. Returns a Vector2.

print(Vector2i(10, 20) / 2.9) # Prints (5.0, 10.0)

Vector2 / (float right)

Parameters

right float

/ (int)

Divides each component of the Vector2i by the given int.

Vector2i / (int right)

Parameters

right int

< (Vector2i)

Compares two Vector2i 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. This operator is useful for sorting vectors.

bool < (Vector2i right)

Parameters

right Vector2i

<= (Vector2i)

Compares two Vector2i 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. This operator is useful for sorting vectors.

bool <= (Vector2i right)

Parameters

right Vector2i

== (Vector2i)

Returns true if the vectors are equal.

bool == (Vector2i right)

Parameters

right Vector2i

> (Vector2i)

Compares two Vector2i 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. This operator is useful for sorting vectors.

bool > (Vector2i right)

Parameters

right Vector2i

>= (Vector2i)

Compares two Vector2i 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. This operator is useful for sorting vectors.

bool >= (Vector2i right)

Parameters

right Vector2i

[] (int)

Access vector components using their index. v[0] is equivalent to v.x, and v[1] is equivalent to v.y.

int [] (int index)

Parameters

index int

unary+

Returns the same value as if the + was not there. Unary + does nothing, but sometimes it can make your code more readable.

Vector2i unary+

unary-

Returns the negative value of the Vector2i. This is the same as writing Vector2i(-v.x, -v.y). This operation flips the direction of the vector while keeping the same magnitude.

Vector2i unary-