Docs

SpriteAnimationComponent

SpriteAnimationComponent holds the frame sequence and playback state for a SpriteAnimation action. Configure it through SpriteAnimation::setAnimation or in the editor Properties window (Sprite Animation).

Properties

Name Languages
loop C++
frames / framesSize C++
framesTime / framesTimeSize C++
frameIndex C++
frameTimeIndex C++
spriteFrameCount C++

SpriteAnimationComponent does not store a separate name. Sprite animations are entities, so their display and lookup name comes from the inherited SpriteAnimation / entity name (EntityHandle::name). Rename the entity in the Structure panel (or call setName) when you need a searchable label — for example with Scene::findEntity.

frames is a list of sprite atlas frame indices; framesTime is the matching list of per-frame durations in milliseconds. loop restarts the sequence when it finishes. frameIndex, frameTimeIndex, and spriteFrameCount are runtime playback state (shown read-only in the editor).