@quenty/getgroundplane 10.8.0 → 10.8.1

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 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/getgroundplane@10.8.0...@quenty/getgroundplane@10.8.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [10.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/getgroundplane@10.7.1...@quenty/getgroundplane@10.8.0) (2025-02-18)
 
 **Note:** Version bump only for package @quenty/getgroundplane

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/getgroundplane",
-  "version": "10.8.0",
+  "version": "10.8.1",
   "description": "Function that uses raycasting to determine the groundplane in Roblox",
   "keywords": [
     "Roblox",
@@ -25,7 +25,7 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^10.8.0"
+    "@quenty/loader": "^10.8.1"
   },
   "devDependencies": {
     "@quenty/loader": "file:../loader"
@@ -33,5 +33,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/batchRaycast.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Batch raycast utility function
 	@private
@@ -5,10 +6,11 @@
 ]=]
 
 local function batchRaycast(
-	originList, directionList,
-	ignoreListWorkingEnvironment,
-	ignoreFunc, keepIgnoreListChanges
-)
+	originList: {Vector3}, directionList: { Vector3 },
+	ignoreListWorkingEnvironment: { Instance },
+	ignoreFunc: (Instance) -> boolean, keepIgnoreListChanges: boolean
+): { RaycastResult }
+
 	local resultList = {}
 	local initialIgnoreListLength = #ignoreListWorkingEnvironment
 
