@quenty/animations 8.17.0 → 8.17.1

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.
 
+## [8.17.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/animations@8.17.0...@quenty/animations@8.17.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [8.17.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/animations@8.16.2...@quenty/animations@8.17.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/animations

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/animations",
-  "version": "8.17.0",
+  "version": "8.17.1",
   "description": "Utility methods for playing back animations on Roblox",
   "keywords": [
     "Roblox",
@@ -25,20 +25,20 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/enumutils": "^3.4.0",
-    "@quenty/humanoidanimatorutils": "^3.1.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/promisemaid": "^5.10.1",
-    "@quenty/rbxasset": "^5.8.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/baseobject": "^10.8.1",
+    "@quenty/enumutils": "^3.4.1",
+    "@quenty/humanoidanimatorutils": "^3.1.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/promise": "^10.10.2",
+    "@quenty/promisemaid": "^5.10.2",
+    "@quenty/rbxasset": "^5.8.1",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/signal": "^7.10.1",
+    "@quenty/valueobject": "^13.17.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/AnimationPromiseUtils.lua

@@ -15,10 +15,13 @@ local AnimationPromiseUtils = {}
 	Promises that the track is finished
 
 	@param animationTrack AnimationTrack
-	@param endMarkerName string | nil
+	@param endMarkerName string?
 	@return Promise
 ]=]
-function AnimationPromiseUtils.promiseFinished(animationTrack, endMarkerName)
+function AnimationPromiseUtils.promiseFinished(
+	animationTrack: AnimationTrack,
+	endMarkerName: string?
+): Promise.Promise<()>
 	assert(typeof(animationTrack) == "Instance", "Bad animationTrack")
 	assert(type(endMarkerName) == "string" or endMarkerName == nil, "Bad endMarkerName")
 	local promise = Promise.new()
@@ -52,7 +55,7 @@ end
 	@param animationTrack AnimationTrack
 	@return Promise
 ]=]
-function AnimationPromiseUtils.promiseLoaded(animationTrack)
+function AnimationPromiseUtils.promiseLoaded(animationTrack: AnimationTrack): Promise.Promise<()>
 	assert(typeof(animationTrack) == "Instance", "Bad animationTrack")
 
 	if animationTrack.Length > 0 then
@@ -97,7 +100,7 @@ end
 	@param keyframeName string
 	@return Promise
 ]=]
-function AnimationPromiseUtils.promiseKeyframeReached(animationTrack, keyframeName)
+function AnimationPromiseUtils.promiseKeyframeReached(animationTrack: AnimationTrack, keyframeName: string): Promise.Promise<()>
 	assert(typeof(animationTrack) == "Instance", "Bad animationTrack")
 	assert(type(keyframeName) == "string", "Bad endMarkerName")
 

package/src/Shared/AnimationSlotPlayer.lua

@@ -45,7 +45,7 @@ end
 
 	@param defaultFadeTime number
 ]=]
-function AnimationSlotPlayer:SetDefaultFadeTime(defaultFadeTime)
+function AnimationSlotPlayer:SetDefaultFadeTime(defaultFadeTime: number)
 	self._defaultFadeTime.Value = defaultFadeTime
 end
 
@@ -76,7 +76,7 @@ end
 	@param speed number
 	@return () -> () -- Callback to clean things up
 ]=]
-function AnimationSlotPlayer:AdjustSpeed(id, speed)
+function AnimationSlotPlayer:AdjustSpeed(id: string | number, speed: number)
 	assert(RbxAssetUtils.isConvertableToRbxAsset(id), "Bad id")
 	assert(type(speed) == "number", "Bad speed")
 
@@ -84,26 +84,28 @@ function AnimationSlotPlayer:AdjustSpeed(id, speed)
 
 	local topMaid = Maid.new()
 
-	topMaid:GiveTask(self._currentAnimationTrackData:ObserveBrio(function(data)
-		return data and data.animationId == animationId
-	end):Subscribe(function(brio)
-		if brio:IsDead() then
-			return
-		end
+	topMaid:GiveTask(self._currentAnimationTrackData
+		:ObserveBrio(function(data)
+			return data and data.animationId == animationId
+		end)
+		:Subscribe(function(brio)
+			if brio:IsDead() then
+				return
+			end
 
-		local data = brio:GetValue()
-		local maid = brio:ToMaid()
+			local data = brio:GetValue()
+			local maid = brio:ToMaid()
 
-		data.track:AdjustSpeed(speed)
+			data.track:AdjustSpeed(speed)
 
-		-- TODO: Use stack here?
-		-- TODO: Probably need rogue property mechanisms
-		maid:GiveTask(function()
-			if math.abs(data.track.Speed - speed) <= 1e-3 then
-				data.track:AdjustSpeed(data.originalSpeed)
-			end
-		end)
-	end))
+			-- TODO: Use stack here?
+			-- TODO: Probably need rogue property mechanisms
+			maid:GiveTask(function()
+				if math.abs(data.track.Speed - speed) <= 1e-3 then
+					data.track:AdjustSpeed(data.originalSpeed)
+				end
+			end)
+		end))
 
 	-- TODO: Probably per-a-track instead of global like this
 	self._maid._currentSpeedAdjustment = topMaid
