@drincs/pixi-vn 1.2.25 → 1.3.0

package/dist/canvas/tickers/index.d.ts

@@ -1,27 +1,9 @@
-import { UPDATE_PRIORITY, Ticker as Ticker$1 } from 'pixi.js';
-import { T as TickerArgs, d as TickerIdType } from '../../TickersSequence-_GvVF_1g.js';
-export { a as TickerHistory, b as TickerHistoryForExport, c as TickersSequence } from '../../TickersSequence-_GvVF_1g.js';
+import { Ticker, UPDATE_PRIORITY } from 'pixi.js';
+import { a as TickerArgs, T as Ticker$1, e as TickerIdType } from '../../TickersSequence-Cf1Vcu22.js';
+export { b as TickerHistory, c as TickerInfo, d as TickersSequence } from '../../TickersSequence-Cf1Vcu22.js';
+import { ObjectTarget, AnimationOptions, AnimationPlaybackControlsWithThen, ObjectSegment, At, SequenceOptions } from 'motion';
 
-interface Ticker<TArgs extends TickerArgs> {
-    /**
-     * Arguments to pass to the ticker
-     */
-    args: TArgs;
-    /**
-     * Duration in seconds to run the ticker
-     */
-    duration?: number;
-    /**
-     * Priority of the ticker
-     */
-    priority?: UPDATE_PRIORITY;
-    /**
-     * Get the id of the ticker. This variable is used in the system to get the ticker by id, {@link RegisteredTickers.getInstance}
-     */
-    id: TickerIdType;
-}
-
-type TickerValue = Ticker$1;
+type TickerValue = Ticker;
 
 /**
  * A class is used to create a ticker element to add into a Pixi Application.
@@ -29,6 +11,7 @@ type TickerValue = Ticker$1;
  * This class should be extended and the fn method should be overridden.
  * You must use the {@link tickerDecorator} to register the ticker in the game.
  * In Ren'Py is a transform.
+ * @template TArgs The type of the arguments that you want to pass to the ticker.
  * @example
  * ```typescript
  * \@tickerDecorator() // this is equivalent to tickerDecorator("RotateTicker")
@@ -55,7 +38,7 @@ type TickerValue = Ticker$1;
  * }
  * ```
  */
-declare class TickerBase<TArgs extends TickerArgs> implements Ticker<TArgs> {
+declare abstract class TickerBase<TArgs extends TickerArgs> implements Ticker$1<TArgs> {
     /**
      * @param args The arguments that you want to pass to the ticker.
      * @param duration The duration of the ticker in seconds. If is undefined, the step will end only when the animation is finished (if the animation doesn't have a goal to reach then it won't finish). @default undefined
@@ -69,6 +52,9 @@ declare class TickerBase<TArgs extends TickerArgs> implements Ticker<TArgs> {
     args: TArgs;
     duration?: number;
     priority?: UPDATE_PRIORITY;
+    protected ticker: Ticker;
+    protected tickerId?: string;
+    canvasElementAliases: string[];
     /**
      * The method that will be called every frame.
      * This method should be overridden and you can use {@link canvas.add()} to get the canvas element of the canvas, and edit them.
@@ -77,14 +63,16 @@ declare class TickerBase<TArgs extends TickerArgs> implements Ticker<TArgs> {
      * @param _alias The alias of the canvas elements that are connected to this ticker
      * @param _tickerId The id of the ticker. You can use this to get the ticker from the {@link canvas.currentTickers}
      */
-    fn(_ticker: TickerValue, _args: TArgs, _alias: string | string[], _tickerId: string): void;
-    /**
-     * This method is called when the ticker is added to the canvas.
-     * @param alias The alias of the canvas elements that are connected to this ticker
-     * @param tickerId The id of the ticker. You can use this to get the ticker from the {@link canvas.currentTickers}
-     * @param options The options that you passed when you added the ticker
-     */
-    onEndOfTicker(_alias: string | string[], tickerId: string, args: TArgs): void;
+    abstract fn(_ticker: TickerValue, _args: TArgs, _alias: string | string[], _tickerId: string): void;
+    protected fnValue?: () => void;
+    complete(_options?: {
+        ignoreTickerSteps?: boolean;
+    }): void;
+    stop(): void;
+    start(id: string): void;
+    pause(): void;
+    play(): void;
+    get paused(): boolean;
 }
 
 type TickerProgrationType = TickerProgrationLinear | TickerProgrationExponential;
@@ -112,6 +100,37 @@ interface TickerProgrationExponential {
     type: "exponential";
 }
 
+type CommonTickerProps = {
+    /**
+     * The alias to remove after the effect is done
+     * @default []
+     */
+    aliasToRemoveAfter?: string[] | string;
+    /**
+     * If true, the effect only starts if the canvas element have a texture
+     * @default false
+     */
+    startOnlyIfHaveTexture?: boolean;
+    /**
+     * The alias to resume after the effect is done
+     * @default []
+     */
+    tickerAliasToResume?: string[] | string;
+    /**
+     * The id of the ticker to resume after the effect is done
+     * @default []
+     */
+    tickerIdToResume?: string[] | string;
+    /**
+     * If set to `true`, the game will force the animation to complete before moving to the next step.
+     * @default false
+     */
+    forceCompleteBeforeNext?: boolean;
+};
+
+/**
+ * @deprecated
+ */
 type FadeAlphaTickerProps = {
     /**
      * @deprecated use speed instead
@@ -137,26 +156,12 @@ type FadeAlphaTickerProps = {
      * The progression of the speed
      */
     speedProgression?: TickerProgrationType;
-    /**
-     * The alias to remove after the fade is done
-     * @default []
-     */
-    aliasToRemoveAfter?: string[] | string;
-    /**
-     * If true, the effect only starts if the canvas element have a texture
-     * @default false
-     */
-    startOnlyIfHaveTexture?: boolean;
-    /**
-     * The alias to resume after the effect is done
-     * @default []
-     */
-    tickerAliasToResume?: string[] | string;
-};
+} & CommonTickerProps;
 
 /**
  * A ticker that fades the alpha of the canvas element of the canvas.
  * This ticker can be used on all canvas elements that extend the {@link PixiContainer} class.
+ * @deprecated Use {@link canvas.animate}
  * @example
  * ```typescript
  * let bunny = addImage("bunny1", "https://pixijs.com/assets/eggHead.png")
@@ -172,14 +177,18 @@ type FadeAlphaTickerProps = {
  */
 declare class FadeAlphaTicker extends TickerBase<FadeAlphaTickerProps> {
     constructor(args?: FadeAlphaTickerProps, duration?: number, priority?: UPDATE_PRIORITY);
-    fn(ticker: TickerValue, args: FadeAlphaTickerProps, aliases: string[], tickerId: string): void;
-    onEndOfTicker(alias: string | string[], tickerId: string, args: FadeAlphaTickerProps, options?: {
-        editAlpha?: boolean;
-    }): void;
+    fn(ticker: TickerValue, args: FadeAlphaTickerProps, aliases: string[], _tickerId: string): void;
+    onComplete(alias: string | string[], _tickerId: string, args: FadeAlphaTickerProps): void;
     private getLimit;
     private speedConvert;
+    complete(options?: {
+        ignoreTickerSteps?: boolean;
+    }): void;
 }
 
