skeleton:addAnimationAt()

Type: function
See also: skeleton, skeleton:addAnimation(), trackEntry

Overview

Queues an animation at an absolute track timeline time (in milliseconds). This is useful when you schedule animation changes from authored timestamps.

The time is measured from the start of the entry currently playing on the track, so the origin moves as the queue advances. On an empty track, the time is measured from now: a positive time first sets an empty animation on the track, and 0 or less plays the animation at once.

Syntax

local trackEntryOrFalse = skeleton:addAnimationAt(trackIndex, animationName, loop, startTimeMs)

Parameters

  • trackIndex (required):

    number – 1-based track index.

  • animationName (required):

    string – Name of the animation.

  • loop (optional):

    boolean – Loop or not. Defaults to false.

  • startTimeMs (required):

    number – Absolute time on the track timeline, in milliseconds.

Return value

  • trackEntry or false – Returns a trackEntry on success, otherwise false.

Example

spineboy:setAnimation(1, "idle", true)
spineboy:addAnimationAt(1, "talk_open", false, 120)
spineboy:addAnimationAt(1, "talk_closed", false, 180)

Notes

On a track that is playing, a time at or before the start of the last queued entry does not wait for that entry to complete: the new entry starts on the update right after the last queued entry starts. Queue times in increasing order to get one entry after the other at their own times.