@quenty/ik 15.22.0 → 15.23.0

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [15.23.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/ik@15.22.0...@quenty/ik@15.23.0) (2025-02-18)
+
+**Note:** Version bump only for package @quenty/ik
+
+
+
+
+
 # [15.22.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/ik@15.21.2...@quenty/ik@15.22.0) (2025-01-24)
 
 **Note:** Version bump only for package @quenty/ik

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/ik",
-  "version": "15.22.0",
+  "version": "15.23.0",
   "description": "Inverse Kinematics for characters on Roblox",
   "keywords": [
     "Roblox",
@@ -27,35 +27,35 @@
   ],
   "dependencies": {
     "@quenty/acceltween": "^2.5.0",
-    "@quenty/baseobject": "^10.7.1",
-    "@quenty/binder": "^14.17.0",
-    "@quenty/brio": "^14.15.0",
-    "@quenty/camera": "^14.18.2",
-    "@quenty/characterutils": "^12.16.0",
-    "@quenty/humanoidtracker": "^13.15.0",
-    "@quenty/instanceutils": "^13.15.0",
-    "@quenty/loader": "^10.7.1",
+    "@quenty/baseobject": "^10.8.0",
+    "@quenty/binder": "^14.18.0",
+    "@quenty/brio": "^14.16.0",
+    "@quenty/camera": "^14.19.0",
+    "@quenty/characterutils": "^12.17.0",
+    "@quenty/humanoidtracker": "^13.16.0",
+    "@quenty/instanceutils": "^13.16.0",
+    "@quenty/loader": "^10.8.0",
     "@quenty/maid": "^3.4.0",
     "@quenty/math": "^2.7.0",
-    "@quenty/motor6d": "^7.18.1",
-    "@quenty/optional": "^11.7.1",
-    "@quenty/promise": "^10.9.0",
-    "@quenty/qframe": "^10.9.0",
-    "@quenty/r15utils": "^13.15.0",
-    "@quenty/ragdoll": "^15.21.0",
-    "@quenty/remoting": "^12.16.0",
-    "@quenty/rx": "^13.15.0",
-    "@quenty/servicebag": "^11.10.0",
-    "@quenty/signal": "^7.9.0",
+    "@quenty/motor6d": "^7.19.0",
+    "@quenty/optional": "^11.8.0",
+    "@quenty/promise": "^10.10.0",
+    "@quenty/qframe": "^10.10.0",
+    "@quenty/r15utils": "^13.16.0",
+    "@quenty/ragdoll": "^15.22.0",
+    "@quenty/remoting": "^12.17.0",
+    "@quenty/rx": "^13.16.0",
+    "@quenty/servicebag": "^11.11.0",
+    "@quenty/signal": "^7.10.0",
     "@quenty/table": "^3.7.0",
-    "@quenty/tie": "^10.18.1",
-    "@quenty/valueobject": "^13.15.0"
+    "@quenty/tie": "^10.19.0",
+    "@quenty/valueobject": "^13.16.0"
   },
   "devDependencies": {
-    "@quenty/rigbuilderutils": "^10.17.0"
+    "@quenty/rigbuilderutils": "^10.18.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "139153f54f20e0f1420b584f4650e1ec5950b6a2"
+  "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
 }

package/src/Client/IKServiceClient.lua

@@ -52,6 +52,9 @@ function IKServiceClient:Init(serviceBag)
 	self._serviceBag:GetService(require("Motor6DServiceClient"))
 
 	-- Internal
+	self._serviceBag:GetService(require("IKDataService"))
+
+	-- Binders
 	self._ikRigBinderClient = self._serviceBag:GetService(require("IKRigClient"))
 	self._serviceBag:GetService(require("IKRightGrip"))
 	self._serviceBag:GetService(require("IKLeftGrip"))

package/src/Client/Rig/IKRigAimerLocalPlayer.lua

@@ -45,17 +45,6 @@ function IKRigAimerLocalPlayer.new(serviceBag, ikRig)
 	return self
 end
 
