Skip to content

Kiln API / kiln / spriteAnimator

Function: spriteAnimator() ​

ts
function spriteAnimator(sheet, options?): [Trait<() => SpriteAnimation>, SpriteAnimation];

The SpriteAnimator for a sheet: commands.spawn(Transform, spriteAnimator(HeroSheet, { graph: HeroAnim })).

Parameters ​

ParameterType
sheetSpriteSheet
optionsSpriteAnimatorOptions

Returns ​

[Trait<() => SpriteAnimation>, SpriteAnimation]