@@ -120,10 +122,10 @@ end
 
 	@param id string | number
 	@param weight number
-	@param fadeTime number
+	@param fadeTime number?
 	@return () -> () -- Callback to clean things up
 ]=]
-function AnimationSlotPlayer:AdjustWeight(id, weight, fadeTime)
+function AnimationSlotPlayer:AdjustWeight(id: string, weight: number, fadeTime: number?)
 	assert(RbxAssetUtils.isConvertableToRbxAsset(id), "Bad id")
 	assert(type(weight) == "number", "Bad weight")
 	assert(type(fadeTime) == "number" or fadeTime == nil, "Bad fadeTime")
@@ -132,26 +134,28 @@ function AnimationSlotPlayer:AdjustWeight(id, weight, fadeTime)
 
 	local topMaid = Maid.new()
 
-	topMaid:GiveTask(self._currentAnimationTrackData:ObserveBrio(function(data)
-		return data and data.animationId == animationId
-	end):Subscribe(function(brio)
-		if brio:IsDead() then
-			return
-		end
+	topMaid:GiveTask(self._currentAnimationTrackData
+		:ObserveBrio(function(data)
+			return data and data.animationId == animationId
+		end)
+		:Subscribe(function(brio)
+			if brio:IsDead() then
+				return
+			end
 
-		local data = brio:GetValue()
-		local maid = brio:ToMaid()
+			local data = brio:GetValue()
+			local maid = brio:ToMaid()
 
-		data.track:AdjustWeight(weight, fadeTime)
+			data.track:AdjustWeight(weight, fadeTime)
 
-		-- TODO: Use stack here?
-		-- TODO: Probably need rogue property mechanisms
-		maid:GiveTask(function()
-			if math.abs(data.track.Speed - weight) <= 1e-3 then
-				data.track:AdjustWeight(data.originalWeight, fadeTime)
-			end
-		end)
-	end))
+			-- TODO: Use stack here?
+			-- TODO: Probably need rogue property mechanisms
+			maid:GiveTask(function()
+				if math.abs(data.track.Speed - weight) <= 1e-3 then
+					data.track:AdjustWeight(data.originalWeight, fadeTime)
+				end
+			end)
+		end))
 
 	-- TODO: Probably per-a-track instead of global like this
 	self._maid._currentWeightAdjustment = topMaid
@@ -170,10 +174,10 @@ end
 	@param fadeTime number?
 	@param weight number?
 	@param speed number?
-	@param priority number?
+	@param priority Enum.AnimationPriority?
 	@return () -> () -- Callback to clean things up
 ]=]
-function AnimationSlotPlayer:Play(id, fadeTime, weight, speed, priority)
+function AnimationSlotPlayer:Play(id: string | number, fadeTime: number?, weight: number?, speed: number?, priority: Enum.AnimationPriority?): () -> ()
 	fadeTime = fadeTime or self._defaultFadeTime.Value
 	priority = priority or self._defaultAnimationPriority.Value
 	weight = weight or 1 -- We need to explicitly adjust the weight here

package/src/Shared/AnimationTrackPlayer.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Plays a single track, allowing for the animation to be controlled easier.
 
@@ -21,11 +22,11 @@ AnimationTrackPlayer.__index = AnimationTrackPlayer
 	all data is found.
 
 	@param animationTarget Instance | Observable<Instance>
-	@param animationId string | number | nil
+	@param animationId string | number?
 	@return AnimationTrackPlayer
 ]=]
 function AnimationTrackPlayer.new(animationTarget, animationId)
-	local self = setmetatable(BaseObject.new(), AnimationTrackPlayer)
+	local self = setmetatable(BaseObject.new() :: any, AnimationTrackPlayer)
 
 	self._animationTarget = self._maid:Add(ValueObject.new(nil))
 	self._trackId = self._maid:Add(ValueObject.new(nil))
@@ -111,7 +112,7 @@ end
 	@param weight number
 	@param fadeTime number
 ]=]
