⚙️vec3

math.vec3

Variables

• x - number

• y - number

• z - number

Supported operators:

+, -, /, *

Functions

unpack

local vector = math.vec3(1, 2, 3)
local x, y, z = vector:unpack()

Returns:

Value	Datatype
x	number
y	number
z	number

length

local vector = math.vec3(1, 0, 0)
vector:length()

Returns:

Value	Datatype
the length of the vector	number

length2d

local vector = math.vec3(1, 0, 0)
vector:length2d()

Returns:

Value	Datatype
the two dimensional length of the vector	number

dist

local vector = math.vec3(1, 0, 0)
local vector2 = math.vec3(5, 5, 5)
print(vector:dist(vector2))

Parameter	Datatype	Description
other vector	math.vec3	vector to calculate distance

Returns:

Value	Datatype
distance	number

dist2d

local vector = math.vec3(1, 0, 0)
local vector2 = math.vec3(5, 5, 5)
print(vector:dist2d(vector2))

Parameter	Datatype	Description
other vector	math.vec3	vector to calculate distance

Returns:

Value	Datatype
2-dimensional distance	number

to2d

local vector = math.vec3(1, 0, 0)
vector:to2d()

Returns:

Value	Datatype
the original vector with the z component set to 0	math.vec3

cross

local vector1 = math.vec3(1, 0, 0)
local vector2 = math.vec3(0, 1, 0)

local cross_product = vector1:cross(vector2)

Parameter	Datatype	Description
other vector	math.vec3	vector to cross with

Returns:

Value	Datatype
the cross product of the two vectors	math.vec3

normalize

local vector1 = math.vec3(50, 50, 100)
local vector_normalized = vector1:normalize()

Returns:

Value	Datatype
the vector normalized	math.vec3

dot

local vector1 = math.vec3(50, 50, 100)
local dot_product = vector1:dot(math.vec3(1, 33, 7))

Parameter	Datatype	Description
other vector	math.vec3	vector to calculate dot product with

Returns:

Value	Datatype
the two vectors dot product	number

calc_angle

local vector1 = math.vec3(50, 50, 100)
local vector2 = math.vec3(1, 33, 7)
local angle = vector1:calc_angle(vector2)

Parameter	Datatype	Description
other vector	math.vec3	vector to calculate angle with

Returns:

Value	Datatype
the angle between the two vectors	math.vec3