Interface Animation

typings/spritejs.d.ts:144–203

* Web animation for sprite nodes.

   * Web animation for sprite nodes.
   */
  interface Animation {
    readonly effects: Record<string, any>;
    /**
     * The finished promise resolved when the animation's playstate is finished.
     */
    readonly finished: Promise<void>;
    /**
     * The current frame props of the animation.
     */
    readonly frame: Partial<Attrs>;
    /**
     * The playState of the animation.
     * Valid values are 'idel' or 'running' or 'pending' or 'paused' or 'finished'.
     */
    readonly playState: playState;
    /**
     * The progress of the animation.
     * The value is between [0, 1].
     */
    readonly progress: number;
    /**
     * The ready promise resolved when the animation's playstate is ready.
     */
    readonly ready: Promise<void>;
    /**
     * Timing properties of an animation.
     */
    readonly timing: Timing;
    /**
     * Custom timeline. https://github.com/spritejs/sprite-timeline
     */
    baseTimeline: Timeline;
    /**
     * Sets the rate at which the animation is being played back. 
     */
    playbackRate: number;
    /**
     * Apply animation effects to the animation.
     * @param effects The effect function maps.
     * @returns All effect function maps.
     */
    applyEffects(effects: Record<string, Function>): Record<string, Function>;
    /**
     * Cancel the animation.
     * @param preserveState Whether the frame state is preserved when the animation is canceled.
     */
    cancel(preserveState?: boolean): void;
    /**
     * Finish the animation.
     */
    finish(): void;
    /**
     * Pause the animation. Set the timeline's playbackRate to 0.
     */
    pause(): void;
    /**
     * Play the animation.
     */