⚙️Vector

This type is a common 3D vector (x, y, z).

This type supports operations, such as +, -, /, * and ==

x

Field

Type: float

X coordinate.

y

Field

Type: float

Y coordinate.

z

Field

Type: float

Z coordinate.

---

__call

Constructor

Constructs a vector.

Arguments

1. Default vector (0, 0, 0).

None.

2. Single value.

Name	Type	Description
value	float	X and Y coordinates.

3. XYZ values.

Name	Type	Description
x	float	X coordinate.
y	float	Y coordinate.
z	float	Z coordinate.

Returns

Type	Description
Vector	Vector.

Example

local vec = Vector(5, 25, 12);

---

IsZero

Method

Returns true if this vector is within tolerance range.

Arguments

Name	Type	Description
tolerance	float	Max allowed tolerance. Defaults to 0.01.

Returns

Type	Description
bool	true if ranges between -tolerance and tolerance.

Example

local vec = Vector(0, 0.1, 0.5);
print(tostring(vec:IsZero(1))); -- will print 'true', because every value fits in the range of -1 and 1

---

Clone

Method

Returns a new copy of this vector.

Arguments

None.

Returns

Type	Description
Vector	The copied vector

Example

local a = Vector(1, 2, 3)
local b = a:Clone()
a.x = 0
b.x = 3 -- Changing B does not affect A
print(a.x, b.x) -- Prints 0 3

---

Dist

Method

Returns distance to another vector.

Arguments

Name	Type	Description
other	Vector	Vector to calculate distance against.

Returns

Type	Description
float	Distance to other vector.

Example

local vec1 = Vector(0, 0, 0);
local vec2 = Vector(1, 1, 5);
print(tostring(vec1:Dist(vec2)));

---

DistSqr

Method

Returns squared distance to another vector.

This method is de-facto faster than the non-squared variant. Use it, if you need extra performance.

Arguments

Name	Type	Description
other	Vector	Vector to calculate distance against.

Returns

Type	Description
float	Squared distance to other vector.

Example

local vec1 = Vector(0, 0, 0);
local vec2 = Vector(1, 1, 5);
print(tostring(vec1:DistSqr(vec2)));

---

Dist2d

Method

Returns 2D (only x and y values) distance to another vector.

Arguments

Name	Type	Description
other	Vector	Vector to calculate distance against.

Returns

Type	Description
float	Distance to other vector.

Example

local vec1 = Vector(0, 0, 0);
local vec2 = Vector(1, 1, 5);
print(tostring(vec1:Dist2d(vec2)));

---

Dist2dSqr

Method

Returns squared 2D (only x and y values) distance to another vector.

This method is de-facto faster than the non-squared variant. Use it, if you need extra performance.

Arguments

Name	Type	Description
other	Vector	Vector to calculate distance against.

Returns

Type	Description
float	Squared distance to other vector.

Example

local vec1 = Vector(0, 0, 0);
local vec2 = Vector(1, 1, 5);
print(tostring(vec1:Dist2dSqr(vec2)));

---

Cross

Method

Returns a cross product to another vector.

Arguments

Name	Type	Description
other	Vector	Vector to calculate cross product against.

Returns

Type	Description
Vector	Cross product.

Example

local vec1 = Vector(0, 0, 0);
local vec2 = Vector(1, 1, 5);
local cross = vec1:Cross(vec2);

---

IsValid

Method

Returns true if all values in this vector are finite.

Arguments

None.

Returns

Type	Description
bool	true if values are finite.

Example

local vec = Vector(5, 1, 6);
if vec:IsValid() then
    -- ...
end

---

Length

Method

Returns length of this vector.

Arguments

None.

Returns

Type	Description
float	Length of this vector.

Example

local vec = Vector(5, 1, 6);
local length = vec:Length();

---

LengthSqr

Method

Returns squared length of this vector.

This method is de-facto faster than the non-squared variant. Use it, if you need extra performance.

Arguments

None.

Returns

Type	Description
float	Length of this vector.

Example

local vec = Vector(5, 1, 6);
local length = vec:LengthSqr();

---

Length2d

Method

Returns 2D length of this vector.

Arguments

None.

Returns

Type	Description
float	Length of this vector.

Example

local vec = Vector(5, 1, 6);
local length = vec:Length2d();

---

Length2dSqr

Method

Returns squared 2D length of this vector.

This method is de-facto faster than the non-squared variant. Use it, if you need extra performance.

Arguments

None.

Returns

Type	Description
float	Length of this vector.

Example

local vec = Vector(5, 1, 6);
local length = vec:Length2dSqr();

---

Dot

Method

Returns dot product of 2 vectors.

Arguments

Name	Type	Description
other	Vector	Vector to calculate dot product against.

Returns

Type	Description
float	Dot product.

Example

local vec1 = Vector(0, 0, 0);
local vec2 = Vector(1, 1, 5);
local dot = vec1:Dot(vec2);

---

GetForward

Method

Returns the direction/forward vector of an angle.

Arguments

None.

Returns

Type	Description
Vector	The forward vector

Example

local view_angles = game.input:GetViewAngles()
local forward = view_angles:GetForward()

---

AngleVectors

Method

Returns the forward, right and up vectors of an angle.

Arguments

None.

Returns

Type	Description
Vector	The forward vector
Vector	The right vector
Vector	The up vector

Example

local view_angles = game.input:GetViewAngles()
local forward, right, up = view_angles:AngleVectors()

---

VectorAngles

Method

Returns the angle of a vector.

Arguments

None.

Returns

Type	Description
Vector	The angles

Example

local velocity = entities.GetLocalPawn():GetAbsVelocity()
local direction = velocity:VectorAngles()

---

Normalize

Method

Normalizes this vector, turning it into an unit/direction vector.

Arguments

None.

Returns

Nothing.

Example

local movement_dir = entities.GetLocalPawn():GetAbsVelocity()
movement_dir:Normalize()

---

Normalized

Method

Returns a normalized version of this vector, turning it into an unit/direction vector.

Arguments

None.

Returns

Type	Description
Vector	The normalized vector

Example

local movement_dir = entities.GetLocalPawn():GetAbsVelocity():Normalized()