Feedback
  • press ENTER to search or ESC to cancel

Table of content

Overview
API Changes

Globals namespaces

Constants

Classes/objects

Edit page

Tag

Represents a tag in the timeline.

Tag.sprite

Returns the sprite to which this tag belongs.

Tag.fromFrame

Returns the first Frame object where this tag starts.

Note: Old versions (Aseprite v1.2.10-beta2) returned a frame number instead of a Frame object.

Tag.toFrame

Returns the last Frame object where this tag ends.

Note: Old versions (Aseprite v1.2.10-beta2) returned a frame number instead of a Frame object.

Tag.frames

Returns the number of frames that this tag contain. Equal to:

local frames = tag.toFrame.frameNumber - tag.fromFrame.frameNumber + 1

Tag.name 

local name = tag.name
tag.name = name

Gets or sets the name of the tag (a string).

Tag.aniDir 

local aniDir = tag.aniDir
tag.aniDir = AniDir.FORWARD
tag.aniDir = AniDir.REVERSE
tag.aniDir = AniDir.PING_PONG
tag.aniDir = AniDir.PING_PONG_REVERSE

Gets or sets the Animation Direction property of the tag.

Tag.color 

local color = tag.color
tag.color = color

Gets or sets the user-defined color of this tag in the timeline.

Tag.repeats 

local n = tag.repeats
tag.repeats = n

Gets or sets the number of times the tag is repeated/looped.

  • 0 = Doesn't specify, plays infinite in UI, once on export, for ping-pong it plays once in each direction
  • 1 = Plays once, for ping-pong it plays just in one direction
  • 2 = Plays twice, for ping-pong it plays once in each direction, and once in reverse
  • n = Plays N times

Tag.data 

local data = tag.data
tag.data = data

Gets or sets the user-defined data related to this tag, a string.

Tag.properties

Access user-defined and extension-defined properties of this tag.