Table of Contents

Class Vector4i

A 4D vector using integer coordinates.

Vector4i

Remarks

A 4-element structure that can be used to represent 4D grid coordinates or any other quadruplet of integers.

It uses integer coordinates and is therefore preferable to Vector4 when exact precision is required. Note that the values are limited to 32 bits, and unlike Vector4 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 Vector4i will evaluate to false if it's equal to Vector4i(0, 0, 0, 0). Otherwise, a Vector4i will always evaluate to true.

Constructors

Vector4i

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

Vector4i Vector4i

Vector4i(Vector4i)

Constructs a Vector4i as a copy of the given Vector4i.

Vector4i Vector4i(Vector4i from)

Parameters

from Vector4i

Vector4i(Vector4)

Constructs a new Vector4i from the given Vector4 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.

Vector4i Vector4i(Vector4 from)

Parameters

from Vector4

Vector4i(int, int, int, int)

Returns a Vector4i with the given components.

Vector4i Vector4i(int x, int y, int z, int w)

Parameters

x int
y int
z int
w int

Fields

ZERO

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

const ZERO = Vector4i(0, 0, 0, 0)

ONE

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

const ONE = Vector4i(1, 1, 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 = Vector4i(-2147483648, -2147483648, -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 = Vector4i(2147483647, 2147483647, 2147483647, 2147483647)

Properties

w

The vector's W component. Also accessible by using the index position [3].

var w : int = 0

Property Value

int

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

z

The vector's Z component. Also accessible by using the index position [2].

var z : int = 0

Property Value

int

Methods

abs

Qualifiers: const

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

Vector4i abs

clamp(Vector4i, Vector4i)

Qualifiers: const

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

Vector4i clamp(Vector4i min, Vector4i max)

Parameters

min Vector4i
max Vector4i

clampi(int, int)

Qualifiers: const

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

Vector4i clampi(int min, int max)

Parameters

min int
max int

distance_squared_to(Vector4i)

Qualifiers: const

Returns the squared distance between this vector and to.

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

int distance_squared_to(Vector4i to)

Parameters

to Vector4i

distance_to(Vector4i)

Qualifiers: const

Returns the distance between this vector and to.

float distance_to(Vector4i to)

Parameters

to Vector4i

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(Vector4i)

Qualifiers: const

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

Vector4i max(Vector4i with)

Parameters

with Vector4i

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 Vector4i.AXIS_X.

int max_axis_index

maxi(int)

Qualifiers: const

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

Vector4i maxi(int with)

Parameters

with int

min(Vector4i)

Qualifiers: const

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

Vector4i min(Vector4i with)

Parameters

with Vector4i

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 Vector4i.AXIS_W.

int min_axis_index

mini(int)

Qualifiers: const

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

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

Vector4i sign

snapped(Vector4i)

Qualifiers: const

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

Vector4i snapped(Vector4i step)

Parameters

step Vector4i

snappedi(int)

Qualifiers: const

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

Vector4i snappedi(int step)

Parameters

step int

Operators

!= (Vector4i)

Returns true if the vectors are not equal.

bool != (Vector4i right)

Parameters

right Vector4i

% (Vector4i)

Gets the remainder of each component of the Vector4i with the components of the given Vector4i. 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(Vector4i(10, -20, 30, -40) % Vector4i(7, 8, 9, 10)) # Prints (3, -4, 3, 0)


Vector4i % (Vector4i right)

Parameters

right Vector4i

% (int)

Gets the remainder of each component of the Vector4i 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(Vector4i(10, -20, 30, -40) % 7) # Prints (3, -6, 2, -5)


Vector4i % (int right)

Parameters

right int

* (Vector4i)

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

print(Vector4i(10, 20, 30, 40) * Vector4i(3, 4, 5, 6)) # Prints (30, 80, 150, 240)


Vector4i * (Vector4i right)

Parameters

right Vector4i

* (float)

Multiplies each component of the Vector4i by the given float.

Returns a Vector4 value due to floating-point operations.

print(Vector4i(10, 20, 30, 40) * 2) # Prints (20.0, 40.0, 60.0, 80.0)


Vector4 * (float right)

Parameters

right float

* (int)

Multiplies each component of the Vector4i by the given int.

Vector4i * (int right)

Parameters

right int

+ (Vector4i)

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

print(Vector4i(10, 20, 30, 40) + Vector4i(3, 4, 5, 6)) # Prints (13, 24, 35, 46)


Vector4i + (Vector4i right)

Parameters

right Vector4i

- (Vector4i)

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

print(Vector4i(10, 20, 30, 40) - Vector4i(3, 4, 5, 6)) # Prints (7, 16, 25, 34)


Vector4i - (Vector4i right)

Parameters

right Vector4i

/ (Vector4i)

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

print(Vector4i(10, 20, 30, 40) / Vector4i(2, 5, 3, 4)) # Prints (5, 4, 10, 10)


Vector4i / (Vector4i right)

Parameters

right Vector4i

/ (float)

Divides each component of the Vector4i by the given float.

Returns a Vector4 value due to floating-point operations.

print(Vector4i(10, 20, 30, 40) / 2) # Prints (5.0, 10.0, 15.0, 20.0)


Vector4 / (float right)

Parameters

right float

/ (int)

Divides each component of the Vector4i by the given int.

Vector4i / (int right)

Parameters

right int

< (Vector4i)

Compares two Vector4i 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, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.

bool < (Vector4i right)

Parameters

right Vector4i

<= (Vector4i)

Compares two Vector4i 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, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.

bool <= (Vector4i right)

Parameters

right Vector4i

== (Vector4i)

Returns true if the vectors are exactly equal.

bool == (Vector4i right)

Parameters

right Vector4i

> (Vector4i)

Compares two Vector4i 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, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.

bool > (Vector4i right)

Parameters

right Vector4i

>= (Vector4i)

Compares two Vector4i 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, Z values of the two vectors, and then with the W values. This operator is useful for sorting vectors.

bool >= (Vector4i right)

Parameters

right Vector4i

[] (int)

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

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.

Vector4i unary+

unary-

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

Vector4i unary-