@safe-engine/pixi 8.8.2 → 8.8.4

package/dist/dragonbones/dragonBones/animation/Animation.d.ts

@@ -0,0 +1,241 @@
+import { Armature } from "../armature/Armature";
+import { BaseObject } from "../core/BaseObject";
+import { AnimationFadeOutMode } from "../core/DragonBones";
+import { AnimationConfig } from "../model/AnimationConfig";
+import { AnimationData } from "../model/AnimationData";
+import { AnimationState, BlendState } from "./AnimationState";
+import { Map } from "../core/DragonBones";
+/**
+ * - The animation player is used to play the animation data and manage the animation states.
+ * @see dragonBones.AnimationData
+ * @see dragonBones.AnimationState
+ * @version DragonBones 3.0
+ * @language en_US
+ */
+export declare class Animation extends BaseObject {
+    static toString(): string;
+    /**
+     * - The play speed of all animations. [0: Stop, (0~1): Slow, 1: Normal, (1~N): Fast]
+     * @default 1.0
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    timeScale: number;
+    /**
+     * Update bones and slots cachedFrameIndices.
+     */
+    private _animationDirty;
+    private _inheritTimeScale;
+    private readonly _animationNames;
+    private readonly _animationStates;
+    private readonly _animations;
+    private readonly _blendStates;
+    private _armature;
+    private _animationConfig;
+    private _lastAnimationState;
+    protected _onClear(): void;
+    private _fadeOut;
+    /**
+     * @internal
+     */
+    init(armature: Armature): void;
+    /**
+     * @internal
+     */
+    advanceTime(passedTime: number): void;
+    /**
+     * - Clear all animations states.
+     * @see dragonBones.AnimationState
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    reset(): void;
+    /**
+     * - Pause a specific animation state.
+     * @param animationName - The name of animation state. (If not set, it will pause all animations)
+     * @see dragonBones.AnimationState
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    stop(animationName?: string | null): void;
+    /**
+     * - Play animation with a specific animation config.
+     * The API is still in the experimental phase and may encounter bugs or stability or compatibility issues when used.
+     * @param animationConfig - The animation config.
+     * @returns The playing animation state.
+     * @see dragonBones.AnimationConfig
+     * @beta
+     * @version DragonBones 5.0
+     * @language en_US
+     */
+    playConfig(animationConfig: AnimationConfig): AnimationState | null;
+    /**
+     * - Play a specific animation.
+     * @param animationName - The name of animation data. (If not set, The default animation will be played, or resume the animation playing from pause status, or replay the last playing animation)
+     * @param playTimes - Playing repeat times. [-1: Use default value of the animation data, 0: No end loop playing, [1~N]: Repeat N times] (default: -1)
+     * @returns The playing animation state.
+     * @example
+     * <pre>
+     *     armature.animation.play("walk");
+     * </pre>
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    play(animationName?: string | null, playTimes?: number): AnimationState | null;
+    /**
+     * - Fade in a specific animation.
+     * @param animationName - The name of animation data.
+     * @param fadeInTime - The fade in time. [-1: Use the default value of animation data, [0~N]: The fade in time (In seconds)] (Default: -1)
+     * @param playTimes - playing repeat times. [-1: Use the default value of animation data, 0: No end loop playing, [1~N]: Repeat N times] (Default: -1)
+     * @param layer - The blending layer, the animation states in high level layer will get the blending weights with high priority, when the total blending weights are more than 1.0, there will be no more weights can be allocated to the other animation states. (Default: 0)
+     * @param group - The blending group name, it is typically used to specify the substitution of multiple animation states blending. (Default: null)
+     * @param fadeOutMode - The fade out mode, which is typically used to specify alternate mode of multiple animation states blending. (Default: AnimationFadeOutMode.SameLayerAndGroup)
+     * @returns The playing animation state.
+     * @example
+     * <pre>
+     *     armature.animation.fadeIn("walk", 0.3, 0, 0, "normalGroup").resetToPose = false;
+     *     armature.animation.fadeIn("attack", 0.3, 1, 0, "attackGroup").resetToPose = false;
+     * </pre>
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    fadeIn(animationName: string, fadeInTime?: number, playTimes?: number, layer?: number, group?: string | null, fadeOutMode?: AnimationFadeOutMode): AnimationState | null;
+    /**
+     * - Play a specific animation from the specific time.
+     * @param animationName - The name of animation data.
+     * @param time - The start time point of playing. (In seconds)
+     * @param playTimes - Playing repeat times. [-1: Use the default value of animation data, 0: No end loop playing, [1~N]: Repeat N times] (Default: -1)
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndPlayByTime(animationName: string, time?: number, playTimes?: number): AnimationState | null;
+    /**
+     * - Play a specific animation from the specific frame.
+     * @param animationName - The name of animation data.
+     * @param frame - The start frame of playing.
+     * @param playTimes - Playing repeat times. [-1: Use the default value of animation data, 0: No end loop playing, [1~N]: Repeat N times] (Default: -1)
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndPlayByFrame(animationName: string, frame?: number, playTimes?: number): AnimationState | null;
+    /**
+     * - Play a specific animation from the specific progress.
+     * @param animationName - The name of animation data.
+     * @param progress - The start progress value of playing.
+     * @param playTimes - Playing repeat times. [-1: Use the default value of animation data, 0: No end loop playing, [1~N]: Repeat N times] (Default: -1)
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndPlayByProgress(animationName: string, progress?: number, playTimes?: number): AnimationState | null;
+    /**
+     * - Stop a specific animation at the specific time.
+     * @param animationName - The name of animation data.
+     * @param time - The stop time. (In seconds)
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndStopByTime(animationName: string, time?: number): AnimationState | null;
+    /**
+     * - Stop a specific animation at the specific frame.
+     * @param animationName - The name of animation data.
+     * @param frame - The stop frame.
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndStopByFrame(animationName: string, frame?: number): AnimationState | null;
+    /**
+     * - Stop a specific animation at the specific progress.
+     * @param animationName - The name of animation data.
+     * @param progress - The stop progress value.
+     * @returns The played animation state.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    gotoAndStopByProgress(animationName: string, progress?: number): AnimationState | null;
+    /**
+     * @internal
+     */
+    getBlendState(type: string, name: string, target: BaseObject): BlendState;
+    /**
+     * - Get a specific animation state.
+     * @param animationName - The name of animation state.
+     * @param layer - The layer of find animation states. [-1: Find all layers, [0~N]: Specified layer] (default: -1)
+     * @example
+     * <pre>
+     *     armature.animation.play("walk");
+     *     let walkState = armature.animation.getState("walk");
+     *     walkState.timeScale = 0.5;
+     * </pre>
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    getState(animationName: string, layer?: number): AnimationState | null;
+    /**
+     * - Check whether a specific animation data is included.
+     * @param animationName - The name of animation data.
+     * @see dragonBones.AnimationData
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    hasAnimation(animationName: string): boolean;
+    /**
+     * - Get all the animation states.
+     * @version DragonBones 5.1
+     * @language en_US
+     */
+    getStates(): ReadonlyArray<AnimationState>;
+    /**
+     * - Check whether there is an animation state is playing
+     * @see dragonBones.AnimationState
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    get isPlaying(): boolean;
+    /**
+     * - Check whether all the animation states' playing were finished.
+     * @see dragonBones.AnimationState
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    get isCompleted(): boolean;
+    /**
+     * - The name of the last playing animation state.
+     * @see #lastAnimationState
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    get lastAnimationName(): string;
+    /**
+     * - The name of all animation data
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    get animationNames(): ReadonlyArray<string>;
+    /**
+     * - All animation data.
+     * @version DragonBones 4.5
+     * @language en_US
+     */
+    get animations(): Map<AnimationData>;
+    set animations(value: Map<AnimationData>);
+    /**
+     * - An AnimationConfig instance that can be used quickly.
+     * @see dragonBones.AnimationConfig
+     * @version DragonBones 5.0
+     * @language en_US
+     */
+    get animationConfig(): AnimationConfig;
+    /**
+     * - The last playing animation state
+     * @see dragonBones.AnimationState
+     * @version DragonBones 3.0
+     * @language en_US
+     */
+    get lastAnimationState(): AnimationState | null;
+}
+//# sourceMappingURL=Animation.d.ts.map

