@quenty/rigbuilderutils 10.19.0 → 10.19.1-canary.545.2374fb2.0

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.19.1-canary.545.2374fb2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rigbuilderutils@10.19.0...@quenty/rigbuilderutils@10.19.1-canary.545.2374fb2.0) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [10.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rigbuilderutils@10.18.2...@quenty/rigbuilderutils@10.19.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/rigbuilderutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/rigbuilderutils",
-  "version": "10.19.0",
+  "version": "10.19.1-canary.545.2374fb2.0",
   "description": "Utility functions for debugging, builds a Roblox character rig",
   "keywords": [
     "Roblox",
@@ -26,18 +26,18 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/assetserviceutils": "^5.19.0",
-    "@quenty/humanoiddescriptionutils": "^10.10.1",
-    "@quenty/insertserviceutils": "^10.10.1",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/promise": "^10.10.1"
+    "@quenty/assetserviceutils": "5.19.1-canary.545.2374fb2.0",
+    "@quenty/humanoiddescriptionutils": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/insertserviceutils": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/loader": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/promise": "10.10.2-canary.545.2374fb2.0"
   },
   "devDependencies": {
-    "@quenty/camerastoryutils": "^10.10.1",
-    "@quenty/maid": "^3.4.0"
+    "@quenty/camerastoryutils": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/maid": "3.4.1-canary.545.2374fb2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "2374fb2b043cfbe0e9b507b3316eec46a4e353a0"
 }

package/src/Shared/RigBuilderUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Helps build player characters or other humanoid rigs for use in a variety of situations.
 	@class RigBuilderUtils
@@ -15,17 +16,17 @@ local HumanoidDescriptionUtils = require("HumanoidDescriptionUtils")
 
 local RigBuilderUtils = {}
 
-local function jointBetween(a, b, cfa, cfb)
-    local weld = Instance.new("Motor6D")
-    weld.Part0 = a
-    weld.Part1 = b
-    weld.C0 = cfa
-    weld.C1 = cfb
-    weld.Parent = a
-    return weld
+local function jointBetween(a: BasePart, b: BasePart, cfa: CFrame, cfb: CFrame): Motor6D
+	local weld = Instance.new("Motor6D")
+	weld.Part0 = a
+	weld.Part1 = b
+	weld.C0 = cfa
+	weld.C1 = cfb
+	weld.Parent = a
+	return weld
 end
 
-local function addAttachment(part, name, position, orientation)
+local function addAttachment(part: BasePart, name: string, position: Vector3?, orientation: Vector3?): Attachment
 	local attachment = Instance.new("Attachment")
 	attachment.Name = name
 	attachment.Parent = part
@@ -46,7 +47,7 @@ end
 function RigBuilderUtils.disableAnimateScript(rig: Model)
 	local animate = RigBuilderUtils.findAnimateScript(rig)
 	if animate then
-		animate.Enabled = false
+		(animate :: any).Enabled = false
 	end
 end
 
@@ -56,16 +57,16 @@ end
 	@param rig Model
 	@return LocalScript?
 ]=]
-function RigBuilderUtils.findAnimateScript(rig: Model)
+function RigBuilderUtils.findAnimateScript(rig: Model): (Script | LocalScript)?
 	local animate = rig:FindFirstChild("Animate")
 	if animate and (animate:IsA("LocalScript") or animate:IsA("Script")) then
-		return animate
+		return animate :: any
 	end
 
 	return nil
 end
 
-function RigBuilderUtils.createR6BaseRig()
+function RigBuilderUtils.createR6BaseRig(): Model
 	local character = Instance.new("Model")
 	character.Name = "Dummy"
 
@@ -76,8 +77,8 @@ function RigBuilderUtils.createR6BaseRig()
 	root.Transparency = 1
 	root.Size = Vector3.new(2, 2, 1)
 	root.CFrame = CFrame.new(0, 5.2, 4.5)
-	root.BottomSurface = "Smooth"
-	root.TopSurface = "Smooth"
+	root.BottomSurface = Enum.SurfaceType.Smooth
+	root.TopSurface = Enum.SurfaceType.Smooth
 	root.Parent = character
 	character.PrimaryPart = root
 
@@ -87,95 +88,88 @@ function RigBuilderUtils.createR6BaseRig()
 	torso.CanCollide = false
 	torso.Size = Vector3.new(2, 2, 1)
 	torso.CFrame = CFrame.new(0, 5.2, 4.5)