+/**
+ * @deprecated
+ */
 type MoveTickerProps = {
     /**
      * The speed of the movement (1 pixels per 0.1 second)
@@ -208,26 +217,12 @@ type MoveTickerProps = {
      * The progression of the speed
      */
     speedProgression?: TickerProgrationType;
-    /**
-     * The alias to remove after the fade is done
-     * @default []
-     */
-    aliasToRemoveAfter?: string[] | string;
-    /**
-     * If true, the effect only starts if the canvas element have a texture
-     * @default false
-     */
-    startOnlyIfHaveTexture?: boolean;
-    /**
-     * The alias to resume after the effect is done
-     * @default []
-     */
-    tickerAliasToResume?: string[] | string;
-};
+} & CommonTickerProps;
 
 /**
  * A ticker that moves the canvas element of the canvas.
  * This ticker can be used on all canvas elements that extend the {@link PixiContainer} class.
+ * @deprecated Use {@link canvas.animate}
  * @example
  * ```typescript
  * let alien = addImage("alien", 'https://pixijs.com/assets/eggHead.png')
@@ -239,16 +234,18 @@ type MoveTickerProps = {
  * ```
  */
 declare class MoveTicker extends TickerBase<MoveTickerProps> {
-    fn(ticker: TickerValue, args: MoveTickerProps, aliases: string[], tickerId: string): void;
-    onEndOfTicker(alias: string | string[], tickerId: string, args: MoveTickerProps, options?: {
-        editPosition: boolean;
-    }): void;
+    fn(ticker: TickerValue, args: MoveTickerProps, aliases: string[], _tickerId: string): void;
+    onComplete(alias: string | string[], _tickerId: string, args: MoveTickerProps): void;
     private speedConvert;
+    complete(options?: {
+        ignoreTickerSteps?: boolean;
+    }): void;
 }
 
 /**
  * A ticker that rotates the canvas element of the canvas. For centre rotation, set the anchor of the canvas element to 0.5.
  * This ticker can be used on all canvas elements that extend the {@link PixiContainer} class.
+ * @deprecated Use {@link canvas.animate}
  * @example
  * ```typescript
  * let alien = addImage("alien", 'https://pixijs.com/assets/eggHead.png')
@@ -263,16 +260,18 @@ declare class MoveTicker extends TickerBase<MoveTickerProps> {
  */
 declare class RotateTicker extends TickerBase<RotateTickerProps> {
     constructor(args?: RotateTickerProps, duration?: number, priority?: UPDATE_PRIORITY);
-    fn(ticker: TickerValue, args: RotateTickerProps, aliases: string[], tickerId: string): void;
-    onEndOfTicker(alias: string | string[], tickerId: string, args: RotateTickerProps, options?: {
-        editRotation?: boolean;
-    }): void;
+    fn(ticker: TickerValue, args: RotateTickerProps, aliases: string[], _tickerId: string): void;
+    onComplete(alias: string | string[], _tickerId: string, args: RotateTickerProps): void;
     private speedConvert;
+    complete(options?: {
+        ignoreTickerSteps?: boolean;
+    }): void;
 }
 
 /**
  * A ticker that zooms the canvas element of the canvas.
  * This ticker can be used on all canvas elements that extend the {@link PixiContainer} class.
+ * @deprecated Use {@link canvas.animate}
  * @example
  * ```typescript
  * let alien = addImage("alien", 'https://pixijs.com/assets/eggHead.png')
@@ -286,12 +285,13 @@ declare class RotateTicker extends TickerBase<RotateTickerProps> {
  */
 declare class ZoomTicker extends TickerBase<ZoomTickerProps> {
     constructor(args?: ZoomTickerProps, duration?: number, priority?: UPDATE_PRIORITY);
-    fn(ticker: TickerValue, args: ZoomTickerProps, alias: string[], tickerId: string): void;
+    fn(ticker: TickerValue, args: ZoomTickerProps, alias: string[], _tickerId: string): void;
     private speedConvert;
-    onEndOfTicker(alias: string | string[], tickerId: string, args: ZoomTickerProps, options?: {
-        editScale?: boolean;
-    }): void;
+    onComplete(alias: string | string[], _tickerId: string, args: ZoomTickerProps): void;
     private getLimit;
+    complete(options?: {
+        ignoreTickerSteps?: boolean;
+    }): void;
 }
 
 /**
@@ -301,20 +301,24 @@ declare class ZoomTicker extends TickerBase<ZoomTickerProps> {
  * @param name is th identifier of the label, by default is the name of the class
  * @returns
  */
