@quenty/animations 1.2.1-canary.402.5852ffd.0 → 1.2.1-canary.402.a911cda.0

package/CHANGELOG.md

@@ -3,9 +3,21 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [1.2.1-canary.402.5852ffd.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/animations@1.2.0...@quenty/animations@1.2.1-canary.402.5852ffd.0) (2023-08-16)
+## [1.2.1-canary.402.a911cda.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/animations@1.2.0...@quenty/animations@1.2.1-canary.402.a911cda.0) (2023-08-23)
 
-**Note:** Version bump only for package @quenty/animations
+
+### Bug Fixes
+
+* Add missing dependency ([42ac596](https://github.com/Quenty/NevermoreEngine/commit/42ac5964e2154311070278732bf61b2b6b6982ce))
+* Rename HoarcekatRigAnimator ([87ff244](https://github.com/Quenty/NevermoreEngine/commit/87ff244c1ef964a496fd71c08e9a4f3fb195a2b7))
+* Track weight will only adjust if we get a track ([e885fce](https://github.com/Quenty/NevermoreEngine/commit/e885fced59555520dce0ed0a21f95157ba45f14d))
+
+
+### Features
+
+* Add AnimationSlotPlayer.new(animationTarget) ([86f1e99](https://github.com/Quenty/NevermoreEngine/commit/86f1e9989d4c52b136078a9c4c34c205e2e88549))
+* Add AnimationTrackPlayer.new(animationTarget, animationId) ([7b254c2](https://github.com/Quenty/NevermoreEngine/commit/7b254c2870b8ed930c33081df84944925702d10a))
+* Add studio rig animator ([9a6578b](https://github.com/Quenty/NevermoreEngine/commit/9a6578bfd712728b179ce40096f1ee7c581c112f))
 
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/animations",
-  "version": "1.2.1-canary.402.5852ffd.0",
+  "version": "1.2.1-canary.402.a911cda.0",
   "description": "Utility methods for playing back animations on Roblox",
   "keywords": [
     "Roblox",
@@ -25,14 +25,19 @@
     "Quenty"
   ],
   "dependencies": {
+    "@quenty/baseobject": "6.2.2-canary.402.a911cda.0",
     "@quenty/enumutils": "3.1.0",
     "@quenty/humanoidanimatorutils": "2.2.0",
-    "@quenty/loader": "6.2.2-canary.402.5852ffd.0",
-    "@quenty/promisemaid": "1.2.1-canary.402.5852ffd.0",
-    "@quenty/rbxasset": "1.1.1-canary.402.5852ffd.0"
+    "@quenty/loader": "6.2.2-canary.402.a911cda.0",
+    "@quenty/maid": "2.5.1-canary.402.a911cda.0",
+    "@quenty/promisemaid": "1.2.1-canary.402.a911cda.0",
+    "@quenty/rbxasset": "1.1.1-canary.402.a911cda.0",
+    "@quenty/rx": "7.14.1-canary.402.a911cda.0",
+    "@quenty/signal": "2.4.0",
+    "@quenty/valueobject": "7.21.1-canary.402.a911cda.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5852ffdd4ee4f857a5b7086330d59d852de49b86"
+  "gitHead": "a911cdaf4f1039b599528cec17b027f4660e4fd8"
 }

package/src/Shared/AnimationSlotPlayer.lua

@@ -0,0 +1,90 @@
+--[=[
+	@class AnimationSlotPlayer
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local AnimationUtils = require("AnimationUtils")
+local ValueObject = require("ValueObject")
+local Maid = require("Maid")
+local EnumUtils = require("EnumUtils")
+
+local AnimationSlotPlayer = setmetatable({}, BaseObject)
+AnimationSlotPlayer.ClassName = "AnimationSlotPlayer"
+AnimationSlotPlayer.__index = AnimationSlotPlayer
+
+function AnimationSlotPlayer.new(animationTarget)
+	local self = setmetatable(BaseObject.new(), AnimationSlotPlayer)
+
+	self._animationTarget = ValueObject.new(nil)
+	self._maid:GiveTask(self._animationTarget)
+
+	self._defaultFadeTime = ValueObject.new(0.1, "number")
+	self._maid:GiveTask(self._defaultFadeTime)
+
+	self._defaultAnimationPriority = ValueObject.new(nil)
+	self._maid:GiveTask(self._defaultAnimationPriority)
+
+	if animationTarget then
+		self:SetAnimationTarget(animationTarget)
+	end
+
+	return self
+end
+
+function AnimationSlotPlayer:SetDefaultFadeTime(defaultFadeTime)
+	self._defaultFadeTime.Value = defaultFadeTime
+end
+
+function AnimationSlotPlayer:SetDefaultAnimationPriority(defaultAnimationPriority)
+	assert(EnumUtils.isOfType(Enum.AnimationPriority, defaultAnimationPriority) or defaultAnimationPriority == nil, "Bad defaultAnimationPriority")
+
+	self._defaultAnimationPriority.Value = defaultAnimationPriority
+end
+
+function AnimationSlotPlayer:SetAnimationTarget(animationTarget)
+	self._animationTarget:Mount(animationTarget)
+end
+
+function AnimationSlotPlayer:Play(id, fadeTime, weight, speed, priority)
+	fadeTime = fadeTime or self._defaultFadeTime.Value
+	priority = priority or self._defaultAnimationPriority.Value
+	weight = weight or 1 -- We need to explicitly adjust the weight here
+
+	local topMaid = Maid.new()
+
+	topMaid:GiveTask(self._animationTarget:ObserveBrio(function(target)
+		return target ~= nil
+	end):Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local animationTarget = brio:GetValue()
+		local maid = brio:ToMaid()
+
+		local track = AnimationUtils.playAnimation(animationTarget, id, fadeTime, weight, speed, priority)
+		if track then
+			maid:GiveTask(function()
+				track:AdjustWeight(0, fadeTime or self._defaultFadeTime.Value)
+			end)
+		else
+			warn("[AnimationSlotPlayer] - Failed to get animation to play")
+		end
+	end))
+
+	self._maid._current = topMaid
+
+	return function()
+		if self._maid._current == topMaid then
+			self._maid._current = nil
+		end
+	end
+end
+
+function AnimationSlotPlayer:Stop()
+	self._maid._current = nil
+end
+
+return AnimationSlotPlayer

package/src/Shared/AnimationTrackPlayer.lua

@@ -0,0 +1,155 @@
+--[=[
+	@class AnimationTrackPlayer
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local ValueObject = require("ValueObject")
+local Rx = require("Rx")
+local AnimationUtils = require("AnimationUtils")
+local Signal = require("Signal")
+
+local AnimationTrackPlayer = setmetatable({}, BaseObject)
+AnimationTrackPlayer.ClassName = "AnimationTrackPlayer"
+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._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)
+
+	if animationTarget then
+		self:SetAnimationTarget(animationTarget)
+	end
+
+	if animationId then
+		self:SetAnimationId(animationId)
+	end
+
+	self:_setupState()
+
+	return self
+end
+
+function AnimationTrackPlayer:_setupState()
+	self._maid:GiveTask(Rx.combineLatest({
+		animationTarget = self._animationTarget:Observe();
+		trackId = self._trackId:Observe();
+		animationPriority = self._animationPriority:Observe();
+	}):Pipe({
+		Rx.throttleDefer();
+	}):Subscribe(function(state)
+		if state.animationTarget and state.trackId then
+			self._currentTrack.Value = AnimationUtils.getOrCreateAnimationTrack(state.animationTarget, state.trackId, state.animationPriority)
+		else
+			self._currentTrack.Value = nil
+		end
+	end))
+
+	self._maid:GiveTask(self._currentTrack:ObserveBrio(function(track)
+		return track ~= nil
+	end):Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local maid = brio:ToMaid()
+		local track = brio:GetValue()
+
+		maid:GiveTask(track.KeyframeReached:Connect(function(...)
+			self.KeyframeReached:Fire(...)
+		end))
+	end))
+end
+
+function AnimationTrackPlayer:SetAnimationId(animationId)
+	return self._trackId:Mount(animationId)
+end
+
+function AnimationTrackPlayer:GetAnimationId()
+	return self._trackId.Value
+end
+
+function AnimationTrackPlayer:SetAnimationTarget(animationTarget)
+	return self._animationTarget:Mount(animationTarget)
+end
+
+function AnimationTrackPlayer:SetWeightTargetIfNotSet(weight, fadeTime)
+	self._maid._adjustWeight = self:_onEachTrack(function(_maid, track)
+		if track.WeightTarget ~= weight then
+			track:AdjustWeight(weight, fadeTime)
+		end
+	end)
+end
+
+function AnimationTrackPlayer:Play(fadeTime, weight, speed)
+	if weight then
+		self._maid._adjustWeight = nil
+	end
+
+	if speed then
+		self._maid._adjustSpeed = nil
+	end
+
+	self._maid._stop = nil
+	self._maid._play = self:_onEachTrack(function(_maid, track)
+		track:Play(fadeTime, weight, speed)
+	end)
+end
+
+function AnimationTrackPlayer:Stop(fadeTime)
+	self._maid._play = nil
+	self._maid._stop = self:_onEachTrack(function(_maid, track)
+		track:Stop(fadeTime)
+	end)
+end
+
+function AnimationTrackPlayer:AdjustWeight(weight, fadeTime)
+	self._maid._adjustWeight = self:_onEachTrack(function(_maid, track)
+		track:AdjustWeight(weight, fadeTime)
+	end)
+end
+
+function AnimationTrackPlayer:AdjustSpeed(speed, fadeTime)
+	self._maid._adjustSpeed = self:_onEachTrack(function(_maid, track)
+		track:AdjustSpeed(speed, fadeTime)
+	end)
+end
+
+function AnimationTrackPlayer:IsPlaying()
+	local track = self._currentTrack.Value
+	if track then
+		return track.IsPlaying
+	else
+		return false
+	end
+end
+
+function AnimationTrackPlayer:_onEachTrack(callback)
+	return self._currentTrack:ObserveBrio(function(track)
+		return track ~= nil
+	end):Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local track = brio:GetValue()
+		callback(brio:ToMaid(), track)
+	end)
+end
+
+return AnimationTrackPlayer

package/src/Shared/Testing/StudioRigAnimator.lua

@@ -0,0 +1,41 @@
+--[=[
+	Ship to run animations in hoarcekat
+
+	@class StudioRigAnimator
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RunService = game:GetService("RunService")
+
+local BaseObject = require("BaseObject")
+local AnimationUtils = require("AnimationUtils")
+
+local StudioRigAnimator = setmetatable({}, BaseObject)
+StudioRigAnimator.ClassName = "StudioRigAnimator"
+StudioRigAnimator.__index = StudioRigAnimator
+
+function StudioRigAnimator.new(animatorOrHumanoid)
+	local self = setmetatable(BaseObject.new(animatorOrHumanoid), StudioRigAnimator)
+
+	if RunService:IsStudio() and not RunService:IsRunning() then
+		self:_setupStudio()
+	end
+
+	return self
+end
+
+function StudioRigAnimator:_setupStudio()
+	self._animator = AnimationUtils.getOrCreateAnimator(self._obj)
+	self._lastTime = os.clock()
+
+	self._maid:GiveTask(RunService.RenderStepped:Connect(function()
+		local now = os.clock()
+		local delta = now - self._lastTime
+		self._lastTime = now
+
+		self._animator:StepAnimations(delta)
+	end))
+end
+
+return StudioRigAnimator