@quenty/ik 5.2.0 → 5.3.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [5.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/ik@5.2.1...@quenty/ik@5.3.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/ik
+
+
+
+
+
+## [5.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/ik@5.2.0...@quenty/ik@5.2.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/ik
+
+
+
+
+
 # [5.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/ik@5.1.2...@quenty/ik@5.2.0) (2022-01-07)
 
 **Note:** Version bump only for package @quenty/ik

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/ik",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "Inverse Kinematics for characters on Roblox",
   "keywords": [
     "Roblox",
@@ -26,27 +26,27 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/acceltween": "^2.0.1",
-    "@quenty/baseobject": "^3.4.0",
-    "@quenty/binder": "^4.7.0",
-    "@quenty/camera": "^5.2.0",
-    "@quenty/characterutils": "^3.5.0",
-    "@quenty/humanoidtracker": "^3.7.0",
-    "@quenty/loader": "^3.3.0",
-    "@quenty/maid": "^2.0.2",
+    "@quenty/acceltween": "^2.1.0",
+    "@quenty/baseobject": "^3.5.0",
+    "@quenty/binder": "^4.8.0",
+    "@quenty/camera": "^5.3.0",
+    "@quenty/characterutils": "^3.6.0",
+    "@quenty/humanoidtracker": "^3.8.0",
+    "@quenty/loader": "^3.4.0",
+    "@quenty/maid": "^2.1.0",
     "@quenty/math": "^2.0.1",
-    "@quenty/promise": "^3.5.0",
-    "@quenty/ragdoll": "^5.2.0",
-    "@quenty/remoting": "^3.5.0",
-    "@quenty/servicebag": "^3.4.0",
+    "@quenty/promise": "^3.6.0",
+    "@quenty/ragdoll": "^5.3.0",
+    "@quenty/remoting": "^3.6.0",
+    "@quenty/servicebag": "^3.5.0",
     "@quenty/signal": "^2.1.0",
     "@quenty/table": "^2.1.1"
   },
   "devDependencies": {
-    "@quenty/rigbuilderutils": "^3.5.0"
+    "@quenty/rigbuilderutils": "^3.6.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5a3f3fb6c908fd3874f5ceacc70b404780275119"
+  "gitHead": "c094ba8f4e128cdff08919d89de226d3d65247ce"
 }

package/src/Client/Rig/IKRigAimerLocalPlayer.lua

@@ -19,6 +19,15 @@ local IKRigAimerLocalPlayer = setmetatable({}, BaseObject)
 IKRigAimerLocalPlayer.ClassName = "IKRigAimerLocalPlayer"
 IKRigAimerLocalPlayer.__index = IKRigAimerLocalPlayer
 
+--[=[
+	Constructs a new IKRigAimerLocalPlayer. Should not be used directly.
+	See [IKServiceClient] for the correct usage.
+
+	@param serviceBag ServiceBag
+	@param ikRig IKRigClient
+	@param remoteEvent RemoteEvent
+	@return IKRigAimerLocalPlayer
+]=]
 function IKRigAimerLocalPlayer.new(serviceBag, ikRig, remoteEvent)
 	local self = setmetatable(BaseObject.new(), IKRigAimerLocalPlayer)
 
@@ -34,15 +43,26 @@ function IKRigAimerLocalPlayer.new(serviceBag, ikRig, remoteEvent)
 	return self
 end
 
+--[=[
+	Sets whether the local player should look around automatically.
+	@param lookAround boolean
+]=]
 function IKRigAimerLocalPlayer:SetLookAround(lookAround)
+	assert(type(lookAround) == "boolean", "Bad lookAround")
+
 	self._lookAround = lookAround
 end
 
--- @param position May be nil
+--[=[
+	Sets the aim position for the local player for this frame. See [IKAimPositionPriorites].
+
+	@param position Vector3? -- May be nil to say to aim at nothing
+	@param optionalPriority number
+]=]
 function IKRigAimerLocalPlayer:SetAimPosition(position, optionalPriority)
 	optionalPriority = optionalPriority or IKAimPositionPriorites.DEFAULT
 
-	if self._aimData and (tick() - self._aimData.timeStamp) < MAX_AGE_FOR_AIM_DATA then
+	if self._aimData and (os.clock() - self._aimData.timeStamp) < MAX_AGE_FOR_AIM_DATA then
 		if self._aimData.priority > optionalPriority then
 			return -- Don't overwrite
 		end
@@ -51,12 +71,16 @@ function IKRigAimerLocalPlayer:SetAimPosition(position, optionalPriority)
 	self._aimData = {
 		priority = optionalPriority;
 		position = position; -- May be nil
-		timeStamp = tick();
+		timeStamp = os.clock();
 	}
 end
 
+--[=[
+	Gets the current aim direction.
+	@return Vector3?
+]=]
 function IKRigAimerLocalPlayer:GetAimDirection()
-	if self._aimData and (tick() - self._aimData.timeStamp) < MAX_AGE_FOR_AIM_DATA then
+	if self._aimData and (os.clock() - self._aimData.timeStamp) < MAX_AGE_FOR_AIM_DATA then
 			-- If we have aim data within the last 0.2 seconds start pointing at that
 		return self._aimData.position -- May be nil
 	end
@@ -88,23 +112,26 @@ function IKRigAimerLocalPlayer:GetAimDirection()
 	return cameraCFrame.p + direction
 end
 
-
+--[=[
+	Updates the aimer on stepped.
+	@private
+]=]
 function IKRigAimerLocalPlayer:UpdateStepped()
-	if (tick() - self._lastUpdate) <= 0.05 then
+	if (os.clock() - self._lastUpdate) <= 0.05 then
 		return
 	end
 
 	local aimDirection = self:GetAimDirection()
 
-	self._lastUpdate = tick()
+	self._lastUpdate = os.clock()
 	local torso = self._ikRig:GetTorso()
 	if torso then
 		torso:Point(aimDirection)
 	end
 
 	-- Filter replicate
-	if (tick() - self._lastReplication) > REPLICATION_RATE then
-		self._lastReplication = tick()
+	if (os.clock() - self._lastReplication) > REPLICATION_RATE then
+		self._lastReplication = os.clock()
 		self._remoteEvent:FireServer(aimDirection)
 	end
 end

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

@@ -1,5 +1,6 @@
--- Main injection point
--- @script ClientMain
+--[[
+	@class ClientMain
+]]
 
 local require = require(script.Parent.loader).load(script)
 

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

@@ -1,5 +1,6 @@
--- Main injection point
--- @script ServerMain
+--[[
+	@class ServerMain
+]]
 
 local require = require(script.Parent.loader).load(script)