@quenty/r15utils 13.17.0-canary.544.de8fcee.0 → 13.17.1-canary.545.2374fb2.0

package/CHANGELOG.md

@@ -3,7 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [13.17.0-canary.544.de8fcee.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/r15utils@13.16.1...@quenty/r15utils@13.17.0-canary.544.de8fcee.0) (2025-04-01)
+## [13.17.1-canary.545.2374fb2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/r15utils@13.17.0...@quenty/r15utils@13.17.1-canary.545.2374fb2.0) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
+# [13.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/r15utils@13.16.2...@quenty/r15utils@13.17.0) (2025-04-02)
+
+**Note:** Version bump only for package @quenty/r15utils
+
+
+
+
+
+## [13.16.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/r15utils@13.16.1...@quenty/r15utils@13.16.2) (2025-03-31)
 
 **Note:** Version bump only for package @quenty/r15utils
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/r15utils",
-  "version": "13.17.0-canary.544.de8fcee.0",
+  "version": "13.17.1-canary.545.2374fb2.0",
   "description": "Utility methods for R15 Characters",
   "keywords": [
     "Roblox",
@@ -25,12 +25,12 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/brio": "14.17.0-canary.544.de8fcee.0",
-    "@quenty/instanceutils": "13.17.0-canary.544.de8fcee.0",
-    "@quenty/loader": "10.8.0"
+    "@quenty/brio": "14.17.1-canary.545.2374fb2.0",
+    "@quenty/instanceutils": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/loader": "10.8.1-canary.545.2374fb2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "de8fcee995fcdae464964357b4c770c03f4c7e03"
+  "gitHead": "2374fb2b043cfbe0e9b507b3316eec46a4e353a0"
 }

package/src/Shared/R15Utils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility methods for R15 Characters. R15 is a specific Roblox character specification.
 
@@ -21,7 +22,12 @@ function R15Utils.searchForRigAttachment(character: Model, partName: string, att
 		return nil
 	end
 
-	return part:FindFirstChild(attachmentName)
+	local result = part:FindFirstChild(attachmentName)
+	if result == nil or not result:IsA("Attachment") then
+		return nil
+	end
+
+	return result
 end
 
 --[=[
@@ -42,7 +48,7 @@ function R15Utils.getRigMotor(character: Model, partName: string, motorName: str
 	end
 
 	local motor = basePart:FindFirstChild(motorName)
-	if not motor then
+	if motor == nil or not motor:IsA("Motor6D") then
 		return nil
 	end
 
@@ -86,12 +92,7 @@ end
 	@return Motor6D?
 ]=]
 function R15Utils.getWaistJoint(character: Model): Motor6D?
-	local upperTorso = R15Utils.getUpperTorso(character)
-	if not upperTorso then
-		return nil
-	end
-
-	return upperTorso:FindFirstChild("Waist")
+	return R15Utils.getRigMotor(character, "UpperTorso", "Waist")
 end
 
 --[=[
@@ -99,13 +100,8 @@ end
 	@param character Model
 	@return Motor6D?
 ]=]
-function R15Utils.getNeckJoint(character: Model)
-	local head = character:FindFirstChild("Head")
-	if not head then
-		return nil
-	end
-
-	return head:FindFirstChild("Neck")
+function R15Utils.getNeckJoint(character: Model): Motor6D?
+	return R15Utils.getRigMotor(character, "Head", "Neck")
 end
 
 --[=[
@@ -114,8 +110,13 @@ end
 	@param side "Left" | "Right"
 	@return Attachment?
 ]=]
-function R15Utils.getHand(character: Model, side: R15Side)
-	return character:FindFirstChild(R15Utils.getHandName(side))
+function R15Utils.getHand(character: Model, side: R15Side): BasePart?
+	local result = character:FindFirstChild(R15Utils.getHandName(side))
+	if result == nil or not result:IsA("BasePart") then
+		return nil
+	end
+
+	return result
 end
 
 --[=[
@@ -126,11 +127,16 @@ end
 ]=]
 function R15Utils.getGripWeld(character: Model, side: R15Side): Motor6D?
 	local rightHand = R15Utils.getHand(character, side)
-	if rightHand then
-		return rightHand:FindFirstChild(R15Utils.getGripWeldName(side))
-	else
+	if rightHand == nil then
 		return nil
 	end
+
+	local result = rightHand:FindFirstChild(R15Utils.getGripWeldName(side))
+	if result == nil or not result:IsA("Motor6D") then
+		return nil
+	end
+
+	return result
 end
 
 --[=[
@@ -138,7 +144,7 @@ end
 	@param side "Left" | "Right"
 	@return "LeftGrip" | "RightGrip"
 ]=]
-function R15Utils.getGripWeldName(side: R15Side)
+function R15Utils.getGripWeldName(side: R15Side): "LeftGrip" | "RightGrip"
 	if side == "Left" then
 		return "LeftGrip"
 	elseif side == "Right" then
@@ -153,7 +159,7 @@ end
 	@param side "Left" | "Right"
 	@return "LeftHand" | "RightHand"
 ]=]
