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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/ik",
-  "version": "15.24.0",
+  "version": "15.24.1-canary.545.2374fb2.0",
   "description": "Inverse Kinematics for characters on Roblox",
   "keywords": [
     "Roblox",
@@ -26,36 +26,36 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/acceltween": "^2.5.0",
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/binder": "^14.19.0",
-    "@quenty/brio": "^14.17.0",
-    "@quenty/camera": "^14.20.0",
-    "@quenty/characterutils": "^12.18.0",
-    "@quenty/humanoidtracker": "^13.17.0",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/math": "^2.7.1",
-    "@quenty/motor6d": "^7.20.0",
-    "@quenty/optional": "^11.8.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/qframe": "^10.10.1",
-    "@quenty/r15utils": "^13.17.0",
-    "@quenty/ragdoll": "^15.23.0",
-    "@quenty/remoting": "^12.18.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/servicebag": "^11.11.1",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/table": "^3.7.1",
-    "@quenty/tie": "^10.20.0",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/acceltween": "2.5.1-canary.545.2374fb2.0",
+    "@quenty/baseobject": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/binder": "14.19.1-canary.545.2374fb2.0",
+    "@quenty/brio": "14.17.1-canary.545.2374fb2.0",
+    "@quenty/camera": "14.20.1-canary.545.2374fb2.0",
+    "@quenty/characterutils": "12.18.1-canary.545.2374fb2.0",
+    "@quenty/humanoidtracker": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/instanceutils": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/loader": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/maid": "3.4.1-canary.545.2374fb2.0",
+    "@quenty/math": "2.7.2-canary.545.2374fb2.0",
+    "@quenty/motor6d": "7.20.1-canary.545.2374fb2.0",
+    "@quenty/optional": "11.8.1-canary.545.2374fb2.0",
+    "@quenty/promise": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/qframe": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/r15utils": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/ragdoll": "15.23.1-canary.545.2374fb2.0",
+    "@quenty/remoting": "12.18.1-canary.545.2374fb2.0",
+    "@quenty/rx": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/servicebag": "11.11.2-canary.545.2374fb2.0",
+    "@quenty/signal": "7.10.1-canary.545.2374fb2.0",
+    "@quenty/table": "3.7.2-canary.545.2374fb2.0",
+    "@quenty/tie": "10.20.1-canary.545.2374fb2.0",
+    "@quenty/valueobject": "13.17.1-canary.545.2374fb2.0"
   },
   "devDependencies": {
-    "@quenty/rigbuilderutils": "^10.19.0"
+    "@quenty/rigbuilderutils": "10.19.1-canary.545.2374fb2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "2374fb2b043cfbe0e9b507b3316eec46a4e353a0"
 }

package/src/Client/IKServiceClient.lua

@@ -18,6 +18,7 @@ local Players = game:GetService("Players")
 
 local IKRigUtils = require("IKRigUtils")
 local Maid = require("Maid")
+local _ServiceBag = require("ServiceBag")
 
 local IKServiceClient = {}
 IKServiceClient.ServiceName = "IKServiceClient"
@@ -38,7 +39,7 @@ IKServiceClient.ServiceName = "IKServiceClient"
 
 	@param serviceBag ServiceBag
 ]=]
-function IKServiceClient:Init(serviceBag)
+function IKServiceClient:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
@@ -185,7 +186,7 @@ function IKServiceClient:_updateStepped()
 
 	local camPosition = Workspace.CurrentCamera.CFrame.p
 
-	for _, rig in pairs(self._ikRigBinderClient:GetAll()) do
+	for _, rig in self._ikRigBinderClient:GetAll() do
 		debug.profilebegin("RigUpdate")
 
 		local position = rig:GetPositionOrNil()

package/src/Client/Rig/IKRigAimerLocalPlayer.lua

@@ -49,7 +49,7 @@ end
 	Sets whether the local player should look around automatically.
 	@param lookAround boolean
 ]=]
