pixi-effects 0.18.0 → 0.18.1

package/dist/index.d.cts

@@ -419,7 +419,7 @@ interface AnimateTextOptions {
     duration: number;
     /** How a piece arrives: a preset (`'rise'` default, `'drop'`, `'fade'`, `'pop'`, `'zoom'`, `'slide'`, `'spin'`), your own tween, or `false` for none. */
     in?: TextPreset | AnimateTextTween | false;
-    /** How a piece leaves, in the same wave (the entrance backwards, eased the other way). Default none. */
+    /** How a piece leaves, in the same wave (the entrance backwards, eased the other way). It leaves from the END of the layer (`at + duration`) and has no `at` of its own: to be gone at time T, set `duration` to T − `at`. Default none. */
     out?: TextPreset | AnimateTextTween | false;
     /** The wave: see {@link stagger}. Default `{ each: 0.04 }`. */
     stagger?: StaggerOptions;

package/dist/index.d.ts

@@ -419,7 +419,7 @@ interface AnimateTextOptions {
     duration: number;
     /** How a piece arrives: a preset (`'rise'` default, `'drop'`, `'fade'`, `'pop'`, `'zoom'`, `'slide'`, `'spin'`), your own tween, or `false` for none. */
     in?: TextPreset | AnimateTextTween | false;
-    /** How a piece leaves, in the same wave (the entrance backwards, eased the other way). Default none. */
+    /** How a piece leaves, in the same wave (the entrance backwards, eased the other way). It leaves from the END of the layer (`at + duration`) and has no `at` of its own: to be gone at time T, set `duration` to T − `at`. Default none. */
     out?: TextPreset | AnimateTextTween | false;
     /** The wave: see {@link stagger}. Default `{ each: 0.04 }`. */
     stagger?: StaggerOptions;

package/dist/index.js

@@ -3403,6 +3403,8 @@ function wiggle(opts) {
 }
 
 // src/presets/animateText.ts
+var TWEEN_KEYS = ["preset", "from", "to", "duration", "ease"];
+var TIME_KEYS = ["at", "delay", "start", "begin", "time"];
 var KEYS5 = ["by", "x", "y", "align", "name", "at", "duration", "in", "out", "stagger", "idle", "styleFor"];
 var PRESETS = {
   rise: { from: { y: 40, alpha: 0 }, duration: 0.5, ease: "back.out(2)" },
@@ -3486,6 +3488,14 @@ function animateText(text, style, options) {
 }
 function resolveTween(spec, which) {
   const t = typeof spec === "string" ? { preset: spec } : spec;
+  if (typeof spec === "object" && spec) {
+    for (const key of Object.keys(spec)) {
+      if (TWEEN_KEYS.includes(key)) continue;
+      if (TIME_KEYS.includes(key)) {
+        console.warn(`pixi-effects: animateText(): ${which}.${key} ("${key}") is ignored: ${which === "out" ? "an out leaves from the END of the layer (at + duration), so to make the text gone at a time T set duration to T \u2212 at" : "the entrance starts when the piece starts (the options' at, plus the stagger)"}`);
+      } else warnUnknownOptions(`animateText() ${which}`, { [key]: 1 }, TWEEN_KEYS);
+    }
+  }
   if (t.preset !== void 0 && !(t.preset in PRESETS)) {
     const guess = suggestName(String(t.preset), PRESET_NAMES);
     throw new Error(`animateText(): ${which} "${t.preset}" is not a preset${guess ? `; did you mean "${guess}"?` : ""} (presets: ${PRESET_NAMES.map((n) => `"${n}"`).join(", ")})`);