Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Vector3i

A 3D vector using integer coordinates.

Description

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.

Tutorials

Properties

int

x

0

int

y

0

int

z

0

Constructors

Vector3i

Vector3i ( )

Vector3i

Vector3i ( Vector3i from )

Vector3i

Vector3i ( Vector3 from )

Vector3i

Vector3i ( int x, int y, int z )

Methods

Vector3i

abs ( ) const

Vector3i

clamp ( Vector3i min, Vector3i max ) const

float

length ( ) const

int

length_squared ( ) const

int

max_axis_index ( ) const

int

min_axis_index ( ) const

Vector3i

sign ( ) const

Vector3i

snapped ( Vector3i step ) const

Operators

bool

operator != ( Vector3i right )

Vector3i

operator % ( Vector3i right )

Vector3i

operator % ( int right )

Vector3i

operator * ( Vector3i right )

Vector3

operator * ( float right )

Vector3i

operator * ( int right )

Vector3i

operator + ( Vector3i right )

Vector3i

operator - ( Vector3i right )

Vector3i

operator / ( Vector3i right )

Vector3

operator / ( float right )

Vector3i

operator / ( int right )

bool

operator < ( Vector3i right )

bool

operator <= ( Vector3i right )

bool

operator == ( Vector3i right )

bool

operator > ( Vector3i right )

bool

operator >= ( Vector3i right )

int

operator [] ( int index )

Vector3i

operator unary+ ( )

Vector3i

operator unary- ( )


Constants

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.

AXIS_Z = 2

Enumerated value for the Z axis. Returned by max_axis_index and min_axis_index.

ZERO = Vector3i(0, 0, 0)

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

ONE = Vector3i(1, 1, 1)

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

MIN = Vector3i(-2147483648, -2147483648, -2147483648)

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

MAX = Vector3i(2147483647, 2147483647, 2147483647)

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

LEFT = Vector3i(-1, 0, 0)

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

RIGHT = Vector3i(1, 0, 0)

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

UP = Vector3i(0, 1, 0)

Up unit vector.

DOWN = Vector3i(0, -1, 0)

Down unit vector.

FORWARD = Vector3i(0, 0, -1)

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

BACK = Vector3i(0, 0, 1)

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


Property Descriptions

int x = 0

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


int y = 0

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


int z = 0

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


Constructor Descriptions

Vector3i Vector3i ( )

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


Vector3i Vector3i ( Vector3i from )

Constructs a Vector3i as a copy of the given Vector3i.


Vector3i Vector3i ( Vector3 from )

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 Vector3.ceil, Vector3.floor or