@@ -19,7 +21,7 @@ local function batchRaycast(
 	for i in next, originList do
 		local origin = originList[i]
 		local direction = directionList[i]
-		local target--we'll use these later maybe
+		local target --we'll use these later maybe
 		local offset
 		while true do
 			local result = workspace:Raycast(origin, direction, params)
@@ -29,7 +31,7 @@ local function batchRaycast(
 
 				if not target then--initialize these
 					target = origin + direction
-					offset = 1e-3/direction.magnitude*direction
+					offset = 1e-3 / direction.Magnitude * direction
 				end
 
 				origin = result.Position - offset

package/src/Shared/getGroundPlane.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Function that uses raycasting to determine the groundplane in Roblox.
 	@class getGroundPlane
@@ -7,7 +8,7 @@ local require = require(script.Parent.loader).load(script)
 
 local batchRaycast = require("batchRaycast")
 
-local function resolvePlane(basis, points, norms)
+local function resolvePlane(basis: CFrame, points: { Vector3 }, norms: { Vector3 }): (Vector3?, Vector3?)
 	local n = #points
 
 	--[[
@@ -22,54 +23,55 @@ local function resolvePlane(basis, points, norms)
 	local xy, yz, yc = 0, 0, 0
 
 	for i = 1, n do
-		local p = basis:pointToObjectSpace(points[i])
-		local x = p.x
-		local y = p.y
-		local z = p.z
-		xx = xx + x*x
-		xz = xz + x*z
+		local p = basis:PointToObjectSpace(points[i])
+		local x = p.X
+		local y = p.Y
+		local z = p.Z
+		xx = xx + x * x
+		xz = xz + x * z
 		xc = xc + x
-		zz = zz + z*z
+		zz = zz + z * z
 		zc = zc + z
 		cc = cc + 1
-		xy = xy + x*y
-		yz = yz + y*z
+		xy = xy + x * y
+		yz = yz + y * z
 		yc = yc + y
 	end
 
-	local det = cc*xx*zz - cc*xz*xz + 2*xc*xz*zc - xx*zc*zc - xc*xc*zz
-	if det*det > 1e-12 then
-		local u = (cc*xy*zz - cc*xz*yz + xz*yc*zc + xc*yz*zc - xy*zc*zc - xc*yc*zz)/det
-		local v = (cc*xx*yz - cc*xy*xz + xc*xz*yc - xc*xc*yz + xc*xy*zc - xx*yc*zc)/det
-		local h = (xc*xz*yz - xz*xz*yc + xy*xz*zc - xx*yz*zc - xc*xy*zz + xx*yc*zz)/det
+	local det = cc * xx * zz - cc * xz * xz + 2 * xc * xz * zc - xx * zc * zc - xc * xc * zz
+	if det * det > 1e-12 then
+		local u = (cc * xy * zz - cc * xz * yz + xz * yc * zc + xc * yz * zc - xy * zc * zc - xc * yc * zz) / det
+		local v = (cc * xx * yz - cc * xy * xz + xc * xz * yc - xc * xc * yz + xc * xy * zc - xx * yc * zc) / det
+		local h = (xc * xz * yz - xz * xz * yc + xy * xz * zc - xx * yz * zc - xc * xy * zz + xx * yc * zz) / det
 		local pos = Vector3.new(0, h, 0)
-		local nrm = Vector3.new(-u, 1, -v).unit
-		return basis*pos, basis:vectorToWorldSpace(nrm), h, u, v
+		local nrm = Vector3.new(-u, 1, -v).Unit
+		return basis * pos, basis:VectorToWorldSpace(nrm), h, u, v
 	end
 
 	local uSum = 0
 	local vSum = 0
 	for i = 1, n do
-		local norm = basis:vectorToObjectSpace(norms[i])
-		local x = norm.x
-		local y = norm.y
-		local z = norm.z
-		uSum = uSum - x/y
-		vSum = vSum - z/y
+		local norm = basis:VectorToObjectSpace(norms[i])
+		local x = norm.X
+		local y = norm.Y
+		local z = norm.Z
+		uSum = uSum - x / y
+		vSum = vSum - z / y
 	end
 
 	if cc ~= 0 then
-		local u = uSum/cc
-		local v = vSum/cc
-		local h = (yc - u*xc - v*zc)/cc
+		local u = uSum / cc
+		local v = vSum / cc
+		local h = (yc - u * xc - v * zc) / cc
 		local pos = Vector3.new(0, h, 0)
-		local nrm = Vector3.new(-u, 1, -v).unit
-		return basis*pos, basis:vectorToWorldSpace(nrm), h, u, v
+		local nrm = Vector3.new(-u, 1, -v).Unit
+		return basis * pos, basis:VectorToWorldSpace(nrm), h, u, v
 	end
-end
 
+	return nil, nil
+end
 
-local goldenAngle = (3 - 5^0.5)*math.pi
+local goldenAngle = (3 - 5 ^ 0.5) * math.pi
 
 --[=[
 	Uses -y as the direction
@@ -92,34 +94,33 @@ local goldenAngle = (3 - 5^0.5)*math.pi
 	@within getGroundPlane
 ]=]
 local function getGroundPlane(
-	basis, radius, length, sampleCount,
-	ignoreList, ignoreFunc
-)
-	debug.profilebegin("create ray data")
+	basis: CFrame, radius: number, length: number, sampleCount: number,
+	ignoreList: { Instance }, ignoreFunc: (Instance) -> boolean
+): (Vector3?, Vector3?)
+	debug.profilebegin("createRayData")
+
 	local originList = table.create(sampleCount)
 	local directionList = table.create(sampleCount)
 
 	local d = basis:VectorToWorldSpace(Vector3.new(0, -length, 0))
 
 	for i = 1, sampleCount do
-		local r = radius*math.sqrt((i - 1)/sampleCount)
-		local x = r*math.cos(goldenAngle*i)
-		local z = r*math.sin(goldenAngle*i)
+		local r = radius * math.sqrt((i - 1) / sampleCount)
+		local x = r * math.cos(goldenAngle * i)
+		local z = r * math.sin(goldenAngle * i)
 		local o = basis:PointToWorldSpace(Vector3.new(x, 0, z))
 
 		originList[i] = o
 		directionList[i] = d
 	end
+
 	debug.profileend()
 
 	debug.profilebegin("batchRaycast")
-	local resultList = batchRaycast(
-		originList, directionList,
-		ignoreList, ignoreFunc, false
-	)
+	local resultList = batchRaycast(originList, directionList, ignoreList, ignoreFunc, false)
 	debug.profileend()
 
-	debug.profilebegin("separate raycast results")
+	debug.profilebegin("separateRaycastResults")
 	local n = 0
 	local poses = table.create(sampleCount)
 	local norms = table.create(sampleCount)