@quenty/vector3utils 10.8.0 → 10.8.1

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [10.8.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/vector3utils@10.8.0...@quenty/vector3utils@10.8.1) (2025-03-21)
+
+**Note:** Version bump only for package @quenty/vector3utils
+
+
+
+
+
 # [10.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/vector3utils@10.7.1...@quenty/vector3utils@10.8.0) (2025-02-18)
 
 **Note:** Version bump only for package @quenty/vector3utils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/vector3utils",
-  "version": "10.8.0",
+  "version": "10.8.1",
   "description": "Utilities involving Vector3 objects in Roblox",
   "keywords": [
     "Roblox",
@@ -26,10 +26,10 @@
   ],
   "dependencies": {
     "@quenty/loader": "^10.8.0",
-    "@quenty/math": "^2.7.0"
+    "@quenty/math": "^2.7.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
+  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
 }

package/src/Shared/RandomVector3Utils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility functions involving RandomVector3Utils
 	@class RandomVector3Utils
@@ -10,17 +11,17 @@ local RandomVector3Utils = {}
 	@return Vector3
 ]=]
 function RandomVector3Utils.getRandomUnitVector(): Vector3
-	local s = 2*(math.random()-0.5)
-	local t = 6.2831853071796*math.random()
+	local s = 2 * (math.random() - 0.5)
+	local t = 6.2831853071796 * math.random()
 	local rx = s
-	local m = (1-s*s)^0.5
-	local ry = m*math.cos(t)
-	local rz = m*math.sin(t)
+	local m = (1 - s * s) ^ 0.5
+	local ry = m * math.cos(t)
+	local rz = m * math.sin(t)
 	return Vector3.new(rx, ry, rz)
 end
 
-local function gaussianRandom()
-	return math.sqrt(-2*math.log(1 - math.random()))*math.cos(2*math.pi*math.random())
+local function gaussianRandom(): number
+	return math.sqrt(-2 * math.log(1 - math.random())) * math.cos(2 * math.pi * math.random())
 end
 
 --[=[
@@ -31,11 +32,7 @@ end
 	@return Vector3
 ]=]
 function RandomVector3Utils.gaussianRandom(mean: Vector3, spread: Vector3): Vector3
-	return mean + spread*Vector3.new(
-		gaussianRandom(),
-		gaussianRandom(),
-		gaussianRandom()
-	)/math.sqrt(3)
+	return mean + spread * Vector3.new(gaussianRandom(), gaussianRandom(), gaussianRandom()) / math.sqrt(3)
 end
 
 --[=[
@@ -50,28 +47,25 @@ function RandomVector3Utils.getDirectedRandomUnitVector(direction: Vector3, angl
 	assert(typeof(direction) == "Vector3", "Bad direction")
 	assert(type(angleRad) == "number", "Bad angleRad")
 
-	local s = 1 - (1 - math.cos(angleRad))*math.random()
-	local t = 6.2831853071796*math.random()
+	local s = 1 - (1 - math.cos(angleRad)) * math.random()
+	local t = 6.2831853071796 * math.random()
 	local rx = s
-	local m = (1-s*s)^0.5
-	local ry = m*math.cos(t)
-	local rz = m*math.sin(t)
+	local m = (1 - s * s) ^ 0.5
+	local ry = m * math.cos(t)
+	local rz = m * math.sin(t)
 
-	local dx, dy, dz = direction.x, direction.y, direction.z
-	local d = (dx*dx+dy*dy+dz*dz)^0.5
+	local dx, dy, dz = direction.X, direction.Y, direction.Z
+	local d = (dx * dx + dy * dy + dz * dz) ^ 0.5
 
-	if dx/d < -0.9999 then
+	if dx / d < -0.9999 then
 		return Vector3.new(-rx, ry, rz)
-	elseif dx/d < 0.9999 then
-		local coef1 = (rx- dx*(dy*ry+dz*rz)/(dy*dy+dz*dz))/d
-		local coef2 = (dz*ry-dy*rz)/(dy*dy+dz*dz)
-		return Vector3.new(
-			(dx*rx+dy*ry+dz*rz)/d,
-			dy*coef1+dz*coef2,
-			dz*coef1-dy*coef2)
+	elseif dx / d < 0.9999 then
+		local coef1 = (rx - dx * (dy * ry + dz * rz) / (dy * dy + dz * dz)) / d
+		local coef2 = (dz * ry - dy * rz) / (dy * dy + dz * dz)
+		return Vector3.new((dx * rx + dy * ry + dz * rz) / d, dy * coef1 + dz * coef2, dz * coef1 - dy * coef2)
 	else
 		return Vector3.new(rx, ry, rz)
 	end
 end
 
-return RandomVector3Utils
+return RandomVector3Utils

package/src/Shared/Vector3SerializationUtils.lua

@@ -1,26 +1,47 @@
+--!strict
 --[=[
 	@class Vector3SerializationUtils
 ]=]
 
 local Vector3SerializationUtils = {}
 
-function Vector3SerializationUtils.isSerializedVector3(data)
+export type SerializedVector3 = { number }
+
+--[=[
+	Returns true if this data is a serialized Vector3
+
+	@param data any
+	@return boolean
+]=]
+function Vector3SerializationUtils.isSerializedVector3(data: any): boolean
 	return type(data) == "table" and #data == 3
 end
 
-function Vector3SerializationUtils.serialize(vector3)
+--[=[
+	Serialized a Vector3 into a Lua table, which should encode in JSON and be network safe.
+
+	@param vector3 Vector3
+	@return SerializedVector3
+]=]
+function Vector3SerializationUtils.serialize(vector3: Vector3): SerializedVector3
 	return {
-		vector3.x,
-		vector3.y,
-		vector3.z
+		vector3.X,
+		vector3.Y,
+		vector3.Z,
 	}
 end
 
-function Vector3SerializationUtils.deserialize(data)
+--[=[
+	Deserializes a Vector3 from a Lua table
+
+	@param data SerializedVector3
+	@return Vector3
+]=]
+function Vector3SerializationUtils.deserialize(data: SerializedVector3): Vector3
 	assert(type(data) == "table", "Bad data")
 	assert(#data == 3, "Bad data")
 
 	return Vector3.new(data[1], data[2], data[3])
 end
 
-return Vector3SerializationUtils
+return Vector3SerializationUtils

package/src/Shared/Vector3Utils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utilities involving Vector3 objects in Roblox.
 	@class Vector3Utils
@@ -16,7 +17,7 @@ local Vector3Utils = {}
 	@return Vector3
 ]=]
 function Vector3Utils.fromVector2XY(vector2: Vector2): Vector3
-	return Vector3.new(vector2.x, vector2.y, 0)
+	return Vector3.new(vector2.X, vector2.Y, 0)
 end
 
 --[=[
@@ -26,7 +27,7 @@ end
 	@return Vector3
 ]=]
 function Vector3Utils.fromVector2XZ(vector2: Vector2): Vector3
-	return Vector3.new(vector2.x, 0, vector2.y)
+	return Vector3.new(vector2.X, 0, vector2.Y)
 end
 
 --[=[
@@ -36,8 +37,8 @@ end
 	@param b Vector3
 	@return number?
 ]=]
-function Vector3Utils.getAngleRad(a: Vector3, b: Vector3): number
-	if a.magnitude == 0 then
+function Vector3Utils.getAngleRad(a: Vector3, b: Vector3): number?
+	if a.Magnitude == 0 then
 		return nil
 	end
 
@@ -52,7 +53,7 @@ end
 	@return Vector3
 ]=]
 function Vector3Utils.reflect(vector: Vector3, unitNormal: Vector3): Vector3