-function AnimationTrackPlayer:SetWeightTargetIfNotSet(weight, fadeTime)
+function AnimationTrackPlayer:SetWeightTargetIfNotSet(weight: number, fadeTime: number)
 	self._maid._adjustWeight = self:_onEachTrack(function(_maid, track)
 		if track.WeightTarget ~= weight then
 			track:AdjustWeight(weight, fadeTime)
@@ -126,7 +127,7 @@ end
 	@param weight number
 	@param speed number
 ]=]
-function AnimationTrackPlayer:Play(fadeTime, weight, speed)
+function AnimationTrackPlayer:Play(fadeTime: number, weight: number, speed: number)
 	if weight then
 		self._maid._adjustWeight = nil
 	end
@@ -146,7 +147,7 @@ end
 
 	@param fadeTime number
 ]=]
-function AnimationTrackPlayer:Stop(fadeTime)
+function AnimationTrackPlayer:Stop(fadeTime: number)
 	self._maid._play = nil
 	self._maid._stop = self:_onEachTrack(function(_maid, track)
 		track:Stop(fadeTime)
@@ -159,7 +160,7 @@ end
 	@param weight number
 	@param fadeTime number
 ]=]
-function AnimationTrackPlayer:AdjustWeight(weight, fadeTime)
+function AnimationTrackPlayer:AdjustWeight(weight: number, fadeTime: number)
 	self._maid._adjustWeight = self:_onEachTrack(function(_maid, track)
 		track:AdjustWeight(weight, fadeTime)
 	end)
@@ -171,7 +172,7 @@ end
 	@param speed number
 	@param fadeTime number
 ]=]
-function AnimationTrackPlayer:AdjustSpeed(speed, fadeTime)
+function AnimationTrackPlayer:AdjustSpeed(speed: number, fadeTime: number)
 	self._maid._adjustSpeed = self:_onEachTrack(function(_maid, track)
 		track:AdjustSpeed(speed, fadeTime)
 	end)
@@ -182,7 +183,7 @@ end
 
 	@return boolean
 ]=]
-function AnimationTrackPlayer:IsPlaying()
+function AnimationTrackPlayer:IsPlaying(): boolean
 	local track = self._currentTrack.Value
 	if track then
 		return track.IsPlaying

package/src/Shared/AnimationUtils.lua

@@ -21,13 +21,14 @@ function AnimationUtils.playAnimation(
 	fadeTime: number?,
 	weight: number?,
 	speed: number?,
-	priority: AnimationPriority?): AnimationTrack?
+	priority: Enum.AnimationPriority?
+): AnimationTrack?
 	assert(typeof(target) == "Instance", "Bad target")
 	assert(RbxAssetUtils.isConvertableToRbxAsset(id), "Bad id")
 	assert(type(fadeTime) == "number" or fadeTime == nil, "Bad fadeTime")
 	assert(type(weight) == "number" or weight == nil, "Bad weight")
 	assert(type(speed) == "number" or speed == nil, "Bad speed")
-	assert(EnumUtils.isOfType(Enum.AnimationPriority, priority) or priority == nil, "Bad priority")
+	assert(priority == nil or EnumUtils.isOfType(Enum.AnimationPriority, priority), "Bad priority")
 
 	local animationTrack = AnimationUtils.getOrCreateAnimationTrack(target, id, priority)
 
@@ -47,7 +48,11 @@ end
 --[=[
 	Stops the animation on the target instance.
 ]=]
-function AnimationUtils.stopAnimation(target: Animator | Player | Model | AnimationController, id: string | number, fadeTime: number?): AnimationTrack?
+function AnimationUtils.stopAnimation(
+	target: Animator | Player | Model | AnimationController,
+	id: string | number,
+	fadeTime: number?
+): AnimationTrack?
 	assert(typeof(target) == "Instance", "Bad target")
 	assert(RbxAssetUtils.isConvertableToRbxAsset(id), "Bad id")
 	assert(type(fadeTime) == "number" or fadeTime == nil, "Bad fadeTime")
@@ -67,10 +72,11 @@ end
 function AnimationUtils.getOrCreateAnimationTrack(
 	target: Animator | Player | Model | AnimationController,
 	id: string | number,
-	priority: AnimationPriority?): AnimationTrack?
+	priority: Enum.AnimationPriority?
+): AnimationTrack?
 	assert(typeof(target) == "Instance", "Bad target")
 	assert(RbxAssetUtils.isConvertableToRbxAsset(id), "Bad id")
-	assert(EnumUtils.isOfType(Enum.AnimationPriority, priority) or priority == nil, "Bad priority")
+	assert(priority == nil or EnumUtils.isOfType(Enum.AnimationPriority, priority), "Bad priority")
 
 	local animator = AnimationUtils.getOrCreateAnimator(target)
 	if not animator then
