SpriteAnimation¶

Inherits: Action
C++ type: SpriteAnimation

Description¶

Cycles through a sequence of texture atlas frames on its target Sprite, creating flip-book-style 2D animation. This is distinct from skeletal animation (Animation); SpriteAnimation only advances the active frame of a sprite sheet.

Properties¶

Methods¶

Property details¶

name¶

Inherited from: EntityHandle

• Setter: void setName(const std::string& name)
• Getter: std::string getName() const

The sprite animation entity's human-readable name. The editor shows this name in the Structure panel. There is no separate name stored in SpriteAnimationComponent — rename the entity (or call setName) when you need a label for lookup with Scene::findEntity.

Method details¶

setAnimation¶

• void setAnimation(std::vector\<int> frames, std::vector\<int> framesTime, bool loop)
• void setAnimation(int startFrame, int endFrame, int interval, bool loop)

Configure the frame sequence.

First overload — explicit frame list with per-frame durations in milliseconds:

SpriteAnimation anim(&scene);
anim.setTarget(&hero);
// Show frames 0, 1, 2, 1 with 100 ms each
anim.setAnimation({0, 1, 2, 1}, {100, 100, 100, 100}, true);
anim.start();

local anim = SpriteAnimation(scene)
anim:setTarget(hero)
anim:setAnimation({0, 1, 2, 1}, {100, 100, 100, 100}, true)
anim:start()

Second overload — range-based with a fixed interval (milliseconds per frame):

SpriteAnimation walk(&scene);
walk.setTarget(&hero);
walk.setAnimation(4, 7, 120, true);  // frames 4-7, 120 ms each
walk.start();

local walk = SpriteAnimation(scene)
walk:setTarget(hero)
walk:setAnimation(4, 7, 120, true)
walk:start()

See also¶

• SpriteAnimationComponent
• Sprite
• Action