-function R15Utils.getHandName(side)
+function R15Utils.getHandName(side: R15Side): "LeftHand" | "RightHand"
 	if side == "Left" then
 		return "LeftHand"
 	elseif side == "Right" then
@@ -232,7 +238,12 @@ end
 	@param rigAttachment1 string
 	@return number?
 ]=]
-function R15Utils.getRigLength(character: Model, partName: string, rigAttachment0: string, rigAttachment1: string)
+function R15Utils.getRigLength(
+	character: Model,
+	partName: string,
+	rigAttachment0: string,
+	rigAttachment1: string
+): number?
 	local attachment0 = R15Utils.searchForRigAttachment(character, partName, rigAttachment0)
 	if not attachment0 then
 		return nil
@@ -243,7 +254,7 @@ function R15Utils.getRigLength(character: Model, partName: string, rigAttachment
 		return nil
 	end
 
-	return (attachment0.Position - attachment1.Position).magnitude
+	return (attachment0.Position - attachment1.Position).Magnitude
 end
 
 --[=[
@@ -253,7 +264,7 @@ end
 ]=]
 function R15Utils.addLengthsOrNil(lengths: { number? }): number?
 	local total = 0
-	for _, length in pairs(lengths) do
+	for _, length in lengths do
 		if not length then
 			return nil
 		end
@@ -270,7 +281,7 @@ end
 	@param side "Left" | "Right"
 	@return number?
 ]=]
-function R15Utils.getUpperArmRigLength(character: Model, side: R15Side)
+function R15Utils.getUpperArmRigLength(character: Model, side: R15Side): number?
 	if side == "Left" then
 		return R15Utils.getRigLength(character, "LeftUpperArm", "LeftShoulderRigAttachment", "LeftElbowRigAttachment")
 	elseif side == "Right" then
@@ -327,7 +338,7 @@ function R15Utils.getHumanoidScaleProperty(humanoid: Humanoid, scaleValueName: s
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
 	local scaleValue = humanoid:FindFirstChild(scaleValueName)
-	if scaleValue then
+	if scaleValue and scaleValue:IsA("NumberValue") then
 		return scaleValue.Value
 	else
 		return nil
@@ -340,7 +351,7 @@ end
 	@param side "Left" | "Right"
 	@return number?
 ]=]
