v2.1.0​

12/27/2024​

• Enhancements
  • Set animation track names to be the same as their source animation instance names for convenience.
  • Added Animations:WaitForRigPlayingTrack()/Animations:FindFirstRigPlayingTrack(). Issue #62
  • [Beta] Added Animations:GetTimeOfMarker(). Issue #64
  • Added Animations:GetAnimationIdString().

• Changes (non-breaking)
  • Removed Animations.AutoRegisterPlayers on client and server. Automatic registration will always happen through player.CharacterAdded events. This decision was made for convenience and to eliminate the redudancy with Animations.AutoLoadAllPlayerTracks which also automatically registers the players when their character gets added.

• Fixes
  • Utility module ChildFromPath bug. Issue #59
  • Documentation fixes. Issue #58

v2.0.0​

8/24/2024​

• Changes (breaking)
  • Changed method of requiring HasAnimatedObject() function in AnimationIds module. After replacing the empty deps with your current ones, the directory structure should look like this:

Animations/ (new)
  Deps/ (mix)
    AnimationIds (new with copied table from old)
    AnimationProfiles (old)
    AnimatedObjects (old)
    AutoCustomRBXAnimationIds (old)
  Package/ (new)
    ...

• Ehancements
  • Added HasProperties() function in AnimationIds module. Issue #54
  • Added Animations:GetAppliedProfileName(). Issue #53

• Fixes
  • Fixed AutoCustomRBXAnimationIds not working. Issue #55
  • Fixed waiting for player.CharacterAdded event that might never happen if Players.CharacterAutoLoads is disabled. Issue #52
  • Fixed "Cannot load the AnimationClipProvider Service" error/bug. Issue #51
  • Fixed documentation issues. Issue #49, Issue #50

v2.0.0-rc1​

7/25/2024​

Migrate to v2.0.0 guide

• Changes (breaking)
  • Changed init option Animations.AutoLoadPlayerTracks -> to -> Animations.AutoLoadAllPlayerTracks in order to match the new Animations:LoadAllTracks(). Issue #43
  • Changed Animations:LoadTracks -> to -> Animations:LoadAllTracks(). Issue #43
  • Changed Animations:AwaitLoaded() -> to -> Animations:AwaitAllTracksLoaded(). Issue #43
  • Changed Animations:AreTracksLoaded() -> to -> Animations:AreAllTracksLoaded(). Issue #43
  • Changed Animations:StopAllTracks() -> to -> Animations:StopPlayingTracks() in order to match the new Animations:GetPlayingTracks(). Issue #42

• Enhancements
  • Wally support.
  • Added method Animations:AwaitPreloadAsyncFinished().
  • Added methods Animations:Register()/Animations:AwaitRegistered()/Animations:IsRegistered(). Issue #43
  • Added methods Animations:LoadTracksAt()/Animations:AwaitTracksLoadedAt()/Animations:AreTracksLoadedAt(). Issue #43
  • Added event Animations.PreloadAsyncProgressed.
  • Added init option Animations.DepsFolderPath. Issue #46
  • Added Animations:GetPlayingTracks(). Issue #42
  • Added init option AnimationsClient.EnableAutoCustomRBXAnimationIds.
  • Added init option AnimationsClient.AutoRegisterPlayer/AnimationsServer.AutoRegisterPlayers. Issue #43

• Changes (non-breaking)
  • Changed init option AnimationsServer.TimeToLoadPrints to default to true because it's important to realize that initialization can yield for quite some time during ContentProvider:PreloadAsync() on all animations in the AnimationIds module. Issue #44

• Fixes
  • Fixed ContentProvider:PreloadAsync() being called every time tracks got loaded for a rig. Issue #44
  • Fixed animations server editing players' animate scripts when it wasn't necessary. Issue #45

• Notes
  • It was impossible to load tracks seperately with the Animations:LoadTracks() method. This is now possible and means that loading tracks could happen many times during one rig's lifetime forcing us to seperate registration into Animations:Register() so that it only happens once before any track loading does.

v2.0.0-alpha​

6/23/2024​

• Changes (breaking)
  • [Beta] Changed the animated object specifier parameter of Animations:AttachAnimatedObject() and Animations:DetachAnimatedObject() to just a path type.
  • [Beta] Changed HasAnimatedObject() optional parameter autoAttachDetachSettings? -> to -> required parameter animatedObjectSettings.

• Enhancements
  • Added Animations:StopAllTracks(). Issue #39
  • Added Animations:GetAnimationProfile(). Issue #29
  • Added information on the all too common "Animator.EvaluationThrottled" error. Issue #38
  • Added R6/R15 NPC support for Animations:ApplyCustomRBXAnimationIds() and Animations:ApplyAnimationProfile() on client & server. There are caveats when using these, be sure to read documentation. Issue #41
  • Added more clear usage description of animation profiles. Issue #34
  • [Beta] Added optional parameter DoUnpack? for HasAnimatedObject().
  • Added warning and yield until the server initializes in AnimationsClient:Init(). Issue #37
  • AnimationsServer:LoadTracks() now automatically applies rigType of "Player" if no rigType is specified and the player_or_rig is a player or player's character.
  • Rewrite of animated objects system (still in beta).

