📐 Vector

A Vector composed of components (X, Y, Z) with floating point precision. Used mainly for entity position.

👐Open Source🧑‍💻API Source

---

info

Les vecteurs sont compressés en interne et automatiquement, ce qui réduit leur taille dans le réseau jusqu'à 90 %. Des détails intéressants :

• Les paramètres des vecteurs dans les méthodes des classes sont généralement compressés avec une précision de 1 décimale (avec quelques exceptions où nous avons besoin de plus de précision).
• Les vecteurs transmis dans les événements distants sont compressés avec une précision de 2 décimales. If you need more precision, we recommend passing them as raw number instead.

🎒 Examples

local new_vector = Vector(1452.5, 512, 943.1)

🛠 Constructors

Default Constructor

No description provided

local my_vector = Vector(X?, Y?, Z?)

Parameters

Type	Name	Default	Description
number	X	0	Coordonnée X
number	Y	X	Coordonnée Y
number	Z	X	Coordonnée Z

🧽 Properties

Type	Name	Description
number	X	Coordonnée X
number	Y	Coordonnée Y
number	Z	Coordonnée Z

🦠 Functions

info

This structure supports +, -, *, /, ^, ==, and tostring operations.

	Returns	Name	Description
	boolean	Equals	Vérifie l'égalité avec un autre vecteur, dans les limites d'erreur spécifiées
	number	Distance	Distance entre deux points
	number	DistanceSquared	Distance au carré entre deux points
	Vector	GetUnsafeNormal	Calcule la version normalisée du vecteur sans vérifier si la longueur est nulle
	Vector	GetSafeNormal	Obtient une copie normalisée du vecteur, en vérifiant qu'il est possible de le faire en fonction de la longueur
	boolean	IsNear	Efficiently checks whether vector is near to another vector within a specified radius
	boolean	IsNearlyZero	Vérifie si le vecteur est proche de zéro dans une tolérance spécifiée
	boolean	IsZero	Vérifie si tous les composants du vecteur sont exactement égales à zéro
	boolean	Normalize	Normalize this vector in-place if it is larger than a given tolerance. Leaves it unchanged if not
	number	Size	Obtient la longueur (magnitude) de ce vecteur
	number	SizeSquared	Obtenir la longueur au carré de ce vecteur
	Rotator	ToOrientationRotator	Return the Rotator orientation corresponding to the direction in which the vector points
	Quat	ToOrientationQuat	Return the Quaternion orientation corresponding to the direction in which the vector points
	number	Dot	Dot product of two vectors
	Vector	Cross	Cross product of two vectors

---

Equals

Check if the vector is equal to another vector, within specified error limits

local ret = my_vector:Equals(other, tolerance?)

Parameters

Type	Parameter	Default	Description
Vector	other	Required parameter	The vector to compare to
number	tolerance?	0.000001	The error limits

Returns

Type	Description
boolean	Are the vectors equal or not

---

Distance

Returns the distance of 2 vectors

local ret = my_vector:Distance(other)

Parameters

Type	Parameter	Default	Description
Vector	other	Required parameter	The vector to get the distance to

Returns

Type	Description
number	The distance between the vectors

---

DistanceSquared

Return the squared distance of 2 vectors

local ret = my_vector:DistanceSquared(other)

Parameters

Type	Parameter	Default	Description
Vector	other	Required parameter	The vector to get the squared distance to

Returns

Type	Description
number	The squared distance between the vectors

---

GetUnsafeNormal

Returns the normalized version of vector without checking for zero length

local ret = my_vector:GetUnsafeNormal()

Returns

Type	Description
Vector	The unsafe normal

---

GetSafeNormal

Returns a normalized copy of the vector, checking it is safe to do so based on the length

local ret = my_vector:GetSafeNormal()

Returns

Type	Description
Vector	The safe normal

---

IsNear

Efficiently checks whether vector is near to another vector within a specified radius

local ret = my_vector:IsNear(other, radius)

Parameters

Type	Parameter	Default	Description
Vector	other	Required parameter	The vector to compare to
number	radius	Required parameter	The radius to check

Returns

Type	Description
boolean	If the vector is near to the other vector

---

IsNearlyZero

Vérifie si le vecteur est proche de zéro dans une tolérance spécifiée

local ret = my_vector:IsNearlyZero(tolerance?)

Parameters

Type	Parameter	Default	Description
number	tolerance?	0.000001	The error limits

Returns

Type	Description
boolean	If the bool is near to zero

---

IsZero

Vérifie si tous les composants du vecteur sont exactement égales à zéro

local ret = my_vector:IsZero()

Returns

Type	Description
boolean	If all components of the vector are exactly zero

---

Normalize

Normalize this vector in-place if it is larger than a given tolerance. Leaves it unchanged if not

local ret = my_vector:Normalize()

Returns

Type	Description
boolean	If the vector has been modified

---

Size

Obtient la longueur (magnitude) de ce vecteur

local ret = my_vector:Size()

Returns

Type	Description
number	The length of the vector

---

SizeSquared

Obtenir la longueur au carré de ce vecteur

local ret = my_vector:SizeSquared()

Returns

Type	Description
number	The squared length of the vector

---

ToOrientationRotator

Return the Rotator orientation corresponding to the direction in which the vector points

local ret = my_vector:ToOrientationRotator()

Returns

Type	Description
Rotator	The orientation of the vector

---

ToOrientationQuat

Return the Quaternion orientation corresponding to the direction in which the vector points

local ret = my_vector:ToOrientationQuat()

Returns

Type	Description
Quat	The orientation of the vector

---

Dot

Returns the dot product between this vector and another vector

local ret = my_vector:Dot(other)

Parameters

Type	Parameter	Default	Description
Vector	other	Required parameter	The vector to dot with

Returns

Type	Description
number	the dot product

---

Cross

Returns the cross product between this vector and another vector

local ret = my_vector:Cross(other)

Parameters

Type	Parameter	Default	Description
Vector	other	Required parameter	The vector to cross with

Returns

Type	Description
Vector	the cross product vector