---
url: /api/kiln/functions/spriteAnimator.md
---
[Kiln API](../../index.md) / [kiln](../index.md) / spriteAnimator

# Function: spriteAnimator()

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

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

## Parameters

| Parameter | Type |
| ------ | ------ |
| `sheet` | [`SpriteSheet`](../interfaces/SpriteSheet.md) |
| `options` | [`SpriteAnimatorOptions`](../interfaces/SpriteAnimatorOptions.md) |

## Returns

\[`Trait`<() => [`SpriteAnimation`](../classes/SpriteAnimation.md)>, [`SpriteAnimation`](../classes/SpriteAnimation.md)]