@@ -91,7 +97,13 @@ function AnimationUtils.getOrCreateAnimationTrack(
 		animationTrack = animator:LoadAnimation(animation)
 	end)
 	if not ok then
-		warn(string.format("[AnimationUtils] - Failed to load animation with id %q due to %q", tostring(id), tostring(err)))
+		warn(
+			string.format(
+				"[AnimationUtils] - Failed to load animation with id %q due to %q",
+				tostring(id),
+				tostring(err)
+			)
+		)
 		return nil
 	end
 
@@ -101,12 +113,12 @@ end
 --[=[
 	Gets or creates an animation from the id in the animator
 ]=]
-function AnimationUtils.getOrCreateAnimationFromIdInAnimator(animator: Animator, id: string | number): Animation?
+function AnimationUtils.getOrCreateAnimationFromIdInAnimator(animator: Animator, id: string | number): Animation
 	assert(typeof(animator) == "Instance" and animator:IsA("Animator"), "Bad animator")
 	assert(RbxAssetUtils.isConvertableToRbxAsset(id), "Bad id")
 
 	local animationId = RbxAssetUtils.toRbxAssetId(id)
-	for _, animation in pairs(animator:GetChildren()) do
+	for _, animation in animator:GetChildren() do
 		if animation:IsA("Animation") then
 			if animation.AnimationId == animationId then
 				return animation
@@ -125,7 +137,8 @@ end
 ]=]
 function AnimationUtils.findAnimationTrack(
 	target: Animator | Player | Model | AnimationController,
-	id: string | number): AnimationTrack?
+	id: string | number
+): AnimationTrack?
 	assert(typeof(target) == "Instance", "Bad target")
 	assert(RbxAssetUtils.isConvertableToRbxAsset(id), "Bad id")
 
@@ -146,7 +159,7 @@ function AnimationUtils.findAnimationTrackInAnimator(animator: Animator, id: str
 
 	local animationId = RbxAssetUtils.toRbxAssetId(id)
 
-	for _, animationTrack in pairs(animator:GetPlayingAnimationTracks()) do
+	for _, animationTrack in animator:GetPlayingAnimationTracks() do
 		local animation = animationTrack.Animation
 		if animation and animation.AnimationId == animationId then
 			return animationTrack
@@ -221,4 +234,4 @@ function AnimationUtils.createAnimationFromId(id: string | number): Animation
 	return animation
 end
 
-return AnimationUtils
+return AnimationUtils

package/src/Shared/Testing/StudioRigAnimator.lua

@@ -26,7 +26,7 @@ StudioRigAnimator.__index = StudioRigAnimator
 	@param animatorOrHumanoid Animator | Humanoid
 	@return StudioRigAnimator
 ]=]
-function StudioRigAnimator.new(animatorOrHumanoid)
+function StudioRigAnimator.new(animatorOrHumanoid: Animator | Humanoid)
 	local self = setmetatable(BaseObject.new(animatorOrHumanoid), StudioRigAnimator)
 
 	if RunService:IsStudio() and not RunService:IsRunning() then
@@ -38,6 +38,10 @@ end
 
 function StudioRigAnimator:_setupStudio()
 	self._animator = AnimationUtils.getOrCreateAnimator(self._obj)
+	if not self._animator then
+		return
+	end
+
 	self._lastTime = os.clock()
 
 	self._maid:GiveTask(RunService.RenderStepped:Connect(function()
@@ -49,4 +53,4 @@ function StudioRigAnimator:_setupStudio()
 	end))
 end
 
-return StudioRigAnimator
+return StudioRigAnimator

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

@@ -10,6 +10,13 @@ local AnimationUtils = require("AnimationUtils")
 
 game.UserInputService.InputBegan:Connect(function(inputObject)
 	if inputObject.KeyCode == Enum.KeyCode.Q then
-		AnimationUtils.playAnimation(Players.LocalPlayer, "rbxassetid://14012074834", nil, nil, 1, Enum.AnimationPriority.Action3)
+		AnimationUtils.playAnimation(
+			Players.LocalPlayer,
+			"rbxassetid://14012074834",
+			nil,
+			nil,
+			1,
+			Enum.AnimationPriority.Action3
+		)
 	end
-end)
+end)

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

@@ -5,4 +5,3 @@ local ServerScriptService = game:GetService("ServerScriptService")
 
 local loader = ServerScriptService:FindFirstChild("LoaderUtils", true).Parent
 require(loader).bootstrapGame(ServerScriptService.animations)
-