-function IKRigAimerLocalPlayer:SetLookAround(lookAround)
+function IKRigAimerLocalPlayer:SetLookAround(lookAround: boolean)
 	assert(type(lookAround) == "boolean", "Bad lookAround")
 
 	self._lookAround = lookAround
@@ -71,13 +71,13 @@ function IKRigAimerLocalPlayer:SetAimPosition(position, optionalPriority)
 	end
 
 	self._aimData = {
-		priority = optionalPriority;
-		position = position; -- May be nil
-		timeStamp = os.clock();
+		priority = optionalPriority,
+		position = position, -- May be nil
+		timeStamp = os.clock(),
 	}
 end
 
-function IKRigAimerLocalPlayer:PushReplicationRate(replicateRate)
+function IKRigAimerLocalPlayer:PushReplicationRate(replicateRate: number)
 	assert(type(replicateRate) == "number", "Bad replicateRate")
 
 	local data = {
@@ -102,7 +102,7 @@ end
 
 function IKRigAimerLocalPlayer:_updateReplicationRate()
 	local best = nil
-	for _, rateData in pairs(self._replicationRates) do
+	for _, rateData in self._replicationRates do
 		local rate = rateData.replicateRate
 		if not best or rate < best then
 			best = rate

package/src/Client/Rig/IKRigClient.lua

@@ -17,7 +17,7 @@ local IKRigClient = setmetatable({}, IKRigBase)
 IKRigClient.ClassName = "IKRigClient"
 IKRigClient.__index = IKRigClient
 
-function IKRigClient.new(humanoid, serviceBag)
+function IKRigClient.new(humanoid: Humanoid, serviceBag)
 	local self = setmetatable(IKRigBase.new(humanoid, serviceBag), IKRigClient)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
@@ -38,7 +38,7 @@ end
 
 	@return Vector3?
 ]=]
-function IKRigClient:GetPositionOrNil()
+function IKRigClient:GetPositionOrNil(): Vector3?
 	local rootPart = self._obj.RootPart
 	if not rootPart then
 		return nil
@@ -61,7 +61,7 @@ end
 
 	@return Vector3?
 ]=]
-function IKRigClient:GetAimPosition()
+function IKRigClient:GetAimPosition(): Vector3?
 	if self._localPlayerAimer then
 		return self._localPlayerAimer:GetAimPosition()
 	end
@@ -69,7 +69,7 @@ function IKRigClient:GetAimPosition()
 	return self._target
 end
 
-function IKRigClient:_setAimPosition(newTarget)
+function IKRigClient:_setAimPosition(newTarget: Vector3?)
 	assert(typeof(newTarget) == "Vector3" or newTarget == nil, "Bad newTarget")
 
 	local torso = self:GetTorso()
@@ -93,7 +93,7 @@ function IKRigClient:_setupLocalPlayer()
 	self._localPlayerAimer = self._maid:Add(IKRigAimerLocalPlayer.new(self._serviceBag, self))
 end
 
-function IKRigClient:FireSetAimPosition(newTarget)
+function IKRigClient:FireSetAimPosition(newTarget: Vector3?)
 	assert(self:GetPlayer() == Players.LocalPlayer, "Canot only fire from client")
 
 	self._remoting.SetAimPosition:FireServer(newTarget)

package/src/Server/IKService.lua

@@ -23,6 +23,7 @@ local Players = game:GetService("Players")
 local RunService = game:GetService("RunService")
 
 local Maid = require("Maid")
+local _ServiceBag = require("ServiceBag")
 
 local SERVER_UPDATE_RATE = 1 / 10
 
@@ -42,7 +43,7 @@ IKService.ServiceName = "IKService"
 
 	@param serviceBag ServiceBag
 ]=]
-function IKService:Init(serviceBag)
+function IKService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._maid, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -75,7 +76,7 @@ function IKService:Start()
 		self:_handlePlayerRemoving(player)
 	end))
 
-	for _, player in pairs(Players:GetPlayers()) do
+	for _, player in Players:GetPlayers() do
 		self:_handlePlayer(player)
 	end
 
