@combos-fun/plugin-transition
Advanced tools
+8
-20
| # `@combos-fun/plugin-transition` — Agent notes | ||
| Data-driven tween / property animation. Tweens any numeric Component | ||
| property via dot-path (e.g. `positionX`, `rotationY`, `alpha`). No | ||
| rendering dependency — works with both 2D and 3D pipelines. | ||
| Data-driven tween / property animation. Tweens any numeric Component property via dot-path (e.g. `positionX`, `rotationY`, `alpha`). No rendering dependency — works with both 2D and 3D pipelines. | ||
| ## When to read | ||
| Read for any tween / motion / value animation: button bounce, fade-in / | ||
| out, easing curves on transforms, scripted dialog motion. | ||
| Read for any tween / motion / value animation: button bounce, fade-in / out, easing curves on transforms, scripted dialog motion. | ||
@@ -18,5 +15,3 @@ ## Public API | ||
| `componentName = 'Transition'`, | ||
| **`systemName = 'transition'` (lowercase)** — use the class reference with | ||
| `game.getSystem(TransitionSystem)`, not the string. | ||
| `componentName = 'Transition'`, **`systemName = 'transition'` (lowercase)** — use the class reference with `game.getSystem(TransitionSystem)`, not the string. | ||
@@ -37,26 +32,19 @@ ### Init params | ||
| `values` is a keyframe list. `time` is the timestamp on the timeline, | ||
| `value` is the target value, `tween` selects easing for the segment ending | ||
| at this keyframe. | ||
| `values` is a keyframe list. `time` is the timestamp on the timeline, `value` is the target value, `tween` selects easing for the segment ending at this keyframe. | ||
| ### Methods | ||
| `play(name?, iteration?)` — play a named animation; pass `name` undefined | ||
| to play all. `stop(name?)` — stop one or all. | ||
| `play(name?, iteration?)` — play a named animation; pass `name` undefined to play all. `stop(name?)` — stop one or all. | ||
| ### Events | ||
| `'finish'` is emitted with the animation name when iteration count is | ||
| reached. | ||
| `'finish'` is emitted with the animation name when iteration count is reached. | ||
| ### Easing names | ||
| `linear`, `ease-in`, `ease-out`, `ease-in-out`, `bounce-in`, | ||
| `bounce-out`, `bounce-in-out`, `none`. | ||
| `linear`, `ease-in`, `ease-out`, `ease-in-out`, `bounce-in`, `bounce-out`, `bounce-in-out`, `none`. | ||
| ## Required setup | ||
| `TransitionSystem` is a stub — the heavy lifting happens inside the | ||
| `Transition` component's `update()`. You still need to register it so the | ||
| engine routes lifecycle hooks correctly. | ||
| `TransitionSystem` is a stub — the heavy lifting happens inside the `Transition` component's `update()`. You still need to register it so the engine routes lifecycle hooks correctly. | ||
@@ -63,0 +51,0 @@ ```ts |
+2
-2
| { | ||
| "name": "@combos-fun/plugin-transition", | ||
| "version": "0.0.7", | ||
| "version": "0.0.8", | ||
| "description": "@combos-fun/plugin-transition", | ||
@@ -36,3 +36,3 @@ "main": "index.js", | ||
| "sprite-timeline": "^1.10.2", | ||
| "@combos-fun/engine": "0.0.7" | ||
| "@combos-fun/engine": "0.0.8" | ||
| }, | ||
@@ -39,0 +39,0 @@ "scripts": { |
+ Added
+ Added
- Removed
- Removed
Updated