---[=[
-	Sets the remote event for replication
-
-	@param remoteEvent RemoteEvent
-]=]
-function IKRigAimerLocalPlayer:SetRemoteEvent(remoteEvent)
-	assert(not self._remoteEvent, "Already have remoteEvent")
-
-	self._remoteEvent = assert(remoteEvent, "No remoteEvent")
-end
-
 --[=[
 	Sets whether the local player should look around automatically.
 	@param lookAround boolean
@@ -178,9 +167,9 @@ function IKRigAimerLocalPlayer:UpdateStepped()
 	end
 
 	-- Filter replicate
-	if self._remoteEvent and (os.clock() - self._lastReplication) > self._replicationRate then
+	if (os.clock() - self._lastReplication) > self._replicationRate then
 		self._lastReplication = os.clock()
-		self._remoteEvent:FireServer(aimPosition)
+		self._ikRig:FireSetAimPosition(aimPosition)
 	end
 end
 

package/src/Client/Rig/IKRigClient.lua

@@ -7,37 +7,28 @@ local require = require(script.Parent.loader).load(script)
 
 local Players = game:GetService("Players")
 
-local IKRigBase = require("IKRigBase")
-local IKConstants = require("IKConstants")
-local IKRigAimerLocalPlayer = require("IKRigAimerLocalPlayer")
 local Binder = require("Binder")
+local IKRigAimerLocalPlayer = require("IKRigAimerLocalPlayer")
+local IKRigBase = require("IKRigBase")
+local IKRigInterface = require("IKRigInterface")
+local Remoting = require("Remoting")
 
 local IKRigClient = setmetatable({}, IKRigBase)
 IKRigClient.ClassName = "IKRigClient"
 IKRigClient.__index = IKRigClient
 
-require("PromiseRemoteEventMixin"):Add(IKRigClient, IKConstants.REMOTE_EVENT_NAME)
-
 function IKRigClient.new(humanoid, serviceBag)
 	local self = setmetatable(IKRigBase.new(humanoid, serviceBag), IKRigClient)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
+	self:_setupRemoting()
+
 	if self:GetPlayer() == Players.LocalPlayer then
-		self:_setupLocalPlayer(self._remoteEvent)
+		self:_setupLocalPlayer()
 	end
 
-	self:PromiseRemoteEvent():Then(function(remoteEvent)
-		self._remoteEvent = assert(remoteEvent, "No remoteEvent")
-
-		self._maid:GiveTask(self._remoteEvent.OnClientEvent:Connect(function(...)
-			self:_handleRemoteEventClient(...)
-		end))
-
-		if self._localPlayerAimer then
-			self._localPlayerAimer:SetRemoteEvent(self._remoteEvent)
-		end
-	end)
+	self._maid:Add(IKRigInterface.Client:Implement(self._obj, self))
 
 	return self
 end
@@ -70,7 +61,7 @@ end
 
 	@return Vector3?
 ]=]
-function IKRigClient:GetTarget()
+function IKRigClient:GetAimPosition()
 	if self._localPlayerAimer then
 		return self._localPlayerAimer:GetAimPosition()
 	end
@@ -78,8 +69,7 @@ function IKRigClient:GetTarget()
 	return self._target
 end
 
-
-function IKRigClient:_handleRemoteEventClient(newTarget)
+function IKRigClient:_setAimPosition(newTarget)
 	assert(typeof(newTarget) == "Vector3" or newTarget == nil, "Bad newTarget")
 
 	local torso = self:GetTorso()
@@ -91,8 +81,22 @@ function IKRigClient:_handleRemoteEventClient(newTarget)
 	self._target = newTarget
 end
 
-function IKRigClient:_setupLocalPlayer(remoteEvent)
-	self._localPlayerAimer = self._maid:Add(IKRigAimerLocalPlayer.new(self._serviceBag, self, remoteEvent))
+function IKRigClient:_setupRemoting()
+	self._remoting = self._maid:Add(Remoting.Client.new(self._obj, "IKRig"))
+
+	self._maid:GiveTask(self._remoting.SetAimPosition:Connect(function(...)
+		self:_setAimPosition(...)
+	end))
+end
+
+function IKRigClient:_setupLocalPlayer()
+	self._localPlayerAimer = self._maid:Add(IKRigAimerLocalPlayer.new(self._serviceBag, self))
+end
+
+function IKRigClient:FireSetAimPosition(newTarget)
+	assert(self:GetPlayer() == Players.LocalPlayer, "Canot only fire from client")
+
+	self._remoting.SetAimPosition:FireServer(newTarget)
 end
 
 return Binder.new("IKRig", IKRigClient)

package/src/Server/IKService.lua

@@ -52,6 +52,9 @@ function IKService:Init(serviceBag)
 	self._serviceBag:GetService(require("TieRealmService"))
 	self._humanoidTrackerService = self._serviceBag:GetService(require("HumanoidTrackerService"))
 
+	-- Internal
+	self._serviceBag:GetService(require("IKDataService"))
+
 	-- Binders
 	self._ikRigBinder = self._serviceBag:GetService(require("IKRig"))
 	self._serviceBag:GetService(require("IKRightGrip"))
@@ -135,7 +138,7 @@ function IKService:UpdateServerRigTarget(humanoid, target)
 		return
 	end
 
-	serverRig:SetRigTarget(target)
+	serverRig:SetAimPosition(target)
 end
 
 function IKService:_handlePlayerRemoving(player)

package/src/Server/Rig/IKRig.lua

@@ -6,13 +6,11 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Players = game:GetService("Players")
-
+local Binder = require("Binder")
 local IKRigBase = require("IKRigBase")
-local IKConstants = require("IKConstants")
-local CharacterUtils = require("CharacterUtils")
+local IKRigInterface = require("IKRigInterface")
 local Motor6DStackHumanoid = require("Motor6DStackHumanoid")
-local Binder = require("Binder")
+local Remoting = require("Remoting")
 
 local IKRig = setmetatable({}, IKRigBase)
 IKRig.ClassName = "IKRig"