-function R15Utils.getArmRigToGripLength(character: Model, side: R15Side)
+function R15Utils.getArmRigToGripLength(character: Model, side: R15Side): number?
 	return R15Utils.addLengthsOrNil({
 		R15Utils.getUpperArmRigLength(character, side),
 		R15Utils.getLowerArmRigLength(character, side),

package/src/Shared/RxR15Utils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility methods to query components of an R15 character.
 	@class RxR15Utils
@@ -8,6 +9,8 @@ local require = require(script.Parent.loader).load(script)
 local RxInstanceUtils = require("RxInstanceUtils")
 local RxBrioUtils = require("RxBrioUtils")
 
+export type R15Side = "Left" | "Right"
+
 local RxR15Utils = {}
 
 --[=[
@@ -17,17 +20,16 @@ local RxR15Utils = {}
 	@param attachmentName string
 	@return Observable<Brio<Attachment>>
 ]=]
-function RxR15Utils.observeRigAttachmentBrio(character, partName, attachmentName)
+function RxR15Utils.observeRigAttachmentBrio(character: Model, partName: string, attachmentName: string)
 	assert(typeof(character) == "Instance", "Bad character")
 	assert(type(partName) == "string", "Bad partName")
 	assert(type(attachmentName) == "string", "Bad attachmentName")
 
-	return RxR15Utils.observeCharacterPartBrio(character, partName)
-		:Pipe({
-			RxBrioUtils.switchMapBrio(function(part)
-				return RxInstanceUtils.observeLastNamedChildBrio(part, "Attachment", attachmentName)
-			end);
-		})
+	return RxR15Utils.observeCharacterPartBrio(character, partName):Pipe({
+		RxBrioUtils.switchMapBrio(function(part)
+			return RxInstanceUtils.observeLastNamedChildBrio(part, "Attachment", attachmentName)
+		end),
+	})
 end
 
 --[=[
@@ -37,18 +39,17 @@ end
 	@param motorName string
 	@return Observable<Brio<Motor6D>>
 ]=]
-function RxR15Utils.observeRigMotorBrio(character, partName, motorName)
+function RxR15Utils.observeRigMotorBrio(character: Model, partName: string, motorName: string)
 	assert(typeof(character) == "Instance", "Bad character")
 	assert(type(partName) == "string", "Bad partName")
 	assert(type(motorName) == "string", "Bad motorName")
 
-	return RxInstanceUtils.observeLastNamedChildBrio(character, "BasePart", partName)
-		:Pipe({
-			RxBrioUtils.switchMapBrio(function(part)
-				return RxInstanceUtils.observeLastNamedChildBrio(part, "Motor6D", motorName)
-			end);
-			RxBrioUtils.onlyLastBrioSurvives();
-		})
+	return RxInstanceUtils.observeLastNamedChildBrio(character, "BasePart", partName):Pipe({
+		RxBrioUtils.switchMapBrio(function(part)
+			return RxInstanceUtils.observeLastNamedChildBrio(part, "Motor6D", motorName)
+		end),
+		RxBrioUtils.onlyLastBrioSurvives(),
+	})
 end
 
 --[=[
@@ -58,18 +59,17 @@ end
 	@param weldName string
 	@return Observable<Brio<Motor6D>>
 ]=]
-function RxR15Utils.observeRigWeldBrio(character, partName, weldName)
+function RxR15Utils.observeRigWeldBrio(character: Model, partName: string, weldName: string)
 	assert(typeof(character) == "Instance", "Bad character")
 	assert(type(partName) == "string", "Bad partName")
 	assert(type(weldName) == "string", "Bad weldName")
 
-	return RxInstanceUtils.observeLastNamedChildBrio(character, "BasePart", partName)
-		:Pipe({
-			RxBrioUtils.switchMapBrio(function(part)
-				return RxInstanceUtils.observeLastNamedChildBrio(part, "Weld", weldName)
-			end);
-			RxBrioUtils.onlyLastBrioSurvives();
-		})
+	return RxInstanceUtils.observeLastNamedChildBrio(character, "BasePart", partName):Pipe({
+		RxBrioUtils.switchMapBrio(function(part)
+			return RxInstanceUtils.observeLastNamedChildBrio(part, "Weld", weldName)
+		end),
+		RxBrioUtils.onlyLastBrioSurvives(),
+	})
 end
 
 --[=[
@@ -78,7 +78,7 @@ end
 	@param partName string
 	@return Observable<Brio<BasePart>>
 ]=]
-function RxR15Utils.observeCharacterPartBrio(character, partName)
+function RxR15Utils.observeCharacterPartBrio(character: Model, partName: string)
 	assert(typeof(character) == "Instance", "Bad character")
 	assert(type(partName) == "string", "Bad partName")
 
@@ -90,29 +90,29 @@ end
 	@param character Model
 	@return Observable<Brio<Humanoid>>
 ]=]
-function RxR15Utils.observeHumanoidBrio(character)
+function RxR15Utils.observeHumanoidBrio(character: Model)
 	assert(typeof(character) == "Instance", "Bad character")
 
 	return RxInstanceUtils.observeLastNamedChildBrio(character, "Humanoid", "Humanoid")
 end
 
-function RxR15Utils.observeHumanoidScaleValueObject(humanoid, scaleValueName)
+function RxR15Utils.observeHumanoidScaleValueObject(humanoid: Humanoid, scaleValueName: string)
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
 	return RxInstanceUtils.observeLastNamedChildBrio(humanoid, "NumberValue", scaleValueName)
 end
 
-function RxR15Utils.observeHumanoidScaleProperty(humanoid, scaleValueName)
+function RxR15Utils.observeHumanoidScaleProperty(humanoid: Humanoid, scaleValueName: string)
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
 	return RxR15Utils.observeHumanoidScaleValueObject(humanoid, scaleValueName):Pipe({
 		RxBrioUtils.switchMapBrio(function(scaleValue)
 			return RxInstanceUtils.observeProperty(scaleValue, "Value")
-		end)
+		end),
 	})
 end
 
-function RxR15Utils.observeShoulderRigAttachmentBrio(character, side)
+function RxR15Utils.observeShoulderRigAttachmentBrio(character: Model, side: R15Side)
 	if side == "Left"  then
 		return RxR15Utils.observeRigAttachmentBrio(character, "UpperTorso", "LeftShoulderRigAttachment")
 	elseif side == "Right" then