# Vector3¶

Category: Built-In Types

## Brief Description¶

Vector class, which performs basic 3D vector math operations.

## Member Functions¶

 Vector3 Vector3 ( float x, float y, float z ) Vector3 abs ( ) Vector3 ceil ( ) Vector3 cross ( Vector3 b ) Vector3 cubic_interpolate ( Vector3 b, Vector3 pre_a, Vector3 post_b, float t ) float distance_squared_to ( Vector3 b ) float distance_to ( Vector3 b ) float dot ( Vector3 b ) Vector3 floor ( ) Vector3 inverse ( ) float length ( ) float length_squared ( ) Vector3 linear_interpolate ( Vector3 b, float t ) int max_axis ( ) int min_axis ( ) Vector3 normalized ( ) Vector3 reflect ( Vector3 by ) Vector3 rotated ( Vector3 axis, float phi ) Vector3 slide ( Vector3 by ) Vector3 snapped ( float by )

## Member Variables¶

• float x - X component of the vector.
• float y - Y component of the vector.
• float z - Z component of the vector.

## Numeric Constants¶

• AXIS_X = 0 — Enumerated value for the X axis. Returned by functions like max_axis or min_axis.
• AXIS_Y = 1 — Enumerated value for the Y axis.
• AXIS_Z = 2 — Enumerated value for the Z axis.

## Description¶

Vector3 is one of the core classes of the engine, and includes several built-in helper functions to perform basic vector math operations.

## Member Function Description¶

Returns a Vector3 with the given components.

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

Returns a new vector with all components rounded up.

Return the cross product with b.

Perform a cubic interpolation between vectors pre_a, a, b, post_b (a is current), by the given amount (t).

Return the squared distance (distance minus the last square root) to b. Prefer this function over distance_to if you need to sort vectors or need the squared distance for some formula.

Return the distance to b.

Return the dot product with b.

Returns a new vector with all components rounded down.

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

Return the length of the vector.

• float length_squared ( )

Return the length of the vector, squared. Prefer this function over “length” if you need to sort vectors or need the squared length for some formula.

Linearly interpolates the vector to a given one (b), by the given amount (t).

• int max_axis ( )

Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the largest.

• int min_axis ( )

Returns AXIS_X, AXIS_Y or AXIS_Z depending on which axis is the smallest.

Return a copy of the normalized vector to unit length. This is the same as v / v.length().

Like “slide”, but reflects the Vector instead of continuing along the wall.

Rotates the vector around some axis by phi radians.

Slides the vector along a wall.

Return a copy of the vector, snapped to the lowest neared multiple.