-	torso.BottomSurface = "Smooth"
-	torso.TopSurface = "Smooth"
+	torso.BottomSurface = Enum.SurfaceType.Smooth
+	torso.TopSurface = Enum.SurfaceType.Smooth
 	torso.Parent = character
 
-	local RCA = CFrame.new(0, 0, 0, -1, 0, 0, 0, 0, 1, 0, 1, 0 )
+	local RCA = CFrame.new(0, 0, 0, -1, 0, 0, 0, 0, 1, 0, 1, 0)
 	local RCB = RCA
 	local rootHip = jointBetween(root, torso, RCA, RCB)
 	rootHip.Name = "Root Hip"
 	rootHip.MaxVelocity = 0.1
 
-
 	local leftLeg = Instance.new("Part")
 	leftLeg.Name = "Left Leg"
 	leftLeg.Anchored = false
 	leftLeg.CanCollide = false
 	leftLeg.Size = Vector3.new(1, 2, 1)
 	leftLeg.CFrame = CFrame.new(0.5, 3.2, 4.5)
-	leftLeg.BottomSurface = "Smooth"
-	leftLeg.TopSurface = "Smooth"
+	leftLeg.BottomSurface = Enum.SurfaceType.Smooth
+	leftLeg.TopSurface = Enum.SurfaceType.Smooth
 	leftLeg.Parent = character
 
-	local LHCA = CFrame.new(-1, -1, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), -math.pi/2)
-	local LHCB = CFrame.new(-0.5, 1, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), -math.pi/2)
+	local LHCA = CFrame.new(-1, -1, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), -math.pi / 2)
+	local LHCB = CFrame.new(-0.5, 1, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), -math.pi / 2)
 	local leftHip = jointBetween(torso, leftLeg, LHCA, LHCB)
 	leftHip.Name = "Left Hip"
 	leftHip.MaxVelocity = 0.1
 
-
 	local rightLeg = Instance.new("Part")
 	rightLeg.Name = "Right Leg"
 	rightLeg.Anchored = false
 	rightLeg.CanCollide = false
 	rightLeg.Size = Vector3.new(1, 2, 1)
 	rightLeg.CFrame = CFrame.new(-0.5, 3.2, 4.5)
-	rightLeg.BottomSurface = "Smooth"
-	rightLeg.TopSurface = "Smooth"
+	rightLeg.BottomSurface = Enum.SurfaceType.Smooth
+	rightLeg.TopSurface = Enum.SurfaceType.Smooth
 	rightLeg.Parent = character
 
-
-	local RHCA = CFrame.new(1, -1, 0) * CFrame.fromAxisAngle(Vector3.new(0, -1, 0), -math.pi/2)
-	local RHCB = CFrame.new(0.5, 1, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), math.pi/2)
+	local RHCA = CFrame.new(1, -1, 0) * CFrame.fromAxisAngle(Vector3.new(0, -1, 0), -math.pi / 2)
+	local RHCB = CFrame.new(0.5, 1, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), math.pi / 2)
 	local rightHip = jointBetween(torso, rightLeg, RHCA, RHCB)
 	rightHip.Name = "Right Hip"
 	rightHip.MaxVelocity = 0.1
 
-
 	local leftArm = Instance.new("Part")
 	leftArm.Name = "Left Arm"
 	leftArm.Anchored = false
 	leftArm.CanCollide = false
 	leftArm.Size = Vector3.new(1, 2, 1)
 	leftArm.CFrame = CFrame.new(1.5, 5.2, 4.5)
-	leftArm.BottomSurface = "Smooth"
-	leftArm.TopSurface = "Smooth"
+	leftArm.BottomSurface = Enum.SurfaceType.Smooth
+	leftArm.TopSurface = Enum.SurfaceType.Smooth
 	leftArm.Parent = character
 
-
-	local LSCA = CFrame.new(-1.0, 0.5, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), -math.pi/2)
-	local LSCB = CFrame.new(0.5, 0.5, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), -math.pi/2)
+	local LSCA = CFrame.new(-1.0, 0.5, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), -math.pi / 2)
+	local LSCB = CFrame.new(0.5, 0.5, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), -math.pi / 2)
 	local leftShoulder = jointBetween(torso, leftArm, LSCA, LSCB)
 	leftShoulder.Name = "Left Shoulder"
 	leftShoulder.MaxVelocity = 0.1
 