-declare function tickerDecorator(name?: TickerIdType): (target: typeof TickerBase<any>) => void;
+declare function tickerDecorator(name?: TickerIdType): (target: {
+    new (args: any, duration?: number, priority?: UPDATE_PRIORITY): Ticker$1<any>;
+}) => void;
 declare namespace RegisteredTickers {
     /**
      * Register a ticker in the game.
      * @param target The class of the ticker.
      * @param name Name of the ticker, by default it will use the class name. If the name is already registered, it will show a warning
      */
-    function add(target: typeof TickerBase<any>, name?: TickerIdType): void;
+    function add(target: {
+        new (args: any, duration?: number, priority?: UPDATE_PRIORITY): Ticker$1<any>;
+    }, name?: TickerIdType): void;
     /**
      * Get a ticker by the id.
      * @param canvasId The id of the ticker.
      * @returns The ticker type.
      */
-    function get<T = typeof TickerBase<any>>(tickerId: TickerIdType): T | undefined;
+    function get<T = Ticker$1<any>>(tickerId: TickerIdType): T | undefined;
     /**
      * Get a ticker instance by the id.
      * @param tickerId The id of the ticker.
@@ -323,12 +327,14 @@ declare namespace RegisteredTickers {
      * @param priority The priority of the ticker. If is undefined, the priority will be UPDATE_PRIORITY.NORMAL.
      * @returns The instance of the ticker
      */
-    function getInstance<TArgs extends TickerArgs>(tickerId: TickerIdType, args: TArgs, duration?: number, priority?: UPDATE_PRIORITY): TickerBase<TArgs> | undefined;
+    function getInstance<TArgs extends TickerArgs>(tickerId: TickerIdType, args: TArgs, duration?: number, priority?: UPDATE_PRIORITY): Ticker$1<TArgs> | undefined;
     /**
      * Get a list of all tickers registered.
      * @returns An array of tickers.
      */
-    function values(): (typeof TickerBase<any>)[];
+    function values(): {
+        new (args: any, duration?: number, priority?: UPDATE_PRIORITY): Ticker$1<any>;
+    }[];
     /**
      * Check if a ticker is registered.
      * @param id The id of the ticker.
@@ -337,12 +343,56 @@ declare namespace RegisteredTickers {
     function has(id: string): boolean;
 }
 
+type ObjectSegmentWithTransition<O extends {} = {}> = [
+    O,
+    ObjectTarget<O>,
+    AnimationOptions & At & {
+        ticker?: Ticker;
+    }
+];
+/**
+ * Animate a PixiJS component or components using [motion's animate](https://motion.dev/docs/animate) function.
+ * This function integrates with the PixiJS ticker to ensure smooth animations.
+ *
+ * Pixi’VN will **not** keep track of the animation state of this function (This feature is intended for animating PixiJS components used for UI.).
+ * If you want Pixi'VN to save the animation state in saves, use the {@link canvas.animate} function instead.
+ * @param components - The PixiJS component(s) to animate.
+ * @param keyframes - The keyframes to animate the component(s) with.
+ * @param options - Additional options for the animation, including duration, easing, and ticker.
+ * @returns An animation playback control object that can be used to start, stop, or control the animation.
+ * @template T - The type of PixiJS component(s) being animated.
+ */
+declare function animate<T extends {}>(components: T | T[], keyframes: ObjectTarget<T>, options?: AnimationOptions & {
+    ticker?: Ticker;
+}): AnimationPlaybackControlsWithThen;
+/**
+ * Animate a sequence of PixiJS components with transitions using [motion's animate](https://motion.dev/docs/animate) function.
+ * This function allows for complex animations involving multiple components and transitions.
+ * It integrates with the PixiJS ticker to ensure smooth animations.
+ * This function is intended for animating PixiJS components used for UI.
+ *
+ * Pixi’VN will **not** keep track of the animation state of this function (This feature is intended for animating PixiJS components used for UI.).
+ * If you want Pixi'VN to save the animation state in saves, use the {@link canvas.animate} function instead
+ *
+ * @param sequence An array of segments to animate, where each segment is an array containing:
+ * - The PixiJS component to animate.
+ * - The keyframes to animate the component with.
+ * - An options object that can include animation options and a ticker.
+ * @param options Additional options for the sequence, such as duration and repeat count.
+ * @returns An animation playback control object that can be used to start, stop, or control the animation.
+ * @template T - The type of PixiJS component(s) being animated.
+ */
+declare function animate<T extends {}>(sequence: (ObjectSegment<T> | ObjectSegmentWithTransition<T>)[], options?: SequenceOptions): AnimationPlaybackControlsWithThen;
+
 interface TickerTimeoutHistory {
     aliases: string[];
     ticker: string;
     canBeDeletedBeforeEnd: boolean;
 }
 
+/**
+ * @deprecated
+ */
 type RotateTickerProps = {
     /**
      * The speed of the rotation (360 degree per 10 second)
@@ -363,23 +413,11 @@ type RotateTickerProps = {
      * The progression of the speed
      */
     speedProgression?: TickerProgrationType;
-    /**
-     * The alias to remove after the fade is done
-     * @default []
-     */
-    aliasToRemoveAfter?: string[] | string;
-    /**
-     * If true, the effect only starts if the canvas element have a texture
-     * @default false
-     */
-    startOnlyIfHaveTexture?: boolean;
-    /**
-     * The alias to resume after the effect is done
-     * @default []
-     */
-    tickerAliasToResume?: string[] | string;
-};
+} & CommonTickerProps;
 
