excaliburjs / Excalibur / 16699382598

89%

push

github

feat: Support meta data for Animation (#3490)

Feature requested on the discord: https://discord.com/channels/1195771303215513671/1400805035503390721

# Changes

arbitrary meta data can now be added for an `Animation`

```ts
const rect = new ex.Rectangle({
  width: 100,
  height: 100,
  color: ex.Color.Blue
});
const anim = new ex.Animation({
  frames: [
    {
      graphic: rect,
      duration: 100
    }
  ],
  data: { someKey: 'someValue' }
});

console.log(anim.data.get('someKey')) // someValue

anim.data.set('otherKey', 'otherValue')
console.log(anim.data.get('otherKey')) // otherValue
```

`fromSpriteSheet(...)` now also accepts data as an optional argument.

```ts
const anim = ex.Animation.fromSpriteSheet(someSpriteSheet, [0, 1, 2, 3], 100, ex.AnimationStrategy.Freeze, {
  someKey: 'someValue'
});
```

as well as `fromSpriteSheetCoordinates({...})`

```ts
const anim = ex.Animation.fromSpriteSheetCoordinates({
  spriteSheet: someSpriteSheet,
  frameCoordinates: [{ x: 0, y: 0, duration: 100 }],
  data: {
    someKey: 'someValue'
  }
});
```

5162 of 7149 branches covered (72.21%)

2 of 2 new or added lines in 1 file covered. (100.0%)

13956 of 15864 relevant lines covered (87.97%)

24780.07 hits per line