-
 	local rightArm = Instance.new("Part")
 	rightArm.Name = "Right Arm"
 	rightArm.Anchored = false
 	rightArm.CanCollide = false
 	rightArm.Size = Vector3.new(1, 2, 1)
 	rightArm.CFrame = CFrame.new(-1.5, 5.2, 4.5)
-	rightArm.BottomSurface = "Smooth"
-	rightArm.TopSurface = "Smooth"
+	rightArm.BottomSurface = Enum.SurfaceType.Smooth
+	rightArm.TopSurface = Enum.SurfaceType.Smooth
 	rightArm.Parent = character
 
-	local RSCA = CFrame.new(1.0, 0.5, 0) * CFrame.fromAxisAngle(Vector3.new(0, -1, 0), -math.pi/2)
-	local RSCB = CFrame.new(-0.5, 0.5, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), math.pi/2)
+	local RSCA = CFrame.new(1.0, 0.5, 0) * CFrame.fromAxisAngle(Vector3.new(0, -1, 0), -math.pi / 2)
+	local RSCB = CFrame.new(-0.5, 0.5, 0) * CFrame.fromAxisAngle(Vector3.new(0, 1, 0), math.pi / 2)
 	local rightShoulder = jointBetween(torso, rightArm, RSCA, RSCB)
 	rightShoulder.Name = "Right Shoulder"
 	rightShoulder.MaxVelocity = 0.1
 
-
 	local head = Instance.new("Part")
 	head.Name = "Head"
 	head.Anchored = false
 	head.CanCollide = true
 	head.Size = Vector3.new(2, 1, 1)
 	head.CFrame = CFrame.new(0, 6.7, 4.5)
-	head.BottomSurface = "Smooth"
-	head.TopSurface = "Smooth"
+	head.BottomSurface = Enum.SurfaceType.Smooth
+	head.TopSurface = Enum.SurfaceType.Smooth
 	head.Parent = character
 
 	local NCA = CFrame.new(0, 1, 0, -1, 0, 0, 0, 0, 1, 0, 1, 0)
@@ -197,125 +191,125 @@ end
 
 --[=[
 	Creates an R6 mesh rig
-	@return Instance
+	@return Model
 ]=]
-function RigBuilderUtils.createR6MeshRig()
+function RigBuilderUtils.createR6MeshRig(): Model
 	local rig = RigBuilderUtils.createR6BaseRig()
 
 	local lArmMesh = Instance.new("CharacterMesh")
 	lArmMesh.MeshId = 27111419
-	lArmMesh.BodyPart = 2
+	lArmMesh.BodyPart = Enum.BodyPart.LeftArm
 	lArmMesh.Parent = rig
 
 	local rArmMesh = Instance.new("CharacterMesh")
 	rArmMesh.MeshId = 27111864
-	rArmMesh.BodyPart = 3
+	rArmMesh.BodyPart = Enum.BodyPart.RightArm
 	rArmMesh.Parent = rig
 
 	local lLegMesh = Instance.new("CharacterMesh")
 	lLegMesh.MeshId = 27111857
-	lLegMesh.BodyPart = 4
+	lLegMesh.BodyPart = Enum.BodyPart.LeftLeg
 	lLegMesh.Parent = rig
 
 	local rLegMesh = Instance.new("CharacterMesh")
 	rLegMesh.MeshId = 27111882
-	rLegMesh.BodyPart = 5
+	rLegMesh.BodyPart = Enum.BodyPart.RightLeg
 	rLegMesh.Parent = rig
 
 	local torsoMesh = Instance.new("CharacterMesh")
 	torsoMesh.MeshId = 27111894
-	torsoMesh.BodyPart = 1
+	torsoMesh.BodyPart = Enum.BodyPart.Torso
 	torsoMesh.Parent = rig
 
 	local headMesh = Instance.new("SpecialMesh")
-	headMesh.MeshType = 0
+	headMesh.MeshType = Enum.MeshType.Head
 	headMesh.Scale = Vector3.new(1.25, 1.25, 1.25)
-	headMesh.Parent = rig.Head
+	headMesh.Parent = (rig :: any).Head
 
 	return rig
 end
 
 --[=[
 	Creates an R6 boy mesh rig
-	@return Instance
+	@return Model
 ]=]
