Vector3

3-element structure that can be used to represent positions in 3D space or any other pair of numeric values.

Note: In a boolean context, a Vector3 will evaluate to if it’s equal to Vector3(0, 0, 0). Otherwise, a Vector3 will always evaluate to true.

Tutorials

Methods

AXIS_X = 0 —- Enumerated value for the X axis. Returned by and min_axis.
AXIS_Y = 1 —- Enumerated value for the Y axis. Returned by and min_axis.
AXIS_Z = 2 —- Enumerated value for the Z axis. Returned by and min_axis.
ZERO = Vector3( 0, 0, 0 ) —- Zero vector, a vector with all components set to 0.
ONE = Vector3( 1, 1, 1 ) —- One vector, a vector with all components set to 1.
INF = Vector3( inf, inf, inf ) —- Infinity vector, a vector with all components set to .
LEFT = Vector3( -1, 0, 0 ) —- Left unit vector. Represents the local direction of left, and the global direction of west.
UP = Vector3( 0, 1, 0 ) —- Up unit vector.
DOWN = Vector3( 0, -1, 0 ) —- Down unit vector.
FORWARD = Vector3( 0, 0, -1 ) —- Forward unit vector. Represents the local direction of forward, and the global direction of north.
BACK = Vector3( 0, 0, 1 ) —- Back unit vector. Represents the local direction of back, and the global direction of south.

Property Descriptions

float x

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

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

float z

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

Vector3 ( float x, y, float z )

Returns a Vector3 with the given components.

abs ( )

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

float angle_to ( to )

Returns the minimum angle to the given vector, in radians.

Vector3 bounce ( n )

Returns the vector “bounced off” from a plane defined by the given normal.

Vector3 ceil ( )

Returns a new vector with all components rounded up (towards positive infinity).

cross ( Vector3 b )

Returns the cross product of this vector and b.

cubic_interpolate ( Vector3 b, pre_a, Vector3 post_b, t )

Performs a cubic interpolation between vectors pre_a, a, b, (a is current), by the given amount t. t is on the range of 0.0 to 1.0, representing the amount of interpolation.

Vector3 direction_to ( b )

Returns the normalized vector pointing from this vector to b. This is equivalent to using (b - a).normalized().

float distance_squared_to ( b )

Returns the squared distance between this vector and b.

float distance_to ( b )

Returns the distance between this vector and b.

float dot ( b )

Returns the dot product of this vector and b. This can be used to compare the angle between two vectors. For example, this can be used to determine whether an enemy is facing the player.

The dot product will be 0 for a straight angle (90 degrees), greater than 0 for angles narrower than 90 degrees and lower than 0 for angles wider than 90 degrees.

When using unit (normalized) vectors, the result will always be between -1.0 (180 degree angle) when the vectors are facing opposite directions, and 1.0 (0 degree angle) when the vectors are aligned.

Note: a.dot(b) is equivalent to b.dot(a).

Vector3 floor ( )

Returns a new vector with all components rounded down (towards negative infinity).

inverse ( )

Returns the inverse of the vector. This is the same as Vector3( 1.0 / v.x, 1.0 / v.y, 1.0 / v.z ).

Returns true if this vector and v are approximately equal, by running @GDScript.is_equal_approx on each component.

is_normalized ( )

Returns true if the vector is normalized, otherwise.

float length ( )

Returns the length (magnitude) of this vector.

length_squared ( )

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.

linear_interpolate ( Vector3 b, t )

Returns the result of the linear interpolation between this vector and b by amount t. t is on the range of 0.0 to 1.0, representing the amount of interpolation.

int max_axis ( )

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

int min_axis ( )

move_toward ( Vector3 to, delta )

Moves this vector toward to by the fixed delta amount.

Vector3 normalized ( )

Returns the vector scaled to unit length. Equivalent to v / v.length().

outer ( Vector3 b )

Returns the outer product with b.

posmod ( float mod )

Returns a vector composed of the of this vector’s components and mod.

Vector3 posmodv ( modv )

Returns a vector composed of the @GDScript.fposmod of this vector’s components and modv‘s components.

project ( Vector3 b )

Returns this vector projected onto another vector b.

reflect ( Vector3 n )

Returns this vector reflected from a plane defined by the given normal.

rotated ( Vector3 axis, phi )

Rotates this vector around a given axis by phi radians. The axis must be a normalized vector.

Vector3 round ( )

Returns this vector with all components rounded to the nearest integer, with halfway cases rounded away from zero.

sign ( )

Returns a vector with each component set to one or negative one, depending on the signs of this vector’s components, or zero if the component is zero, by calling @GDScript.sign on each component.

slerp ( Vector3 b, t )

Returns the result of spherical linear interpolation between this vector and b, by amount t. t is on the range of 0.0 to 1.0, representing the amount of interpolation.

Note: Both vectors must be normalized.

Vector3 slide ( n )

Returns this vector slid along a plane defined by the given normal.

Vector3 snapped ( by )

Returns this vector with each component snapped to the nearest multiple of step. This can also be used to round to an arbitrary number of decimals.

Basis to_diagonal_matrix ( )

This is equivalent to a Basis with no rotation or shearing and this vector’s components set as the scale.