@@ -171,7 +172,7 @@ end
 function IKService:_updateStepped()
 	debug.profilebegin("IKUpdateServer")
 
-	for _, rig in pairs(self._ikRigBinder:GetAll()) do
+	for _, rig in self._ikRigBinder:GetAll() do
 		debug.profilebegin("RigUpdateServer")
 
 		local lastUpdateTime = rig:GetLastUpdateTime()

package/src/Server/Rig/IKRig.lua

@@ -16,7 +16,7 @@ local IKRig = setmetatable({}, IKRigBase)
 IKRig.ClassName = "IKRig"
 IKRig.__index = IKRig
 
-function IKRig.new(humanoid, serviceBag)
+function IKRig.new(humanoid: Humanoid, serviceBag)
 	local self = setmetatable(IKRigBase.new(humanoid, serviceBag), IKRig)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
@@ -44,7 +44,7 @@ end
 
 	@param target Vector3?
 ]=]
-function IKRig:SetAimPosition(target)
+function IKRig:SetAimPosition(target: Vector3?)
 	assert(typeof(target) == "Vector3" or target == nil, "Bad target")
 
 	self:_applyAimPosition(target)
@@ -62,7 +62,7 @@ function IKRig:_setupRemoting()
 	end))
 end
 
-function IKRig:_applyAimPosition(target)
+function IKRig:_applyAimPosition(target: Vector3?)
 	assert(typeof(target) == "Vector3" or target == nil, "Bad target")
 
 	-- Guard against NaN

package/src/Shared/Arm/ArmIKBase.lua

