Lib: Animate

3.2.0 (2026-02-22)

Full Changelog Previous Releases

• chore: release 3.2.0 (#24)
  Automated release PR for version 3.2.0
  Co-authored-by: Xerrion 1850632+Xerrion@users.noreply.github.com
• feat: add delay, repeatCount, and animation queue support (#27)

  New Features

• Delay
  Animations can now start after a configurable delay:

  LibAnimate:Animate(frame, "fadeInUp", { delay = 0.5, distance = 300 })  
  

• Repeat / Loop
  Play animations multiple times or loop infinitely:

  LibAnimate:Animate(frame, "pulse", { repeatCount = 3 })  
  LibAnimate:Animate(frame, "heartBeat", { repeatCount = 0 }) -- infinite  
  

• Animation Queue
  Chain animations in sequence with per-step callbacks:

  LibAnimate:Queue(frame, {  
      { name = "fadeInUp", duration = 0.4, distance = 200 },  
      { name = "fadeOutDown", delay = 3.0, duration = 0.4, distance = 200,  
        onFinished = function(f) f:Hide() end },  
  })  
  

• New API Methods
  • Queue(frame, entries, opts?) — Queue a sequence of animations
  • ClearQueue(frame) — Cancel queue and stop
  • IsQueued(frame) — Check if frame has a queue
• Changes
  • AnimateOpts now accepts delay and repeatCount
  • Stop() also clears any active queue
  • Animate() clears any active queue on the frame
  • Full LuaCATS documentation on all new/modified code
  • README updated with new methods and features
  • Wiki pages updated (API Reference, Getting Started, Home)
• docs: streamline README, defer detailed docs to wiki (#26)

  Summary

  • Slim down README from 475 lines to 146 by replacing inline API docs,
    animation catalog, custom animations, and easing function details with
    summary tables and links to the comprehensive Wiki
  • Added API Overview table with one-line method descriptions
  • Added Built-in Animations count-by-category table
  • Added Documentation section linking all 5 wiki pages
    Wiki pages: https://github.com/Xerrion/LibAnimate/wiki
• docs: add shields.io badges to README (#25)
  Add release version, MIT license, lint status, and wiki documentation
  badges to the README header.
• Add funding options for GitHub and Ko-fi
  Updated funding model to include specific usernames.
• docs: update README and API docs for 77 animations and attention type (#23)
  • Update README to reflect 77 built-in animations across all categories
  • Document attention-seeker animation type and GetAttentionAnimations API
  • Expand Animate, Stop, UpdateAnchor, RegisterAnimation documentation
  • Add GetAnimationInfo API reference
  • Document CubicBezier utility function
  • Add custom attention-seeker animation example
  • Update AnimationDefinition type to include "attention"
  • Fix EasingSpec line length for luacheck compliance