Index · Vector2i

Vector2i

A 2D vector using integer coordinates.

Class 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.

Properties

var x: int = 0

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

var y: int = 0

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

Methods

func abs() -> Vector2i

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

func aspect() -> float

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

func clamp(min: Vector2i, max: Vector2i) -> Vector2i

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

func clampi(min: int, max: int) -> Vector2i

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

func distance_squared_to(to: Vector2i) -> int

Returns the squared Euclidean 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.

func distance_to(to: Vector2i) -> float

Returns the Euclidean distance between this vector and to.

func length() -> float

Returns the length (magnitude) of this vector.

func length_squared() -> int

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.

func max(with: Vector2i) -> Vector2i

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

func max_axis_index() -> int

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

func maxi(with: int) -> Vector2i

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

func min(with: Vector2i) -> Vector2i

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

func min_axis_index() -> int

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

func mini(with: int) -> Vector2i

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

func sign() -> Vector2i

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 sign() on each component.

func snapped(step: Vector2i) -> Vector2i

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

func snappedi(step: int) -> Vector2i

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

Enums & Constants

enum Axis
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().

const ZERO = Vector2i(0, 0)

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

const ONE = Vector2i(1, 1)

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

const 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.

const 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.

const LEFT = Vector2i(-1, 0)

Left unit vector. Represents the direction of left.

const RIGHT = Vector2i(1, 0)

Right unit vector. Represents the direction of right.

const UP = Vector2i(0, -1)

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

const DOWN = Vector2i(0, 1)

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