@tawaship/pixi-animate-runtime 0.1.0 → 0.1.1

package/dist-skills/pixi-animate-runtime-guide/SKILL.md

@@ -5,7 +5,7 @@ description: Use this skill whenever the user asks to create, edit, or debug con
 
 # @tawaship/pixi-animate-runtime development skill
 
-Supported versions: **`^0.1.0`** (written against `0.1.0`).
+Supported versions: **`^0.1.0`** (written against `0.1.1`).
 
 First determine the installed version (`node_modules/@tawaship/pixi-animate-runtime/package.json`). If it is outside the supported range, **treat the type definitions in node_modules as authoritative** and follow them wherever they disagree with this skill.
 
@@ -102,7 +102,7 @@ loadContentAsync({ id: 'COMPOSITION_ID', basepath: 'assets/animates/generated/'
 
 - `addCreatejs(instance)` / `addCreatejsAt(instance, index)` put an instance on the container; a movie clip plays from its first frame. `removeCreatejs(instance)` takes it off and it stops
 - Content plays at its published frame rate whatever the display's refresh rate
-- `speed`: playback speed (`1` = published frame rate, `0` stops)
+- `speed`: playback speed (`1` = published frame rate, `0` stops; a value below `0` is taken as `0`, nothing plays backward)
 - `overSpeed` (default `true`): when the display runs slower than the content, one tick may play several frames. `false` plays at most one frame per tick
 - `smooth` (default `true`): frames follow a steady clock, so small variations of the frame time do not make the playing uneven (no frame on one tick, two on the next); it still keeps to the real time. Leave it on unless the user asks for the pixi-animate-container behavior (`false`)
 - To play on a container of another PixiJS framework, use `new AnimateController(container)`; it has the same `addCreatejs`, `handleTick`, `speed`, `overSpeed`, `smooth`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tawaship/pixi-animate-runtime",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Plays Adobe Animate HTML5 Canvas content on PixiJS from definitions extracted by @tawaship/animate-data-converter.",
   "main": "dist/pixi-animate-runtime.cjs.js",
   "module": "dist/pixi-animate-runtime.esm.js",

package/types/player/animate-container.d.ts

@@ -18,7 +18,7 @@ import { DisplayObject } from './display';
  * on only settles it on its first frame.
  */
 export declare class AnimateController {
-    /** Playback speed (1 is the content's own frame rate) */
+    /** Playback speed (1 is the content's own frame rate, 0 stops; a value below 0 is taken as 0) */
     speed: number;
     /** Whether one call may play more than one frame (when the display runs slower than the content) */
     overSpeed: boolean;
@@ -32,6 +32,8 @@ export declare class AnimateController {
     private _nextDelta;
     /** @param container The container the roots are put on */
     constructor(container: PIXI.Container);
+    /** Settles the roots marked by a goto since they were last resolved */
+    private _settleForDrawing;
     handleTick(delta: number): void;
     /** Records a delta and gives the median of the latest ones */
     private _usualDelta;
@@ -54,7 +56,7 @@ export declare class AnimateController {
  */
 export declare class AnimateContainer extends PIXI.Container {
     private readonly _controller;
-    /** Playback speed (1 is the content's own frame rate) */
+    /** Playback speed (1 is the content's own frame rate, 0 stops; a value below 0 is taken as 0) */
     get speed(): number;
     set speed(value: number);
     /** Whether one call may play more than one frame (when the display runs slower than the content) */

package/types/player/content.d.ts

@@ -167,4 +167,15 @@ export declare function tick(root: DisplayObject, event?: Event): void;
  * reverse order), without playing a frame.
  */
 export declare function resolveState(node: DisplayObject): void;
+/**
+ * Settles a display tree for drawing without playing it on, as a createjs
+ * stage draw shows it (MovieClip.draw settles each clip): the synched and
+ * single frame clips are placed at the frame their parent gives, and a clip
+ * waiting to start over (an independent clip reset when its parent placed it
+ * again) is shown at its first frame the way a new clip is (no frame script,
+ * its playhead left to start on the next frame, as in the template, where
+ * createjs draws only after a frame). Children after their parent, in reverse
+ * order as the resolve phase.
+ */
+export declare function settleForDrawing(node: DisplayObject): void;
 export {};

package/types/player/display.d.ts

@@ -69,6 +69,12 @@ export declare class DisplayObject extends EventDispatcher {
     _maskHost: Container | null;
     /** The objects this object masks (while they are on a display list) */
     _maskTargets: DisplayObject[];
+    /**
+     * Set on a root when a timeline under it jumped outside the playing (a goto):
+     * its clips are to be settled before Pixi draws it (settleForDrawing), as a
+     * createjs draw would. The resolve phase of a frame clears it
+     */
+    _pendingResolve: boolean;
     constructor(pixi: IOwnedNode);
     get _eventParent(): EventDispatcher | null;
     private get _transform();