@quenty/animations 7.0.0 → 8.0.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.
 
+# [8.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/animations@7.0.0...@quenty/animations@8.0.0) (2024-02-19)
+
+
+### Features
+
+* Add AnimationPromiseUtils.promiseLoaded(animationTrack) and other helper calls ([5f743bf](https://github.com/Quenty/NevermoreEngine/commit/5f743bf3bc877af91fb91074aa7d4b03d29a09c4))
+
+
+
+
+
 # [7.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/animations@6.0.0...@quenty/animations@7.0.0) (2024-02-14)
 
 **Note:** Version bump only for package @quenty/animations

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/animations",
-  "version": "7.0.0",
+  "version": "8.0.0",
   "description": "Utility methods for playing back animations on Roblox",
   "keywords": [
     "Roblox",
@@ -40,5 +40,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "63f949a67b77d3edc98b358cace163da8c789e9f"
+  "gitHead": "1258d00e6b21e727109e5eaf99574a06874ca5a6"
 }

package/src/Shared/AnimationPromiseUtils.lua

@@ -4,12 +4,23 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local RunService = game:GetService("RunService")
+
 local Promise = require("Promise")
 local PromiseMaidUtils = require("PromiseMaidUtils")
 
 local AnimationPromiseUtils = {}
 
+--[=[
+	Promises that the track is finished
+
+	@param animationTrack AnimationTrack
+	@param endMarkerName string | nil
+	@return Promise
+]=]
 function AnimationPromiseUtils.promiseFinished(animationTrack, endMarkerName)
+	assert(typeof(animationTrack) == "Instance", "Bad animationTrack")
+	assert(type(endMarkerName) == "string" or endMarkerName == nil, "Bad endMarkerName")
 	local promise = Promise.new()
 
 	PromiseMaidUtils.whilePromise(promise, function(maid)
@@ -35,4 +46,83 @@ function AnimationPromiseUtils.promiseFinished(animationTrack, endMarkerName)
 	return promise
 end
 
+--[=[
+	Promises that the track has been loaded
+
+	@param animationTrack AnimationTrack
+	@return Promise
+]=]
+function AnimationPromiseUtils.promiseLoaded(animationTrack)
+	assert(typeof(animationTrack) == "Instance", "Bad animationTrack")
+
+	if animationTrack.Length > 0 then
+		return Promise.resolved()
+	end
+
+	local promise = Promise.new()
+
+	PromiseMaidUtils.whilePromise(promise, function(maid)
+		maid:GiveTask(animationTrack:GetPropertyChangedSignal("Length"):Connect(function()
+			if animationTrack.Length > 0 then
+				promise:Resolve()
+			end
+		end))
+
+		maid:GiveTask(RunService.Stepped:Connect(function()
+			if animationTrack.Length > 0 then
+				promise:Resolve()
+			end
+		end))
+
+		maid:GiveTask(animationTrack.Ended:Connect(function()
+			promise:Resolve()
+		end))
+
+		maid:GiveTask(animationTrack.Stopped:Connect(function()
+			promise:Resolve()
+		end))
+
+		maid:GiveTask(animationTrack.Destroying:Connect(function()
+			promise:Resolve()
+		end))
+	end)
+
+	return promise
+end
+
+--[=[
+	Promises that the track reached a keyframe or is finished
+
+	@param animationTrack AnimationTrack
+	@param keyframeName string
+	@return Promise
+]=]
+function AnimationPromiseUtils.promiseKeyframeReached(animationTrack, keyframeName)
+	assert(typeof(animationTrack) == "Instance", "Bad animationTrack")
+	assert(type(keyframeName) == "string", "Bad endMarkerName")
+
+	local promise = Promise.new()
+
+	PromiseMaidUtils.whilePromise(promise, function(maid)
+		maid:GiveTask(animationTrack.Ended:Connect(function()
+			promise:Resolve()
+		end))
+
+		maid:GiveTask(animationTrack.Stopped:Connect(function()
+			promise:Resolve()
+		end))
+
+		maid:GiveTask(animationTrack.Destroying:Connect(function()
+			promise:Resolve()
+		end))
+
+		maid:GiveTask(animationTrack:GetMarkerReachedSignal(keyframeName):Connect(function()
+			promise:Resolve()
+		end))
+	end)
+
+	return promise
+end
+
+
 return AnimationPromiseUtils

package/src/Shared/AnimationTrackPlayer.lua

@@ -17,20 +17,12 @@ AnimationTrackPlayer.__index = AnimationTrackPlayer
 function AnimationTrackPlayer.new(animationTarget, animationId)
 	local self = setmetatable(BaseObject.new(), AnimationTrackPlayer)
 
-	self._animationTarget = ValueObject.new(nil)
-	self._maid:GiveTask(self._animationTarget)
+	self._animationTarget = self._maid:Add(ValueObject.new(nil))
+	self._trackId = self._maid:Add(ValueObject.new(nil))
+	self._currentTrack = self._maid:Add(ValueObject.new(nil))
+	self._animationPriority = self._maid:Add(ValueObject.new(nil))
 
-	self._trackId = ValueObject.new(nil)
-	self._maid:GiveTask(self._trackId)
-
-	self._currentTrack = ValueObject.new(nil)
-	self._maid:GiveTask(self._currentTrack)
-
-	self.KeyframeReached = Signal.new()
-	self._maid:GiveTask(self.KeyframeReached)
-
-	self._animationPriority = ValueObject.new(nil)
-	self._maid:GiveTask(self._animationPriority)
+	self.KeyframeReached = self._maid:Add(Signal.new())
 
 	if animationTarget then
 		self:SetAnimationTarget(animationTarget)