@@ -23,19 +21,11 @@ function IKRig.new(humanoid, serviceBag)
 
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
-	self._remoteEvent = Instance.new("RemoteEvent")
-	self._remoteEvent.Name = IKConstants.REMOTE_EVENT_NAME
-	self._remoteEvent.Archivable = false
-	self._remoteEvent.Parent = self._obj
-	self._maid:GiveTask(self._remoteEvent)
-
-	self._maid:GiveTask(self._remoteEvent.OnServerEvent:Connect(function(...)
-		self:_onServerEvent(...)
-	end))
-
 	Motor6DStackHumanoid:Tag(self._obj)
 
-	self._target = nil
+	self:_setupRemoting()
+
+	self._maid:Add(IKRigInterface.Server:Implement(self._obj, self))
 
 	return self
 end
@@ -45,8 +35,8 @@ end
 
 	@return Vector3?
 ]=]
-function IKRig:GetTarget()
-	return self._target
+function IKRig:GetAimPosition()
+	return self._aimPosition
 end
 
 --[=[
@@ -54,21 +44,25 @@ end
 
 	@param target Vector3?
 ]=]
-function IKRig:SetRigTarget(target)
+function IKRig:SetAimPosition(target)
 	assert(typeof(target) == "Vector3" or target == nil, "Bad target")
 
-	self._target = target
+	self:_applyAimPosition(target)
+	self._remoting.SetAimPosition:FireAllClients(target)
+end
 
-	local torso = self:GetTorso()
-	if torso then
-		torso:Point(self._target)
-	end
+function IKRig:_setupRemoting()
+	self._remoting = self._maid:Add(Remoting.Server.new(self._obj, "IKRig"))
+
+	self._maid:GiveTask(self._remoting.SetAimPosition:Connect(function(player, target)
+		assert(player == self:GetPlayer(), "Bad player")
 
-	self._remoteEvent:FireAllClients(target)
+		self:_applyAimPosition(target)
+		self._remoting.SetAimPosition:FireAllClientsExcept(player, target)
+	end))
 end
 
-function IKRig:_onServerEvent(player, target)
-	assert(player == CharacterUtils.getPlayerFromCharacter(self._obj), "Bad player")
+function IKRig:_applyAimPosition(target)
 	assert(typeof(target) == "Vector3" or target == nil, "Bad target")
 
 	-- Guard against NaN
@@ -76,18 +70,11 @@ function IKRig:_onServerEvent(player, target)
 		return
 	end
 
-	self._target = target
+	self._aimPosition = target
 
 	local torso = self:GetTorso()
 	if torso then
-		torso:Point(self._target)
-	end
-
-	-- Do replication
-	for _, other in pairs(Players:GetPlayers()) do
-		if other ~= player then
-			self._remoteEvent:FireClient(other, target) -- target may nil
-		end
+		torso:Point(self._aimPosition)
 	end
 end
 

package/src/Shared/IKDataService.lua

@@ -0,0 +1,32 @@
+--[=[
+	@class IKDataService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local IKRigInterface = require("IKRigInterface")
+local TieRealmService = require("TieRealmService")
+
+local IKDataService = {}
+IKDataService.ServiceName = "IKDataService"
+
+function IKDataService:Init(serviceBag)
+	assert(not self._serviceBag, "Already initialized")
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+
+	self._tieRealmService = self._serviceBag:GetService(TieRealmService)
+end
+
+function IKDataService:PromiseRig(humanoid)
+	return IKRigInterface:Promise(humanoid, self._tieRealmService:GetTieRealm())
+end
+
+function IKDataService:ObserveRig(humanoid)
+	return IKRigInterface:Observe(humanoid, self._tieRealmService:GetTieRealm())
+end
+
+function IKDataService:ObserveRigBrio(humanoid)
+	return IKRigInterface:ObserveBrio(humanoid, self._tieRealmService:GetTieRealm())
+end
+
+return IKDataService

package/src/Shared/Interfaces/IKRigInterface.lua

@@ -0,0 +1,19 @@
+--[=[
+	@class IKRigInterface
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local TieDefinition = require("TieDefinition")
+
+return TieDefinition.new("IKRig", {
+	GetPlayer = TieDefinition.Types.METHOD;
+	GetHumanoid = TieDefinition.Types.METHOD;
+
+	PromiseLeftArm = TieDefinition.Types.METHOD;
+	PromiseRightArm = TieDefinition.Types.METHOD;
+	GetLeftArm = TieDefinition.Types.METHOD;
+	GetRightArm = TieDefinition.Types.METHOD;
+
+	GetAimPosition = TieDefinition.Types.METHOD;
+})

package/src/Shared/Torso/TorsoIKBase.lua

@@ -129,7 +129,7 @@ function TorsoIKBase:Update()
 	self:UpdateTransformOnly()
 end
 
-function TorsoIKBase:GetTarget()
+function TorsoIKBase:GetAimPosition()
 	return self._target -- May return nil
 end
 

package/src/Shared/IKConstants.lua

@@ -1,12 +0,0 @@
---[=[
-	Constants for the character IK calculations
-	@class IKConstants
-]=]
-
-local require = require(script.Parent.loader).load(script)
-
-local Table = require("Table")
-
-return Table.readonly({
-	REMOTE_EVENT_NAME = "IKRigRemoteEvent";
-})