+/**
+ * @deprecated
+ */
 type ZoomTickerProps = {
     /**
      * The speed of the zoom effect (100% zoom per 10 second)
@@ -410,21 +448,6 @@ type ZoomTickerProps = {
      * @default undefined
      */
     speedProgression?: TickerProgrationType;
-    /**
-     * The alias to remove after the effect is done
-     * @default []
-     */
-    aliasToRemoveAfter?: string[] | string;
-    /**
-     * If true, the effect only starts if the canvas element have a texture
-     * @default false
-     */
-    startOnlyIfHaveTexture?: boolean;
-    /**
-     * The alias to resume after the effect is done
-     * @default []
-     */
-    tickerAliasToResume?: string[] | string;
     /**
      * Is a special prop used in the zoom in/out transition.
      * @default false
@@ -439,6 +462,6 @@ type ZoomTickerProps = {
             y: number;
         };
     };
-};
+} & CommonTickerProps;
 
-export { FadeAlphaTicker, type FadeAlphaTickerProps, MoveTicker, type MoveTickerProps, RegisteredTickers, RotateTicker, type RotateTickerProps, type Ticker, TickerArgs, TickerBase, type TickerProgrationExponential, type TickerProgrationLinear, type TickerProgrationType, type TickerTimeoutHistory, type TickerValue, ZoomTicker, type ZoomTickerProps, tickerDecorator };
+export { type CommonTickerProps, FadeAlphaTicker, type FadeAlphaTickerProps, MoveTicker, type MoveTickerProps, RegisteredTickers, RotateTicker, type RotateTickerProps, Ticker$1 as Ticker, TickerArgs, TickerBase, type TickerProgrationExponential, type TickerProgrationLinear, type TickerProgrationType, type TickerTimeoutHistory, type TickerValue, ZoomTicker, type ZoomTickerProps, animate, tickerDecorator };