pixijs-dust 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.0.1
+
+- `spawn()` and `sequence()` take chains written in place as functions, chains created with `Animator.build()`, or both mixed.
+- Removed `spawnInline()` and `sequenceInline()`: pass the functions to `spawn()` and `sequence()` instead.
+
 ## 1.0.0
 
 - Initial public version.

package/README.md

@@ -105,9 +105,8 @@ Dust is driven by exactly one ticker. Attaching the same ticker again does nothi
 | `callback(fn)` | Calls `fn(target)` |
 | `callbackWithDelay(delay, fn)` | Waits, then calls `fn(target)` |
 | `custom(fn, duration)` | Calls `fn(progress)` on every frame, with progress from 0 to 1 |
-| `sequence(animator)` | Plays another chain as one action |
-| `spawn(...animators)` | Plays several chains at the same time as one action |
-| `sequenceInline(fn)` / `spawnInline(...fns)` | Same, with the nested chains written in place |
+| `sequence(chain)` | Plays another chain as one action |
+| `spawn(...chains)` | Plays several chains at the same time as one action |
 | `kill()` | Destroys the target; must be the last call of the chain |
 
 A duration that is omitted is `0`, the action applies its final value at once.
@@ -175,38 +174,43 @@ for (const sprite of sprites) {
 
 ## Parallel chains
 
-`spawn()` plays several chains at the same time as one action. The action ends when its longest chain ends, and the parent chain goes on:
+`spawn()` plays several chains at the same time as one action. The action ends when its longest chain ends, and the parent chain goes on. Each chain is written in place, as a function that receives an empty chain to fill:
 
 ```ts
 Dust.animate(sprite)
     .spawn(
-        Animator.build().moveTo(300, 200, 0.5),
-        Animator.build().scaleTo(1.5, 0.3).scaleTo(1, 0.2),
-        Animator.build().fadeIn(0.5),
+        anim => anim.moveTo(300, 200, 0.5),
+        anim => anim.scaleTo(1.5, 0.3).scaleTo(1, 0.2),
+        anim => anim.fadeIn(0.5),
+    )
+    .sequence(
+        blink => blink.fadeTo(0.2, 0.1).fadeTo(1, 0.1).repeat(3),
     )
-    .delay(0.2)
     .kill();
 ```
 
-`spawnInline()` and `sequenceInline()` are the same with the nested chains written in place. Each function receives an empty chain to fill:
+`spawn()` and `sequence()` also take chains created with `Animator.build()`, and both kinds can be mixed. Build the chain beforehand when you need the chain itself: to reuse it with `clone()`, or to pause, speed up or end one of the parallel chains:
 
 ```ts
-Dust.animate(sprite)
-    .spawnInline(
-        anim => anim.moveTo(300, 200, 0.5),
-        anim => anim.scaleTo(1.5, 0.3).scaleTo(1, 0.2),
-    )
-    .sequenceInline(blink => blink.fadeTo(0.2, 0.1).fadeTo(1, 0.1).repeat(3));
-```
+const move = Animator.build().moveTo(300, 200, 0.5);
 
-Use the first form when you need the chain itself: to reuse it with `clone()`, or to pause, speed up or end one of the parallel chains.
+Dust.animate(sprite).spawn(
+    move,
+    anim => anim.fadeIn(0.5),
+);
+```
 
 A chain that repeats forever holds its `spawn()` or `sequence()` until you end it with `complete()`:
 
 ```ts
 const pulse = Animator.build().scaleTo(1.2, 0.3).scaleTo(1, 0.3).forever();
 
-Dust.animate(sprite).spawn(pulse, Animator.build().moveTo(300, 200, 2)).fadeOut(0.3);
+Dust.animate(sprite)
+    .spawn(
+        pulse,
+        anim => anim.moveTo(300, 200, 2),
+    )
+    .fadeOut(0.3);
 
 pulse.complete(); // the pulse ends after its current loop, then the sprite fades out
 ```

package/dist/index.cjs

@@ -112,7 +112,9 @@ var Animator = class _Animator {
     this._name = name;
   }
   /**
-   * Creates a chain without a target, to be played inside another chain with {@link Animator.sequence}.
+   * Creates a chain without a target, to be played inside another chain with {@link Animator.sequence}
+   * or {@link Animator.spawn}. Use it when the chain itself is needed: to reuse it with {@link Animator.clone},
+   * or to control it while it plays.
    *
    * @example
    * const blink = Animator.build().fadeTo(0.2, 0.1).fadeTo(1, 0.1).repeat(3);
@@ -122,10 +124,13 @@ var Animator = class _Animator {
   static build() {
     return new _Animator();
   }
-  // Creates a chain without a target and lets the function fill it
-  static buildWith(builder) {
+  // Returns the chain as is, or creates a chain without a target and lets the function fill it
+  static resolveNested(nested) {
+    if (nested instanceof _Animator) {
+      return nested;
+    }
     const chain = _Animator.build();
-    builder(chain);
+    nested(chain);
     return chain;
   }
   /**
@@ -438,59 +443,43 @@ var Animator = class _Animator {
   /**
    * Plays another chain as one action of this chain, with its own repeat count.
    *
-   * A chain can belong to one animation only: pass `animator.clone()` to use it in several places.
+   * The chain is either written in place, as a function that receives an empty chain and adds actions to it,
+   * or created beforehand with {@link Animator.build}. A chain can belong to one animation only:
+   * pass `animator.clone()` to use it in several places.
    *
-   * @param animator - A chain created with {@link Animator.build}.
-   * @throws When the chain is already used in a sequence.
-   */
-  sequence(animator) {
-    return this.push(new Sequence(animator));
-  }
-  /**
-   * Same as {@link Animator.sequence}, with the nested chain written in place.
-   * The function receives an empty chain and adds actions to it.
+   * @param chain - A function that fills the nested chain, or a chain created with {@link Animator.build}.
+   * @throws When the chain is already used as a nested chain.
    *
    * @example
-   * Dust.animate(sprite).sequenceInline(blink => blink.fadeTo(0.2, 0.1).fadeTo(1, 0.1).repeat(3));
+   * Dust.animate(sprite).sequence(
+   *     blink => blink.fadeTo(0.2, 0.1).fadeTo(1, 0.1).repeat(3),
+   * );
    */
-  sequenceInline(builder) {
-    return this.sequence(_Animator.buildWith(builder));
+  sequence(chain) {
+    return this.push(new Sequence(_Animator.resolveNested(chain)));
   }
   /**
    * Plays several chains at the same time as one action of this chain.
    * The action ends when its longest chain ends; a chain that repeats forever holds it until
    * that chain is ended with {@link Animator.complete}.
    *
-   * A chain can belong to one animation only: pass `animator.clone()` to use it in several places.
+   * Every chain is either written in place, as a function that receives an empty chain and adds actions to it,
+   * or created beforehand with {@link Animator.build}; both kinds can be mixed. A chain can belong to one
+   * animation only: pass `animator.clone()` to use it in several places.
    *
-   * @param animators - Chains created with {@link Animator.build}.
+   * @param chains - Functions that fill the nested chains, or chains created with {@link Animator.build}.
    * @throws When one of the chains is already used as a nested chain.
    *
    * @example
    * Dust.animate(sprite)
    *     .spawn(
-   *         Animator.build().moveTo(300, 200, 0.5),
-   *         Animator.build().scaleTo(1.5, 0.3).scaleTo(1, 0.2),
-   *     )
-   *     .fadeOut(0.3);
-   */
-  spawn(...animators) {
-    return this.push(new Spawn(animators));
-  }
-  /**
-   * Same as {@link Animator.spawn}, with the chains written in place.
-   * Every function receives an empty chain and adds actions to it.
-   *
-   * @example
-   * Dust.animate(sprite)
-   *     .spawnInline(
    *         anim => anim.moveTo(300, 200, 0.5),
    *         anim => anim.scaleTo(1.5, 0.3).scaleTo(1, 0.2),
    *     )
    *     .fadeOut(0.3);
    */
-  spawnInline(...builders) {
-    return this.spawn(...builders.map((builder) => _Animator.buildWith(builder)));
+  spawn(...chains) {
+    return this.push(new Spawn(chains.map((chain) => _Animator.resolveNested(chain))));
   }
   // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
   /**