• Changes (non-breaking)
  • [Beta] Changed HasAnimatedObject() to no longer require a RunContext in autoAttachDetachSettings? (which is now animatedObjectSettings). It will now automatically run on client & server. Issue #31

• Fixes
  • Fixed memory leak associated with trusting that the Player.Character.Destroying event would fire when a character model got removed from the game.
  • Fixed "Animator.EvaluationThrottled" error caused by Animations.TimeToLoadPrints.
  • Fixed problem with string paths involving utility function GetChildFromPath(). Issue #40
  • Fixed auto detach of animated objects being bugged. Issue #36
  • Fixed right grip weld not getting disabled for multiple animated object equips. Issue #30
  • Fixed animation ids not being able to attach to multiple animated objects. Issue #32
  • Fixed incorrect type for AnimationsServer:StopTracksOfPriority(). Issue #33
  • Fixed documentation mistakes. Issue #35

v1.3.0​

5/6/2024​

• Enhancements
  • Added animation profiles. Issue #22
  • Added Animations:StopTracksOfPriority(). Issue #26
  • Errors if no "animator parent" (Humanoid or AnimationController) exists in the rig. Issue #27

• Fixes
  • Fixed calling Humanoid:ChangeState() when it shouldn't be called. Issue #28
  • Fixed no documentation on AnimationsClient:DetachAnimatedObject(). Issue #25
  • Fixed basic usage document mistakes. Issue #24, Issue #23

v1.2.0​

2/20/2024​

• Enhancements
  • Added AnimationsClient:ApplyCustomRBXAnimationIds(). Issue #21

• Fixes
  • Fixed AnimationsServer:ApplyCustomRBXAnimationIds() not updating the animations until after the player moved.

v1.1.0​

2/18/2024​

• Enhancements
  • [Beta] Added Animations:AttachAnimatedObject(), Animations:DetachAnimatedObject() methods, HasAnimatedObject function in the AnimationIds module, and an animated objects tutorial. Issue #15
  • Added a tip that "walk" is the animation id that is applied for R6 characters and "run" is the animation id that is applied for R15 characters when using AnimationsServer:ApplyCustomRBXAnimationIds() and AutoCustomRBXAnimationIds. Issue #20

• Changes (non-breaking)
  • Changed ASSET_ID_STR to format an integer instead of a float. Issue #19

• Fixes
  • Fixed lots of documentation and typing errors, especially related to CustomRBXAnimationIds which is now humanoidRigTypeToCustomRBXAnimationIds.
  • Fixed AnimationsServer:ApplyCustomRBXAnimationIds() and AutoCustomRBXAnimationIds not working. Issue #18
  • Fixed bad type annotation for AutoCustomRBXAnimationIds. Issue #16

v1.0.5​

1/31/2024​

• Fixes
  • Fixed all methods having no auto-complete (bad types). Issue #12
  • Fixed missing weight and speed parameters for auto-complete in some methods (bad types). Issue #13
  • Fixed an overcomplicated private method :_getAnimatorOrAnimationController() in the AnimationsClass. Its new name is :_getAnimator(). Issue #14

v1.0.4​

11/22/2023​

• Enhancements
  • Put both client & server animation modules in --!strict mode. This allowed for a lot of typing fixes.
  • Added a warning Infinite yield possible on 'player_or_rig.CharacterAdded():Wait()' that occurs whenever the getRig() helper function is called if the player's character doesn't exist after 5 seconds. This is helpful if Players.CharacterAutoLoads is not enabled and getRig() gets called.

• Fixes
  • Fixed initOptions.AutoCustomRBXAnimationIds not working because it was named incorrectly. New name is initOptions.EnableAutoCustomRBXAnimationIds. AnimationsServer initOptions
  • Fixed multiple references to the same animation id's table causing an error. Issue #11
  • Fixed incorrect types.

v1.0.3​

11/22/2023​

• Enhancements
  • Animations:LoadTracks() now automatically gives the rig an attribute AnimationsRigType set to the given rigType (which is "Player" when the client calls it). Issue #9
  • Explained a convenient feature when using Animations:SetTrackAlias() in the documentation of the function.

• Fixes
  • Fixed Animations:GetTrackFromAlias() not working. Issue #10
  • Fixed Util.ChildFromPath bug that caused errors when the parent became nil during the recursion. Issue #7

v1.0.2​

8/31/2023​

• Enhancements
  • Added assertions to check AnimationsClient and AnimationsServer are being required on the client & server respectively. Issue #4

• Fixes
  • Fixed subsequent Animations:AwaitLoaded() calls getting discarded. Issue #5
  • Fixed documentation. Issue #3
  • Fixed documentation. Issue #2
  • Removed an unecessary :. Issue #1

v1.0.1​

8/3/2023​

• Fixes
  • Fixed Animation:Init() error when called without optional initOptions.

v1.0.0​

8/3/2023​

• Initial release