-function RigBuilderUtils.createR6MeshBoyRig()
+function RigBuilderUtils.createR6MeshBoyRig(): Model
 	local rig = RigBuilderUtils.createR6BaseRig()
 
 	local lArmMesh = Instance.new("CharacterMesh")
 	lArmMesh.MeshId = 82907977
-	lArmMesh.BodyPart = 2
+	lArmMesh.BodyPart = Enum.BodyPart.LeftArm
 	lArmMesh.Parent = rig
 
 	local rArmMesh = Instance.new("CharacterMesh")
 	rArmMesh.MeshId = 82908019
-	rArmMesh.BodyPart = 3
+	rArmMesh.BodyPart = Enum.BodyPart.RightArm
 	rArmMesh.Parent = rig
 
 	local lLegMesh = Instance.new("CharacterMesh")
 	lLegMesh.MeshId = 81487640
-	lLegMesh.BodyPart = 4
+	lLegMesh.BodyPart = Enum.BodyPart.LeftLeg
 	lLegMesh.Parent = rig
 
 	local rLegMesh = Instance.new("CharacterMesh")
 	rLegMesh.MeshId = 81487710
-	rLegMesh.BodyPart = 5
+	rLegMesh.BodyPart = Enum.BodyPart.RightLeg
 	rLegMesh.Parent = rig
 
 	local torsoMesh = Instance.new("CharacterMesh")
 	torsoMesh.MeshId = 82907945
-	torsoMesh.BodyPart = 1
+	torsoMesh.BodyPart = Enum.BodyPart.Torso
 	torsoMesh.Parent = rig
 
 	local headMesh = Instance.new("SpecialMesh")
-	headMesh.MeshType = 0
+	headMesh.MeshType = Enum.MeshType.Head
 	headMesh.Scale = Vector3.new(1.25, 1.25, 1.25)
-	headMesh.Parent = rig.Head
+	headMesh.Parent = (rig :: any).Head
 
 	return rig
 end
 
 --[=[
 	Creates an R6 girl mesh rig
-	@return Instance
+	@return Model
 ]=]
-function RigBuilderUtils.createR6MeshGirlRig()
+function RigBuilderUtils.createR6MeshGirlRig(): Model
 	local rig = RigBuilderUtils.createR6BaseRig()
 
 	local lArmMesh = Instance.new("CharacterMesh")
 	lArmMesh.MeshId = 83001137
-	lArmMesh.BodyPart = 2
+	lArmMesh.BodyPart = Enum.BodyPart.LeftArm
 	lArmMesh.Parent = rig
 
 	local rArmMesh = Instance.new("CharacterMesh")
 	rArmMesh.MeshId = 83001181
-	rArmMesh.BodyPart = 3
+	rArmMesh.BodyPart = Enum.BodyPart.RightArm
 	rArmMesh.Parent = rig
 
 	local lLegMesh = Instance.new("CharacterMesh")
 	lLegMesh.MeshId = 81628361
-	lLegMesh.BodyPart = 4
+	lLegMesh.BodyPart = Enum.BodyPart.LeftLeg
 	lLegMesh.Parent = rig
 
 	local rLegMesh = Instance.new("CharacterMesh")
 	rLegMesh.MeshId = 81628308
-	rLegMesh.BodyPart = 5
+	rLegMesh.BodyPart = Enum.BodyPart.RightLeg
 	rLegMesh.Parent = rig
 
 	local torsoMesh = Instance.new("CharacterMesh")
 	torsoMesh.MeshId = 82987757
-	torsoMesh.BodyPart = 1
+	torsoMesh.BodyPart = Enum.BodyPart.Torso
 	torsoMesh.Parent = rig
 
 	local headMesh = Instance.new("SpecialMesh")
-	headMesh.MeshType = 0
+	headMesh.MeshType = Enum.MeshType.Head
 	headMesh.Scale = Vector3.new(1.25, 1.25, 1.25)
-	headMesh.Parent = rig.Head
+	headMesh.Parent = (rig :: any).Head
 
 	return rig
 end
 
-function RigBuilderUtils._createR15BaseRig()
+function RigBuilderUtils._createR15BaseRig(): (Model, Humanoid)
 	local character = Instance.new("Model")
 	character.Name = "Dummy"
 
@@ -325,18 +319,18 @@ function RigBuilderUtils._createR15BaseRig()
 
 	local rootPart = Instance.new("Part")
 	rootPart.Name = "HumanoidRootPart"
