Class Vector3i

A 3D vector using integer coordinates.

Vector3i

Remarks

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

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

Constructors

Vector3i

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

Vector3i Vector3i

Vector3i(Vector3i)

Constructs a Vector3i as a copy of the given Vector3i.

Vector3i Vector3i(Vector3i from)

Parameters

from Vector3i

Vector3i(Vector3)

Constructs a new Vector3i from the given Vector3 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.

Vector3i Vector3i(Vector3 from)

Parameters

from Vector3

Vector3i(int, int, int)

Returns a Vector3i with the given components.

Vector3i Vector3i(int x, int y, int z)

Parameters

x int
y int
z int

Fields

ZERO

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

const ZERO = Vector3i(0, 0, 0)

ONE

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

const ONE = Vector3i(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 = Vector3i(-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 = Vector3i(2147483647, 2147483647, 2147483647)

LEFT

Left unit vector. Represents the local direction of left, and the global direction of west.

const LEFT = Vector3i(-1, 0, 0)

RIGHT

Right unit vector. Represents the local direction of right, and the global direction of east.

const RIGHT = Vector3i(1, 0, 0)

UP

Up unit vector.

const UP = Vector3i(0, 1, 0)

DOWN

Down unit vector.

const DOWN = Vector3i(0, -1, 0)

FORWARD

Forward unit vector. Represents the local direction of forward, and the global direction of north.

const FORWARD = Vector3i(0, 0, -1)

BACK

Back unit vector. Represents the local direction of back, and the global direction of south.

const BACK = Vector3i(0, 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

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

Vector3i abs

clamp(Vector3i, Vector3i)

Qualifiers: const

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

Vector3i clamp(Vector3i min, Vector3i max)

Parameters

min Vector3i
max Vector3i

clampi(int, int)

Qualifiers: const

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

Vector3i clampi(int min, int max)

Parameters

min int
max int

distance_squared_to(Vector3i)

Qualifiers: const

Returns the squared distance between this vector and to.

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

int distance_squared_to(Vector3i to)

Parameters

to Vector3i

distance_to(Vector3i)

Qualifiers: const

Returns the distance between this vector and to.

float distance_to(Vector3i to)

Parameters

to Vector3i

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

Qualifiers: const

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

Vector3i max(Vector3i with)

Parameters

with Vector3i

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

int max_axis_index

maxi(int)

Qualifiers: const

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

Vector3i maxi(int with)

Parameters

with int

min(Vector3i)

Qualifiers: const

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

Vector3i min(Vector3i with)

Parameters

with Vector3i

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 Vector3i.AXIS_Z.

int min_axis_index

mini(int)

Qualifiers: const

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

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

Vector3i sign

snapped(Vector3i)

Qualifiers: const

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

Vector3i snapped(Vector3i step)

Parameters

step Vector3i

snappedi(int)

Qualifiers: const

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

Vector3i snappedi(int step)

Parameters

step int

Operators

!= (Vector3i)

Returns true if the vectors are not equal.

bool != (Vector3i right)

Parameters

right Vector3i

% (Vector3i)

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

Vector3i % (Vector3i right)

Parameters

right Vector3i

% (int)

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

Vector3i % (int right)

Parameters

right int

* (Vector3i)

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

print(Vector3i(10, 20, 30) * Vector3i(3, 4, 5)) # Prints (30, 80, 150)

Vector3i * (Vector3i right)

Parameters

right Vector3i

* (float)

Multiplies each component of the Vector3i by the given float. Returns a Vector3.

print(Vector3i(10, 15, 20) * 0.9) # Prints (9.0, 13.5, 18.0)

Vector3 * (float right)

Parameters

right float

* (int)

Multiplies each component of the Vector3i by the given int.

Vector3i * (int right)

Parameters

right int

+ (Vector3i)

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

print(Vector3i(10, 20, 30) + Vector3i(3, 4, 5)) # Prints (13, 24, 35)

Vector3i + (Vector3i right)

Parameters

right Vector3i

- (Vector3i)

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

print(Vector3i(10, 20, 30) - Vector3i(3, 4, 5)) # Prints (7, 16, 25)

Vector3i - (Vector3i right)

Parameters

right Vector3i

/ (Vector3i)

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

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

Vector3i / (Vector3i right)

Parameters

right Vector3i

/ (float)

Divides each component of the Vector3i by the given float. Returns a Vector3.

print(Vector3i(10, 20, 30) / 2.9) # Prints (5.0, 10.0, 15.0)

Vector3 / (float right)

Parameters

right float

/ (int)

Divides each component of the Vector3i by the given int.

Vector3i / (int right)

Parameters

right int

< (Vector3i)

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

bool < (Vector3i right)

Parameters

right Vector3i

<= (Vector3i)

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

bool <= (Vector3i right)

Parameters

right Vector3i

== (Vector3i)

Returns true if the vectors are equal.

bool == (Vector3i right)

Parameters

right Vector3i

> (Vector3i)

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

bool > (Vector3i right)

Parameters

right Vector3i

>= (Vector3i)

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

bool >= (Vector3i right)

Parameters

right Vector3i

[] (int)

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

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.

Vector3i unary+

unary-

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

Vector3i unary-

Table of Contents

Class Vector3i

Remarks

See Also

Constructors

Vector3i

Vector3i(Vector3i)

Parameters

Vector3i(Vector3)

Parameters

Vector3i(int, int, int)

Parameters

Fields

ZERO

ONE

MIN

MAX

LEFT

RIGHT

UP

DOWN

FORWARD

BACK

Properties

x

Property Value

y

Property Value

z

Property Value

Methods

abs

clamp(Vector3i, Vector3i)

Parameters

clampi(int, int)

Parameters

distance_squared_to(Vector3i)

Parameters

distance_to(Vector3i)

Parameters

length

length_squared

max(Vector3i)

Parameters

max_axis_index

maxi(int)

Parameters

min(Vector3i)

Parameters

min_axis_index

mini(int)

Parameters

sign

snapped(Vector3i)

Parameters

snappedi(int)

Parameters

Operators

!= (Vector3i)

Parameters

% (Vector3i)

Parameters

% (int)

Parameters

* (Vector3i)

Parameters

* (float)

Parameters

* (int)

Parameters

+ (Vector3i)

Parameters

- (Vector3i)

Parameters

/ (Vector3i)

Parameters

/ (float)

Parameters

/ (int)

Parameters