@@ -159,35 +159,35 @@ function ArmIKBase:_observeStateBrio()
 		RxBrioUtils.switchMapBrio(function(character)
 			local observeUpperTorsoBrio = RxInstanceUtils.observeLastNamedChildBrio(character, "BasePart", "UpperTorso"):Pipe({
 				Rx.shareReplay(1);
-			});
+			})
 			local observeUpperArmBrio = RxInstanceUtils.observeLastNamedChildBrio(character, "BasePart", self._armName .. "UpperArm"):Pipe({
 				Rx.shareReplay(1);
-			});
+			})
 			local observeLowerArmBrio = RxInstanceUtils.observeLastNamedChildBrio(character, "BasePart", self._armName .. "LowerArm"):Pipe({
 				Rx.shareReplay(1);
-			});
+			})
 			local observeHandBrio = RxInstanceUtils.observeLastNamedChildBrio(character, "BasePart", self._armName .. "Hand"):Pipe({
 				Rx.shareReplay(1);
-			});
+			})
 
 			local observeShoulderBrio = observeUpperArmBrio:Pipe({
 				RxBrioUtils.switchMapBrio(function(upperArm)
 					return RxInstanceUtils.observeLastNamedChildBrio(upperArm, "Motor6D", self._armName .. "Shoulder")
 				end);
 				Rx.shareReplay(1);
-			});
+			})
 			local observeElbowBrio = observeLowerArmBrio:Pipe({
 				RxBrioUtils.switchMapBrio(function(lowerArm)
 					return RxInstanceUtils.observeLastNamedChildBrio(lowerArm, "Motor6D", self._armName .. "Elbow")
 				end);
 				Rx.shareReplay(1);
-			});
+			})
 			local observeWristBrio = observeHandBrio:Pipe({
 				RxBrioUtils.switchMapBrio(function(hand)
 					return RxInstanceUtils.observeLastNamedChildBrio(hand, "Motor6D", self._armName .. "Wrist")
 				end);
 				Rx.shareReplay(1);
-			});
+			})
 
 			return RxBrioUtils.flatCombineLatest({
 				UpperTorso = observeUpperTorsoBrio;
@@ -201,19 +201,19 @@ function ArmIKBase:_observeStateBrio()
 
 				ShoulderMotor6DStack = observeShoulderBrio:Pipe({
 					RxBrioUtils.switchMapBrio(function(motor)
-						return Motor6DStackInterface:ObserveLastImplementationBrio(motor, self._tieRealmService:GetTieRealm());
+						return Motor6DStackInterface:ObserveLastImplementationBrio(motor, self._tieRealmService:GetTieRealm())
 					end);
 					Rx.defaultsToNil;
 				});
 				ElbowMotor6DStack = observeElbowBrio:Pipe({
 					RxBrioUtils.switchMapBrio(function(motor)
-						return Motor6DStackInterface:ObserveLastImplementationBrio(motor, self._tieRealmService:GetTieRealm());
+						return Motor6DStackInterface:ObserveLastImplementationBrio(motor, self._tieRealmService:GetTieRealm())
 					end);
 					Rx.defaultsToNil;
 				});
 				WristMotor6DStack = observeWristBrio:Pipe({
 					RxBrioUtils.switchMapBrio(function(motor)
-						return Motor6DStackInterface:ObserveLastImplementationBrio(motor, self._tieRealmService:GetTieRealm());
+						return Motor6DStackInterface:ObserveLastImplementationBrio(motor, self._tieRealmService:GetTieRealm())
 					end);
 					Rx.defaultsToNil;
 				});
@@ -287,7 +287,7 @@ function ArmIKBase:Grip(attachment, priority)
 end
 
 function ArmIKBase:_stopGrip(grip)
-	for index, value in pairs(self._grips) do
+	for index, value in self._grips do
 		if value == grip then
 			table.remove(self._grips, index)
 			break

package/src/Shared/Grip/IKGripBase.lua

@@ -15,7 +15,7 @@ local IKGripBase = setmetatable({}, BaseObject)
 IKGripBase.ClassName = "IKGripBase"
 IKGripBase.__index = IKGripBase
 
-function IKGripBase.new(objectValue, serviceBag)
+function IKGripBase.new(objectValue: ObjectValue, serviceBag)
 	local self = setmetatable(BaseObject.new(objectValue), IKGripBase)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
@@ -27,11 +27,11 @@ function IKGripBase.new(objectValue, serviceBag)
 	return self
 end
 
-function IKGripBase:GetPriority()
+function IKGripBase:GetPriority(): number
 	return 1
 end
 
-function IKGripBase:GetAttachment()
+function IKGripBase:GetAttachment(): Attachment?
 	return self._obj.Parent
 end
 
@@ -42,9 +42,9 @@ function IKGripBase:PromiseIKRig()
 
 	local ikService
 	if RunService:IsServer() then
-		ikService = self._serviceBag:GetService(require("IKService"))
+		ikService = self._serviceBag:GetService((require :: any)("IKService"))
 	else
-		ikService = self._serviceBag:GetService(require("IKServiceClient"))
+		ikService = self._serviceBag:GetService((require :: any)("IKServiceClient"))
 	end
 
 	local promise = promisePropertyValue(self._obj, "Value")

package/src/Shared/Grip/IKRightGrip.lua

@@ -12,7 +12,7 @@ local IKRightGrip = setmetatable({}, IKGripBase)
 IKRightGrip.ClassName = "IKRightGrip"
 IKRightGrip.__index = IKRightGrip
 
-function IKRightGrip.new(objectValue, serviceBag)
+function IKRightGrip.new(objectValue: ObjectValue, serviceBag)
 	local self = setmetatable(IKGripBase.new(objectValue, serviceBag), IKRightGrip)
 
 	self:PromiseIKRig()

package/src/Shared/IKDataService.lua

@@ -6,11 +6,12 @@ local require = require(script.Parent.loader).load(script)
 
 local IKRigInterface = require("IKRigInterface")
 local TieRealmService = require("TieRealmService")
+local _ServiceBag = require("ServiceBag")
 
 local IKDataService = {}
 IKDataService.ServiceName = "IKDataService"
 
-function IKDataService:Init(serviceBag)
+function IKDataService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 

package/src/Shared/Resources/IKResource.lua

@@ -30,7 +30,7 @@ function IKResource.new(data)
 	self.ReadyChanged = self._ready.Changed
 
 	if self._data.children then
-		for _, childData in pairs(self._data.children) do
+		for _, childData in self._data.children do
 			self:_addResource(IKResource.new(childData))
 		end
 	end
@@ -42,11 +42,11 @@ function IKResource:GetData()
 	return self._data
 end
 
-function IKResource:IsReady()
+function IKResource:IsReady(): boolean
 	return self._ready.Value
 end
 
-function IKResource:Get(descendantName)
+function IKResource:Get(descendantName: string)
 	local resource = self._descendantLookupMap[descendantName]
 	if not resource then
 		error(string.format("[IKResource.Get] - Resource %q does not exist", tostring(descendantName)))
@@ -60,7 +60,7 @@ function IKResource:Get(descendantName)
 	return result
 end
 
-function IKResource:GetInstance()
+function IKResource:GetInstance(): Instance?
 	if self._data.isLink then
 		if self._instance then
 			return self._instance.Value
@@ -72,7 +72,7 @@ function IKResource:GetInstance()
 	return self._instance
 end
 
-function IKResource:SetInstance(instance)
+function IKResource:SetInstance(instance: Instance?)
 	if self._instance == instance then
 		return
 	end
@@ -107,7 +107,7 @@ function IKResource:GetLookupTable()
 end
 
 function IKResource:_startListening(maid, instance)
-	for _, child in pairs(instance:GetChildren()) do
+	for _, child in instance:GetChildren() do
 		self:_handleChildAdded(child)
 	end
 
@@ -165,7 +165,7 @@ function IKResource:_handleChildRemoved(child)
 end
 
 function IKResource:_clearChildren()
-	for _, child in pairs(self._childResourceMap) do
+	for _, child in self._childResourceMap do
 		child:SetInstance(nil)
 	end
 end
@@ -185,7 +185,7 @@ function IKResource:_calculateIsReady()
 		end
 	end
 
-	for _, child in pairs(self._childResourceMap) do
+	for _, child in self._childResourceMap do
 		if not child:IsReady() then
 			return false
 		end

package/src/Shared/Rig/IKRigBase.lua

@@ -46,13 +46,13 @@ function IKRigBase:Update()
 	self._lastUpdateTime = tick()
 	self.Updating:Fire()
 
-	for _, item in pairs(self._ikTargets) do
+	for _, item in self._ikTargets do
 		item:Update()
 	end
 end
 
 function IKRigBase:UpdateTransformOnly()
-	for _, item in pairs(self._ikTargets) do
+	for _, item in self._ikTargets do
 		item:UpdateTransformOnly()
 	end
 end

package/test/scripts/Client/ClientMain.client.lua

@@ -11,4 +11,4 @@ serviceBag:Init()
 serviceBag:Start()
 
 -- Configure
-ikServiceClient:SetLookAround(true)
+ikServiceClient:SetLookAround(true)

package/test/scripts/Server/ServerMain.server.lua

@@ -15,17 +15,16 @@ serviceBag:Start()
 
 -- Build test NPC rigs
 local RigBuilderUtils = require("RigBuilderUtils")
-RigBuilderUtils.promiseR15MeshRig()
-	:Then(function(character)
-		local humanoid = character.Humanoid
+RigBuilderUtils.promiseR15MeshRig():Then(function(character)
+	local humanoid = character.Humanoid
 
-		-- reparent to middle
-		humanoid.RootPart.CFrame = CFrame.new(0, 25, 0)
-		character.Parent = workspace
-		humanoid.RootPart.CFrame = CFrame.new(0, 25, 0)
+	-- reparent to middle
+	humanoid.RootPart.CFrame = CFrame.new(0, 25, 0)
+	character.Parent = workspace
+	humanoid.RootPart.CFrame = CFrame.new(0, 25, 0)
 
-		-- look at origin
-		RunService.Stepped:Connect(function()
-			ikService:UpdateServerRigTarget(humanoid, Vector3.zero)
-		end)
+	-- look at origin
+	RunService.Stepped:Connect(function()
+		ikService:UpdateServerRigTarget(humanoid, Vector3.zero)
 	end)
+end)