-	return vector - 2*(unitNormal*vector:Dot(unitNormal))
+	return vector - 2 * (unitNormal * vector:Dot(unitNormal))
 end
 
 --[=[
@@ -63,9 +64,9 @@ end
 	@return number
 ]=]
 function Vector3Utils.angleBetweenVectors(a: Vector3, b: Vector3): number
-	local u = b.magnitude*a
-	local v = a.magnitude*b
-	return 2*math.atan2((v - u).magnitude, (u + v).magnitude)
+	local u = b.Magnitude * a
+	local v = a.Magnitude * b
+	return 2 * math.atan2((v - u).Magnitude, (u + v).Magnitude)
 end
 
 --[=[
@@ -76,12 +77,12 @@ end
 	@param t number -- Amount to slerp. 0 is start, 1 is finish. beyond that is extended as expected.
 	@return Vector3
 ]=]
-function Vector3Utils.slerp(start: Vector3, finish: Vector3, t: number)
+function Vector3Utils.slerp(start: Vector3, finish: Vector3, t: number): Vector3
 	local dot = math.clamp(start:Dot(finish), -1, 1)
 
-	local theta = math.acos(dot)*t
-	local relVec = (finish - start*dot).unit
-	return ((start*math.cos(theta)) + (relVec*math.sin(theta)))
+	local theta = math.acos(dot) * t
+	local relVec = (finish - start * dot).Unit
+	return ((start * math.cos(theta)) + (relVec * math.sin(theta)))
 end
 
 --[=[
@@ -94,11 +95,11 @@ end
 ]=]
 function Vector3Utils.constrainToCone(direction: Vector3, coneDirection: Vector3, coneAngleRad: number): Vector3
 	local angle = Vector3Utils.angleBetweenVectors(direction, coneDirection)
-	local coneHalfAngle = 0.5*coneAngleRad
+	local coneHalfAngle = 0.5 * coneAngleRad
 
 	if angle > coneHalfAngle then
 		local proportion = coneHalfAngle / angle
-		return Vector3Utils.slerp(coneDirection.unit, direction.unit, proportion) * direction.magnitude
+		return Vector3Utils.slerp(coneDirection.Unit, direction.Unit, proportion) * direction.Magnitude
 	end
 
 	return direction
@@ -116,8 +117,8 @@ end
 	@param amount number
 	@return Vector3
 ]=]
-function Vector3Utils.round(vector3: Vector3, amount: number): number
-	return Vector3.new(Math.round(vector3.x, amount), Math.round(vector3.y, amount), Math.round(vector3.z, amount))
+function Vector3Utils.round(vector3: Vector3, amount: number): Vector3
+	return Vector3.new(Math.round(vector3.X, amount), Math.round(vector3.Y, amount), Math.round(vector3.Z, amount))
 end
 
 --[=[
@@ -128,12 +129,10 @@ end
 	@param epsilon number
 	@return boolean
 ]=]
-function Vector3Utils.areClose(a, b, epsilon)
+function Vector3Utils.areClose(a: Vector3, b: Vector3, epsilon: number): boolean
 	assert(type(epsilon) == "number", "Bad epsilon")
 
-	return math.abs(a.x - b.x) <= epsilon
-		and math.abs(a.y - b.y) <= epsilon
-		and math.abs(a.z - b.z) <= epsilon
+	return math.abs(a.X - b.X) <= epsilon and math.abs(a.Y - b.Y) <= epsilon and math.abs(a.Z - b.Z) <= epsilon
 end
 
-return Vector3Utils
+return Vector3Utils