@quenty/vector3utils 7.1.1-canary.d08dd64.0 → 7.2.0

package/CHANGELOG.md

@@ -3,9 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [7.1.1-canary.d08dd64.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/vector3utils@7.1.0...@quenty/vector3utils@7.1.1-canary.d08dd64.0) (2024-01-01)
+# [7.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/vector3utils@7.1.0...@quenty/vector3utils@7.2.0) (2024-01-08)
 
-**Note:** Version bump only for package @quenty/vector3utils
+
+### Features
+
+* Add Vector3Utils.areClose ([1820b38](https://github.com/Quenty/NevermoreEngine/commit/1820b38ca52315925a85b1c4f45e10d4b448e96d))
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/vector3utils",
-  "version": "7.1.1-canary.d08dd64.0",
+  "version": "7.2.0",
   "description": "Utilities involving Vector3 objects in Roblox",
   "keywords": [
     "Roblox",
@@ -25,11 +25,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "7.1.1-canary.d08dd64.0",
-    "@quenty/math": "2.5.0"
+    "@quenty/loader": "^7.3.0",
+    "@quenty/math": "^2.5.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d08dd641615f51bc83b2fe46f11f41bd95acdec1"
+  "gitHead": "075fb03a03f12ade8758f667767ba738204e0c4b"
 }

package/src/Shared/Vector3Utils.lua

@@ -11,6 +11,7 @@ local Vector3Utils = {}
 
 --[=[
 	Creates a Vector3 from a Vector2 in the XY plane
+
 	@param vector2 Vector2
 	@return Vector3
 ]=]
@@ -20,6 +21,7 @@ end
 
 --[=[
 	Creates a Vector3 from a Vector2 in the XZ plane
+
 	@param vector2 Vector2
 	@return Vector3
 ]=]
@@ -29,6 +31,7 @@ end
 
 --[=[
 	Computes the angle between 2 vectors in radians
+
 	@param a Vector3
 	@param b Vector3
 	@return number?
@@ -54,6 +57,7 @@ end
 
 --[=[
 	Computes the angle between 2 vectors in radians
+
 	@param a Vector3
 	@param b Vector3
 	@return number
@@ -66,6 +70,7 @@ end
 
 --[=[
 	Spherically lerps between start and finish
+
 	@param start Vector3
 	@param finish Vector3
 	@param t number -- Amount to slerp. 0 is start, 1 is finish. beyond that is extended as expected.
@@ -81,6 +86,7 @@ end
 
 --[=[
 	Constrains a Vector3 into a cone.
+
 	@param direction Vector3 -- The vector direction to constrain
 	@param coneDirection Vector3 -- The direction of the cone.
 	@param coneAngleRad -- Angle of the cone
@@ -114,4 +120,20 @@ 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))
 end
 
+--[=[
+	Checks if 2 Vector3 values are clsoe to each other
+
+	@param a Vector3
+	@param b Vector3
+	@param epsilon number
+	@return boolean
+]=]
+function Vector3Utils.areClose(a, b, epsilon)
+	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
+end
+
 return Vector3Utils