-	rootPart.Size = Vector3.new(2,2,1)
+	rootPart.Size = Vector3.new(2, 2, 1)
 	rootPart.Transparency = 1
 	rootPart.Parent = character
-	addAttachment(rootPart,"RootRigAttachment")
+	addAttachment(rootPart, "RootRigAttachment")
 
 	local head = Instance.new("Part")
 	head.Name = "Head"
-	head.Size = Vector3.new(2,1,1)
+	head.Size = Vector3.new(2, 1, 1)
 	head.Parent = character
 
 	local headMesh = Instance.new("SpecialMesh")
-	headMesh.Scale = Vector3.new(1.25,1.25,1.25)
+	headMesh.Scale = Vector3.new(1.25, 1.25, 1.25)
 	headMesh.MeshType = Enum.MeshType.Head
 	headMesh.Parent = head
 
@@ -346,10 +340,10 @@ function RigBuilderUtils._createR15BaseRig()
 	face.Parent = head
 
 	addAttachment(head, "FaceCenterAttachment")
-	addAttachment(head, "FaceFrontAttachment", Vector3.new(0,0,-0.6))
-	addAttachment(head, "HairAttachment", Vector3.new(0,0.6,0))
-	addAttachment(head, "HatAttachment", Vector3.new(0,0.6,0))
-	addAttachment(head, "NeckRigAttachment", Vector3.new(0,-0.5,0))
+	addAttachment(head, "FaceFrontAttachment", Vector3.new(0, 0, -0.6))
+	addAttachment(head, "HairAttachment", Vector3.new(0, 0.6, 0))
+	addAttachment(head, "HatAttachment", Vector3.new(0, 0.6, 0))
+	addAttachment(head, "NeckRigAttachment", Vector3.new(0, -0.5, 0))
 
 	character.PrimaryPart = rootPart
 
@@ -361,31 +355,32 @@ end
 	@param packageAssetId number
 	@return Promise<Instance>
 ]=]
-function RigBuilderUtils.promiseR15PackageRig(packageAssetId)
+function RigBuilderUtils.promiseR15PackageRig(packageAssetId: number): Promise.Promise<Model>
 	assert(type(packageAssetId) == "number", "Bad packageAssetId")
 
 	return AssetServiceUtils.promiseAssetIdsForPackage(packageAssetId)
 		:Then(function(assetIds)
 			local promises = {}
-			for _, assetId in pairs(assetIds) do
+			for _, assetId in assetIds do
 				table.insert(promises, InsertServiceUtils.promiseAsset(assetId))
 			end
 			return PromiseUtils.all(promises)
 		end)
 		:Then(function(...)
-			local limbs = {...}
+			local limbs = { ... }
 			local character, humanoid = RigBuilderUtils._createR15BaseRig()
+			local head = (character :: any).Head
 
 			local face = nil
 			local headMesh = nil
 
-			for _, limb in pairs(limbs) do
+			for _, limb in limbs do
 				if limb:FindFirstChild("R15ArtistIntent") then
-					for _, x in pairs(limb.R15ArtistIntent:GetChildren()) do
+					for _, x in limb.R15ArtistIntent:GetChildren() do
 						x.Parent = character
 					end
 				elseif limb:FindFirstChild("R15") then
-					for _, x in pairs(limb.R15:GetChildren()) do
+					for _, x in limb.R15:GetChildren() do
 						x.Parent = character
 					end
 				elseif limb:FindFirstChild("face") then
@@ -398,17 +393,17 @@ function RigBuilderUtils.promiseR15PackageRig(packageAssetId)
 			end
 
 			if headMesh then
-				character.Head.Mesh:Destroy()
-				headMesh.Parent = character.Head
+				head.Mesh:Destroy()
+				headMesh.Parent = head
 			end
 
 			if face then
-				for _, v in pairs(character.Head:GetChildren()) do
+				for _, v in head:GetChildren() do
 					if v.Name == "face" or v.Name == "Face" then
 						v:Destroy()
 					end
 				end
-				face.Parent = character.Head
+				face.Parent = head
 			end
 
 			humanoid:BuildRigFromAttachments()
@@ -422,37 +417,36 @@ end
 	@return Promise<Instance>
 ]=]
 function RigBuilderUtils.promiseR15Rig()
