animation.*

Type Library
Revision Release 2024.3703
Keywords animation, tween, timeline, interpolation
Platforms Android, iOS, macOS, Windows, tvOS
See also Animation — Tweens and Timelines (guide)
Tween
Timeline

The animation plugin (tweens/timelines) is not related to frame-based sprite animation. If you are looking for details on how to animate sprite objects, please see the Sprite Animation guide.

Overview

The animation plugin provides functions and methods to move, rotate, fade, or scale a display object/group over a specific period of time. It also lets you construct timelines for more intricate sequenced animations across one or more display objects/groups. Features include:

Functions

animation.to()

animation.from()

animation.pause()

animation.resume()

animation.cancel()

animation.newTimeline()

animation.setPosition()

animation.setSpeedScale()

animation.getAnimations()

Project Settings

To use this plugin, add an entry into the plugins table of build.settings.

settings =
{
    plugins =
    {
        ["plugin.animation"] =
        {
            publisherId = "com.coronalabs"
        },
    },
}

Source

If you want to add, modify or extend functionality, download the source code from GitHub and include in your project(See Using External Modules).