@quenty/ik 15.3.0 → 15.4.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.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/ik@15.3.0...@quenty/ik@15.4.0) (2024-04-28)
+
+
+### Features
+
+* Refactor IK logic ([f83df38](https://github.com/Quenty/NevermoreEngine/commit/f83df385a895eb791b74e2a1be6069c1a094b788))
+
+
+
+
+
 # [15.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/ik@15.2.1...@quenty/ik@15.3.0) (2024-04-27)
 
 **Note:** Version bump only for package @quenty/ik

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/ik",
-  "version": "15.3.0",
+  "version": "15.4.0",
   "description": "Inverse Kinematics for characters on Roblox",
   "keywords": [
     "Roblox",
@@ -56,5 +56,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5c9eab1eac73f0d54953cca5017b7be968182f72"
+  "gitHead": "1f65df4adb6f3c04fb25d70bfa93f0f7c332c143"
 }

package/src/Client/IKServiceClient.lua

@@ -51,7 +51,9 @@ function IKServiceClient:Init(serviceBag)
 	self._serviceBag:GetService(require("Motor6DServiceClient"))
 
 	-- Internal
-	self._ikBinders = self._serviceBag:GetService(require("IKBindersClient"))
+	self._ikRigBinderClient = self._serviceBag:GetService(require("IKRigClient"))
+	self._serviceBag:GetService(require("IKRightGrip"))
+	self._serviceBag:GetService(require("IKLeftGrip"))
 end
 
 --[=[
@@ -74,7 +76,7 @@ function IKServiceClient:GetRig(humanoid)
 	assert(self._serviceBag, "Not initialized")
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
-	return self._ikBinders.IKRig:Get(humanoid)
+	return self._ikRigBinderClient:Get(humanoid)
 end
 
 --[=[
@@ -86,7 +88,7 @@ function IKServiceClient:PromiseRig(humanoid)
 	assert(self._serviceBag, "Not initialized")
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
-	return self._ikBinders.IKRig:Promise(humanoid)
+	return self._ikRigBinderClient:Promise(humanoid)
 end
 
 --[=[
@@ -163,9 +165,9 @@ end
 ]=]
 function IKServiceClient:GetLocalPlayerRig()
 	assert(self._serviceBag, "Not initialized")
-	assert(self._ikBinders.IKRig, "Not initialize")
+	assert(self._ikRigBinderClient, "Not initialize")
 
-	return IKRigUtils.getPlayerIKRig(self._ikBinders.IKRig, Players.LocalPlayer)
+	return IKRigUtils.getPlayerIKRig(self._ikRigBinderClient, Players.LocalPlayer)
 end
 
 function IKServiceClient:_updateStepped()
@@ -179,7 +181,7 @@ function IKServiceClient:_updateStepped()
 
 	local camPosition = Workspace.CurrentCamera.CFrame.p
 
-	for _, rig in pairs(self._ikBinders.IKRig:GetAll()) do
+	for _, rig in pairs(self._ikRigBinderClient:GetAll()) do
 		debug.profilebegin("RigUpdate")
 
 		local position = rig:GetPositionOrNil()

package/src/Client/Rig/IKRigClient.lua

@@ -10,6 +10,7 @@ local Players = game:GetService("Players")
 local IKRigBase = require("IKRigBase")
 local IKConstants = require("IKConstants")
 local IKRigAimerLocalPlayer = require("IKRigAimerLocalPlayer")
+local Binder = require("Binder")
 
 local IKRigClient = setmetatable({}, IKRigBase)
 IKRigClient.ClassName = "IKRigClient"
@@ -95,4 +96,4 @@ function IKRigClient:_setupLocalPlayer(remoteEvent)
 	self._maid:GiveTask(self._localPlayerAimer)
 end
 
-return IKRigClient
+return Binder.new("IKRig", IKRigClient)

package/src/Server/IKService.lua

@@ -52,8 +52,10 @@ function IKService:Init(serviceBag)
 	self._serviceBag:GetService(require("Motor6DService"))
 	self._humanoidTrackerService = self._serviceBag:GetService(require("HumanoidTrackerService"))
 
-	-- Internal
-	self._ikBinders = self._serviceBag:GetService(require("IKBindersServer"))
+	-- Binders
+	self._ikRigBinder = self._serviceBag:GetService(require("IKRig"))
+	self._serviceBag:GetService(require("IKRightGrip"))
+	self._serviceBag:GetService(require("IKLeftGrip"))
 end
 
 --[=[
@@ -85,7 +87,7 @@ end
 	@return IKRig?
 ]=]
 function IKService:GetRig(humanoid)
-	return self._ikBinders.IKRig:Bind(humanoid)
+	return self._ikRigBinder:Bind(humanoid)
 end
 
 --[=[
@@ -96,8 +98,8 @@ end
 function IKService:PromiseRig(humanoid)
 	assert(typeof(humanoid) == "Instance", "Bad humanoid")
 
-	self._ikBinders.IKRig:Bind(humanoid)
-	return self._ikBinders.IKRig:Promise(humanoid)
+	self._ikRigBinder:Bind(humanoid)
+	return self._ikRigBinder:Promise(humanoid)
 end
 
 --[=[
@@ -107,7 +109,7 @@ end
 function IKService:RemoveRig(humanoid)
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 
-	self._ikBinders.IKRig:Unbind(humanoid)
+	self._ikRigBinder:Unbind(humanoid)
 end
 
 --[=[
@@ -127,7 +129,7 @@ function IKService:UpdateServerRigTarget(humanoid, target)
 	assert(typeof(humanoid) == "Instance" and humanoid:IsA("Humanoid"), "Bad humanoid")
 	assert(typeof(target) == "Vector3", "Bad target")
 
-	local serverRig = self._ikBinders.IKRig:Bind(humanoid)
+	local serverRig = self._ikRigBinder:Bind(humanoid)
 	if not serverRig then
 		warn("[IKService.UpdateServerRigTarget] - No serverRig")
 		return
@@ -147,15 +149,15 @@ function IKService:_handlePlayer(player)
 
 	maid:GiveTask(humanoidTracker.AliveHumanoid.Changed:Connect(function(new, old)
 		if old then
-			self._ikBinders.IKRig:Unbind(old)
+			self._ikRigBinder:Unbind(old)
 		end
 		if new then
-			self._ikBinders.IKRig:Bind(new)
+			self._ikRigBinder:Bind(new)
 		end
 	end))
 
 	if humanoidTracker.AliveHumanoid.Value then
-		self._ikBinders.IKRig:Bind(humanoidTracker.AliveHumanoid.Value)
+		self._ikRigBinder:Bind(humanoidTracker.AliveHumanoid.Value)
 	end
 
 	self._maid[player] = maid
@@ -164,7 +166,7 @@ end
 function IKService:_updateStepped()
 	debug.profilebegin("IKUpdateServer")
 
-	for _, rig in pairs(self._ikBinders.IKRig:GetAll()) do
+	for _, rig in pairs(self._ikRigBinder:GetAll()) do
 		debug.profilebegin("RigUpdateServer")
 
 		local lastUpdateTime = rig:GetLastUpdateTime()

package/src/Server/Rig/IKRig.lua

@@ -12,6 +12,7 @@ local IKRigBase = require("IKRigBase")
 local IKConstants = require("IKConstants")
 local CharacterUtils = require("CharacterUtils")
 local Motor6DStackHumanoid = require("Motor6DStackHumanoid")
+local Binder = require("Binder")
 
 local IKRig = setmetatable({}, IKRigBase)
 IKRig.ClassName = "IKRig"
@@ -90,4 +91,4 @@ function IKRig:_onServerEvent(player, target)
 	end
 end
 
-return IKRig
+return Binder.new("IKRig", IKRig)

package/src/Shared/Grip/IKGripUtils.lua

@@ -10,7 +10,7 @@ local IKGripUtils = {}
 
 	```lua
 	-- Get the binder
-	local leftGripAttachmentBinder = serviceBag:GetService(require("IKBindersServer")).IKLeftGrip
+	local leftGripAttachmentBinder = serviceBag:GetService(require("IKLeftGrip"))
 
 	-- Setup sample grip
 	local attachment = Instance.new("Attachment")

package/src/Shared/Grip/IKLeftGrip.lua

@@ -6,6 +6,7 @@
 local require = require(script.Parent.loader).load(script)
 
 local IKGripBase = require("IKGripBase")
+local Binder = require("Binder")
 
 local IKLeftGrip = setmetatable({}, IKGripBase)
 IKLeftGrip.ClassName = "IKLeftGrip"
@@ -25,4 +26,4 @@ function IKLeftGrip.new(objectValue, serviceBag)
 	return self
 end
 
-return IKLeftGrip
+return Binder.new("IKLeftGrip", IKLeftGrip)

package/src/Shared/Grip/IKRightGrip.lua

@@ -6,6 +6,7 @@
 local require = require(script.Parent.loader).load(script)
 
 local IKGripBase = require("IKGripBase")
+local Binder = require("Binder")
 
 local IKRightGrip = setmetatable({}, IKGripBase)
 IKRightGrip.ClassName = "IKRightGrip"
@@ -25,4 +26,4 @@ function IKRightGrip.new(objectValue, serviceBag)
 	return self
 end
 
-return IKRightGrip
+return Binder.new("IKRightGrip", IKRightGrip)

package/src/Client/IKBindersClient.lua

@@ -1,18 +0,0 @@
---[=[
-	Holds binders
-	@class IKBindersClient
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local BinderProvider = require("BinderProvider")
-local Binder = require("Binder")
-
-return BinderProvider.new(script.Name, function(self, serviceBag)
-	-- Rig
-	self:Add(Binder.new("IKRig", require("IKRigClient"), serviceBag))
-
-	-- Grips
-	self:Add(Binder.new("IKRightGrip", require("IKRightGrip"), serviceBag))
-	self:Add(Binder.new("IKLeftGrip", require("IKLeftGrip"), serviceBag))
-end)

package/src/Server/IKBindersServer.lua

@@ -1,19 +0,0 @@
---[=[
-	Holds binders
-	@server
-	@class IKBindersServer
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local BinderProvider = require("BinderProvider")
-local Binder = require("Binder")
-
-return BinderProvider.new(script.Name, function(self, serviceBag)
-	-- Rig
-	self:Add(Binder.new("IKRig", require("IKRig"), serviceBag))
-
-	-- Grips
-	self:Add(Binder.new("IKRightGrip", require("IKRightGrip"), serviceBag))
-	self:Add(Binder.new("IKLeftGrip", require("IKLeftGrip"), serviceBag))
-end)