-	return InsertServiceUtils.promiseAsset(1664543044)
-		:Then(function(inserted)
-			local character = inserted:GetChildren()[1]
-			if not character then
-				return Promise.rejected("No character from model")
-			end
+	return InsertServiceUtils.promiseAsset(1664543044):Then(function(inserted)
+		local character = inserted:GetChildren()[1]
+		if not character then
+			return Promise.rejected("No character from model")
+		end
 
-			local humanoid = character:FindFirstChildOfClass("Humanoid")
-			if humanoid then
-				humanoid:BuildRigFromAttachments()
-			end
+		local humanoid = character:FindFirstChildOfClass("Humanoid")
+		if humanoid then
+			humanoid:BuildRigFromAttachments()
+		end
 
-			local r15Head = character:FindFirstChild("Head")
+		local r15Head = character:FindFirstChild("Head")
 
-			local existingFace = r15Head:FindFirstChild("face") or r15Head:FindFirstChild("Face")
-			if existingFace == nil then
-				local face = Instance.new("Decal")
-				face.Name = "face"
-				face.Texture = "rbxasset://textures/face.png"
-				face.Parent = r15Head
-			end
+		local existingFace = r15Head:FindFirstChild("face") or r15Head:FindFirstChild("Face")
+		if existingFace == nil then
+			local face = Instance.new("Decal")
+			face.Name = "face"
+			face.Texture = "rbxasset://textures/face.png"
+			face.Parent = r15Head
+		end
 
-			return character
-		end)
+		return character
+	end)
 end
 
 --[=[
 	Creates an R15 man rig
 	@return Promise<Instance>
 ]=]
-function RigBuilderUtils.promiseR15ManRig()
+function RigBuilderUtils.promiseR15ManRig(): Promise.Promise<Model>
 	return RigBuilderUtils.promiseR15PackageRig(86500185)
 end
 
@@ -460,7 +454,7 @@ end
 	Creates an R15 woman rig
 	@return Promise<Instance>
 ]=]
-function RigBuilderUtils.promiseR15WomanRig()
+function RigBuilderUtils.promiseR15WomanRig(): Promise.Promise<Model>
 	return RigBuilderUtils.promiseR15PackageRig(86499905)
 end
 
@@ -468,7 +462,7 @@ end
 	Creates an R15 mesh rig
 	@return Promise<Instance>
 ]=]
-function RigBuilderUtils.promiseR15MeshRig()
+function RigBuilderUtils.promiseR15MeshRig(): Promise.Promise<Model>
 	return RigBuilderUtils.promiseR15PackageRig(27112438)
 end
 
@@ -479,33 +473,44 @@ end
 	@param assetTypeVerification AssetTypeVerification | nil
 	@return Promise<Instance>
 ]=]
-function RigBuilderUtils.promiseBasePlayerRig(userId, humanoidRigType, assetTypeVerification)
+function RigBuilderUtils.promiseBasePlayerRig(
+	userId: number,
+	humanoidRigType: Enum.HumanoidRigType?,
+	assetTypeVerification: Enum.AssetTypeVerification?
+): Promise.Promise<Model>
 	assert(type(userId) == "number", "Bad userId")
 	assert(typeof(humanoidRigType) == "EnumItem" or humanoidRigType == nil, "Bad humanoidRigType")
 	assert(typeof(assetTypeVerification) == "EnumItem" or assetTypeVerification == nil, "Bad assetTypeVerification")
 
-	return HumanoidDescriptionUtils.promiseFromUserId(userId)
-		:Then(function(playerHumanoidDescription)
-			-- Wipe accessories
-			local humanoidDescription = playerHumanoidDescription:Clone()
-			humanoidDescription.BackAccessory = ""
-			humanoidDescription.FaceAccessory = ""
-			humanoidDescription.FrontAccessory = ""
-			humanoidDescription.HairAccessory = ""
-			humanoidDescription.HatAccessory = ""
-			humanoidDescription.NeckAccessory = ""
-			humanoidDescription.ShouldersAccessory = ""
-			humanoidDescription.WaistAccessory = ""
-			humanoidDescription.GraphicTShirt = 0
-			humanoidDescription.Shirt = 0
-			humanoidDescription.Pants = 0
-			humanoidDescription:SetAccessories({}, true)
-
-			return RigBuilderUtils.promiseHumanoidModelFromDescription(humanoidDescription, humanoidRigType, assetTypeVerification)
-		end)
+	return HumanoidDescriptionUtils.promiseFromUserId(userId):Then(function(playerHumanoidDescription)
+		-- Wipe accessories
+		local humanoidDescription = playerHumanoidDescription:Clone()
+		humanoidDescription.BackAccessory = ""
+		humanoidDescription.FaceAccessory = ""
+		humanoidDescription.FrontAccessory = ""
+		humanoidDescription.HairAccessory = ""
+		humanoidDescription.HatAccessory = ""
+		humanoidDescription.NeckAccessory = ""
+		humanoidDescription.ShouldersAccessory = ""
+		humanoidDescription.WaistAccessory = ""
+		humanoidDescription.GraphicTShirt = 0
+		humanoidDescription.Shirt = 0
+		humanoidDescription.Pants = 0
+		humanoidDescription:SetAccessories({}, true)
+
+		return RigBuilderUtils.promiseHumanoidModelFromDescription(
+			humanoidDescription,
+			humanoidRigType,
+			assetTypeVerification
+		)
+	end)
 end
 
