animation

Clip playback on a node's animation component — starting, holding, seeking — and tweens, short clips generated from a table of steps and addressed by the handle they hand back.

14 functions, 0 constants. Scripts reach it as animation::.

Acts on animation: those functions are also methods on the component's handle, without the node argument.

Functions

Argument kinds are the script values a call passes: node is a node handle, any a table or value of any kind, fn a callback.

function	acts on	what it does
current(node) -> string?	animation	The clip playing or paused on this node, and nil once it has ended, been stopped, or never started.
define(node, string, any)	animation	Give this node a clip of its own under that name, from a definition table shaped like a scene file's.
is_playing(node) -> bool	animation	Whether a clip is advancing on this node; a paused, stopped, finished or absent one answers false.
is_tween_running(any) -> bool	—	Whether a handle still names a running tween; one that finished, was stopped, or lost its node answers false. Takes a tween handle, where is_playing takes a node and asks about its clip.
just_finished(node) -> string?	animation	The clip that ended on this node during the last step, and nil on every other frame.
pause(node)	animation	Hold the playhead where it is, keeping the clip current so resume has something to go back to.
play(node, string, any?)	animation	Start the clip of that name on this node; the trailing options table takes speed (a multiplier) and from_start.
queue(node, string)	animation	Play the clip of that name once the current one ends; a looping clip never ends, so a queue behind one never drains.
resume(node)	animation	Carry on from where pause left off; a stopped, finished or never-started node is left alone.
seek(node, float)	animation	Move the playhead to a number of seconds and pose the node there, even on a paused or ended clip.
stop(any)	animation	End the clip on a node, or the tween a handle names, leaving the pose where it is; resume cannot revive it.
time(node) -> float	animation	Seconds of playback since the current clip started, before wrapping; a stopped clip keeps where it stopped.
tween(node, any) -> int	—	Generate a clip on the node from a table of steps and run it, returning the handle stop and is_tween_running take.
tween_to(node, string, any, float, string?) -> int	—	Move one property of the node to a value over a number of seconds on an optional easing curve, returning a handle.