package/dist/dragonbones/dragonBones/animation/Animation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Animation.d.ts","sourceRoot":"","sources":["../../../../src/dragonbones/dragonBones/animation/Animation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,GAAG,EAAE,MAAM,qBAAqB,CAAC;AAE1C;;;;;;GAMG;AACH,qBAAa,SAAU,SAAQ,UAAU;WACzB,QAAQ,IAAI,MAAM;IAGhC;;;;;OAKG;IACI,SAAS,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,OAAO,CAAC,eAAe,CAAU;IACjC,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqB;IACrD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAA6B;IAC9D,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0B;IACtD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA4B;IACzD,OAAO,CAAC,SAAS,CAAW;IAC5B,OAAO,CAAC,gBAAgB,CAAgC;IACxD,OAAO,CAAC,mBAAmB,CAAwB;IAEnD,SAAS,CAAC,QAAQ,IAAI,IAAI;IAkC1B,OAAO,CAAC,QAAQ;IAoEhB;;OAEG;IACI,IAAI,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAQrC;;OAEG;IACI,WAAW,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IA0G5C;;;;;OAKG;IACI,KAAK,IAAI,IAAI;IAUpB;;;;;;OAMG;IACI,IAAI,CAAC,aAAa,GAAE,MAAM,GAAG,IAAW,GAAG,IAAI;IAYtD;;;;;;;;;OASG;IACI,UAAU,CAAC,eAAe,EAAE,eAAe,GAAG,cAAc,GAAG,IAAI;IAgK1E;;;;;;;;;;;OAWG;IACI,IAAI,CACT,aAAa,GAAE,MAAM,GAAG,IAAW,EACnC,SAAS,GAAE,MAAW,GACrB,cAAc,GAAG,IAAI;IA4BxB;;;;;;;;;;;;;;;;OAgBG;IACI,MAAM,CACX,aAAa,EAAE,MAAM,EACrB,UAAU,GAAE,MAAa,EACzB,SAAS,GAAE,MAAW,EACtB,KAAK,GAAE,MAAU,EACjB,KAAK,GAAE,MAAM,GAAG,IAAW,EAC3B,WAAW,GAAE,oBAA6D,GACzE,cAAc,GAAG,IAAI;IAWxB;;;;;;;;OAQG;IACI,iBAAiB,CACtB,aAAa,EAAE,MAAM,EACrB,IAAI,GAAE,MAAY,EAClB,SAAS,GAAE,MAAW,GACrB,cAAc,GAAG,IAAI;IAUxB;;;;;;;;OAQG;IACI,kBAAkB,CACvB,aAAa,EAAE,MAAM,EACrB,KAAK,GAAE,MAAU,EACjB,SAAS,GAAE,MAAW,GACrB,cAAc,GAAG,IAAI;IAoBxB;;;;;;;;OAQG;IACI,qBAAqB,CAC1B,aAAa,EAAE,MAAM,EACrB,QAAQ,GAAE,MAAY,EACtB,SAAS,GAAE,MAAW,GACrB,cAAc,GAAG,IAAI;IAkBxB;;;;;;;OAOG;IACI,iBAAiB,CACtB,aAAa,EAAE,MAAM,EACrB,IAAI,GAAE,MAAY,GACjB,cAAc,GAAG,IAAI;IAQxB;;;;;;;OAOG;IACI,kBAAkB,CACvB,aAAa,EAAE,MAAM,EACrB,KAAK,GAAE,MAAU,GAChB,cAAc,GAAG,IAAI;IAQxB;;;;;;;OAOG;IACI,qBAAqB,CAC1B,aAAa,EAAE,MAAM,EACrB,QAAQ,GAAE,MAAY,GACrB,cAAc,GAAG,IAAI;IAYxB;;OAEG;IACI,aAAa,CAClB,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,UAAU,GACjB,UAAU;IAcb;;;;;;;;;;;;OAYG;IACI,QAAQ,CACb,aAAa,EAAE,MAAM,EACrB,KAAK,GAAE,MAAW,GACjB,cAAc,GAAG,IAAI;IAcxB;;;;;;OAMG;IACI,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO;IAGnD;;;;OAIG;IACI,SAAS,IAAI,aAAa,CAAC,cAAc,CAAC;IAGjD;;;;;OAKG;IACH,IAAW,SAAS,IAAI,OAAO,CAQ9B;IACD;;;;;OAKG;IACH,IAAW,WAAW,IAAI,OAAO,CAQhC;IACD;;;;;OAKG;IACH,IAAW,iBAAiB,IAAI,MAAM,CAIrC;IACD;;;;OAIG;IACH,IAAW,cAAc,IAAI,aAAa,CAAC,MAAM,CAAC,CAEjD;IACD;;;;OAIG;IACH,IAAW,UAAU,IAAI,GAAG,CAAC,aAAa,CAAC,CAE1C;IACD,IAAW,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,aAAa,CAAC,EAe9C;IACD;;;;;OAKG;IACH,IAAW,eAAe,IAAI,eAAe,CAG5C;IACD;;;;;OAKG;IACH,IAAW,kBAAkB,IAAI,cAAc,GAAG,IAAI,CAErD;CACF"}