-function RigBuilderUtils.promiseHumanoidModelFromDescription(description, rigType, assetTypeVerification)
+function RigBuilderUtils.promiseHumanoidModelFromDescription(
+	description: HumanoidDescription,
+	rigType: Enum.HumanoidRigType?,
+	assetTypeVerification: Enum.AssetTypeVerification?
+): Promise.Promise<Model>
 	assert(typeof(description) == "Instance" and description:IsA("HumanoidDescription"), "Bad description")
 	assert(typeof(rigType) == "EnumItem" or rigType == nil, "Bad rigType")
 	assert(typeof(assetTypeVerification) == "EnumItem" or assetTypeVerification == nil, "Bad assetTypeVerification")
@@ -516,7 +521,8 @@ function RigBuilderUtils.promiseHumanoidModelFromDescription(description, rigTyp
 			model = Players:CreateHumanoidModelFromDescription(
 				description,
 				rigType or Enum.HumanoidRigType.R15,
-				assetTypeVerification or Enum.AssetTypeVerification.Default)
+				assetTypeVerification or Enum.AssetTypeVerification.Default
+			)
 		end)
 		if not ok then
 			return reject(err or "Failed to create model")
@@ -529,7 +535,11 @@ function RigBuilderUtils.promiseHumanoidModelFromDescription(description, rigTyp
 	end)
 end
 
-function RigBuilderUtils.promiseHumanoidModelFromUserId(userId, rigType, assetTypeVerification)
+function RigBuilderUtils.promiseHumanoidModelFromUserId(
+	userId: number,
+	rigType: Enum.HumanoidRigType?,
+	assetTypeVerification: Enum.AssetTypeVerification?
+): Promise.Promise<Model>
 	assert(type(userId) == "number", "Bad userId")
 	assert(typeof(rigType) == "EnumItem" or rigType == nil, "Bad rigType")
 	assert(typeof(assetTypeVerification) == "EnumItem" or assetTypeVerification == nil, "Bad assetTypeVerification")
@@ -540,9 +550,10 @@ function RigBuilderUtils.promiseHumanoidModelFromUserId(userId, rigType, assetTy
 			model = Players:CreateHumanoidModelFromUserId(
 				userId,
 				rigType or Enum.HumanoidRigType.R15,
-				assetTypeVerification or Enum.AssetTypeVerification.Default)
+				assetTypeVerification or Enum.AssetTypeVerification.Default
+			)
 
-			for _, item in pairs(model:GetDescendants()) do
+			for _, item in model:GetDescendants() do
 				if item:IsA("LocalScript") then
 					item.Enabled = false
 				end
@@ -564,7 +575,7 @@ end
 	@param userId number
 	@return Promise<Instance>
 ]=]
-function RigBuilderUtils.promisePlayerRig(userId)
+function RigBuilderUtils.promisePlayerRig(userId: number): Promise.Promise<Model>
 	assert(type(userId) == "number", "Bad userId")
 
 	return RigBuilderUtils.promiseHumanoidModelFromUserId(userId)

package/src/Shared/RigBuilderUtils.story.lua

@@ -45,7 +45,7 @@ return function(target)
 		RigBuilderUtils.promisePlayerRig(676056)
 	}
 
-	for index, rig in pairs(rigs) do
+	for index, rig in rigs do
 		local offset = ((index - 0.5)/#rigs - 0.5)*#rigs*4
 		if Promise.isPromise(rig) then
 			maid:GivePromise(rig):Then(function(actualRig)