DatumHueEnterprise v0.0.24datumhue.com
Contents

handle8 methods, 5 fields

Animator

A sprite-animation playhead bound to one sprite by SpriteClips:bind. Drives the sprite's atlas cell over time; play/queue/stop/pause/resume/seek control it, on_finish/on_marker observe it, and clip/frame/playing/speed/looping read or set its state.

Obtained from
SpriteClips:bind

The examples on this page start from:

lua
local canvas = datumhue.draw.new({ width = 64, height = 64 })
canvas:mount({ width = 256, height = 256 })
local font = datumhue.image.font()
-- The digits 0 to 3 of the built-in font.
local clips = font:clips({ count = { frames = { 16, 17, 18, 19 } } })
local digit = font:sprite(16, { color = datumhue.color("#e69875") })
local anim = clips:bind(canvas:sprite(digit))

Fields 5

FieldTypeAccessDescription
clipstring?read-onlyThe currently playing clip name, or nil before the first play.
frameintegerread-onlyCurrent 1-based frame position within the active clip (position 1 = its first frame), or 0 before the first play.
playingbooleanread-onlyWhether the playhead is advancing.
speednumberread/writePlayback rate multiplier; negative plays in reverse, 0 holds.
loopingbooleanread/writeWhether the current clip loops (per-instance override).

Methods 8

Animator:play

method
Animator:play(name: string, opts?: scene.PlayOpts)

Hard-cut to clip name from its first frame, clearing the queue. Raises if the clip is unknown.

Example
anim:play("count", { speed = 2 })
print(anim.clip, anim.frame, anim.playing) --> count 1 true

opts scene.PlayOpts options 2 keys

KeyTypeDefaultDescription
speednumberthe animator keeps its current speedPlayback rate multiplier; negative plays the clip in reverse.
loopingbooleanthe clip's own loopingOverride the clip's loop policy for this play.

Animator:queue

method
Animator:queue(name: string, opts?: scene.PlayOpts)

Append clip name to play once the current non-looping clip (and any already queued) finishes. Raises if the clip is unknown, or if the chain already ends in a forever-looping clip.

Example
anim:play("count", { looping = false })
-- Then count back down, once the first play ends.
anim:queue("count", { speed = -1 })

opts scene.PlayOpts options 2 keys

KeyTypeDefaultDescription
speednumberthe animator keeps its current speedPlayback rate multiplier; negative plays the clip in reverse.
loopingbooleanthe clip's own loopingOverride the clip's loop policy for this play.

Animator:stop

method
Animator:stop()

Stop playback and clear the queue, leaving the current frame shown.

Animator:pause

method
Animator:pause()

Freeze the playhead; resume continues from here.

Animator:resume

method
Animator:resume()

Resume a paused animator without resetting the playhead.

Animator:seek

method
Animator:seek(frame: number)

Jump to a 1-based frame position within the current clip (clamped). Position 1 is the clip's first frame — a position in the clip's frames list, not an atlas-cell value.

Example
anim:play("count")
anim:pause()
-- Positions count from 1 along the clip's frames.
anim:seek(3)
print(anim.frame) --> 3

Animator:on_finish

method
Animator:on_finish(callback?: fun(animator: Animator, clip: string))

Set, replace, or clear (pass nil) the callback fired once when a non-looping clip reaches its terminal end. Receives the animator and the finished clip name.

Animator:on_marker

method
Animator:on_marker(callback?: fun(animator: Animator, marker: string))

Set, replace, or clear (pass nil) the callback fired each time the playhead crosses a named frame marker. Receives the animator and the marker name.

datumhue.com

(c) 2026 Shuusei AB. Quote excerpts of this manual, with attribution to DatumHue, in your own documentation, tutorials, course materials, reviews, and other writing or video. Republishing it in whole or in substantial part needs written permission: support@datumhue.com.

Victor Mono is licensed under the SIL Open Font License 1.1
Copyright (c) 2024, Rune Bjørnerås (https://github.com/rubjo)

This Font Software is licensed under the SIL Open Font License, Version 1.1.
This license is copied below, and is also available with a FAQ at:
http://scripts.sil.org/OFL


-----------------------------------------------------------
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
-----------------------------------------------------------

PREAMBLE
The goals of the Open Font License (OFL) are to stimulate worldwide
development of collaborative font projects, to support the font creation
efforts of academic and linguistic communities, and to provide a free and
open framework in which fonts may be shared and improved in partnership
with others.

The OFL allows the licensed fonts to be used, studied, modified and
redistributed freely as long as they are not sold by themselves. The
fonts, including any derivative works, can be bundled, embedded,
redistributed and/or sold with any software provided that any reserved
names are not used by derivative works. The fonts and derivatives,
however, cannot be released under any other type of license. The
requirement for fonts to remain under this license does not apply
to any document created using the fonts or their derivatives.

DEFINITIONS
"Font Software" refers to the set of files released by the Copyright
Holder(s) under this license and clearly marked as such. This may
include source files, build scripts and documentation.

"Reserved Font Name" refers to any names specified as such after the
copyright statement(s).

"Original Version" refers to the collection of Font Software components as
distributed by the Copyright Holder(s).

"Modified Version" refers to any derivative made by adding to, deleting,
or substituting -- in part or in whole -- any of the components of the
Original Version, by changing formats or by porting the Font Software to a
new environment.

"Author" refers to any designer, engineer, programmer, technical
writer or other person who contributed to the Font Software.

PERMISSION & CONDITIONS
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Font Software, to use, study, copy, merge, embed, modify,
redistribute, and sell modified and unmodified copies of the Font
Software, subject to the following conditions:

1) Neither the Font Software nor any of its individual components,
in Original or Modified Versions, may be sold by itself.

2) Original or Modified Versions of the Font Software may be bundled,
redistributed and/or sold with any software, provided that each copy
contains the above copyright notice and this license. These can be
included either as stand-alone text files, human-readable headers or
in the appropriate machine-readable metadata fields within text or
binary files as long as those fields can be easily viewed by the user.

3) No Modified Version of the Font Software may use the Reserved Font
Name(s) unless explicit written permission is granted by the corresponding
Copyright Holder. This restriction only applies to the primary font name as
presented to the users.

4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
Software shall not be used to promote, endorse or advertise any
Modified Version, except to acknowledge the contribution(s) of the
Copyright Holder(s) and the Author(s) or with their explicit written
permission.

5) The Font Software, modified or unmodified, in part or in whole,
must be distributed entirely under this license, and must not be
distributed under any other license. The requirement for fonts to
remain under this license does not apply to any document created
using the Font Software.

TERMINATION
This license becomes null and void if any of the above conditions are
not met.

DISCLAIMER
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
OTHER DEALINGS IN THE FONT SOFTWARE.

Try

    ↑↓ selectEnter openTab filter

    Settings

    Theme
    Text
    Print

    Keyboard shortcuts

    / or Ctrl KSearch
    ↑ ↓ EnterPick a result
    TabNext result filter
    j kNext or previous entry
    [ ]Previous or next page
    yCopy a link to the current entry
    ?These shortcuts
    EscClose

    On this page