@drincs/pixi-vn 1.2.25 → 1.3.0

package/dist/{ContainerMemory-Bemxh6ml.d.cts → ContainerMemory-CrY9QSo2.d.cts}

@@ -1,17 +1,6 @@
-import { b as TickerHistoryForExport, c as TickersSequence } from './TickersSequence-_GvVF_1g.cjs';
+import { b as TickerHistory, d as TickersSequence } from './TickersSequence-Cf1Vcu22.cjs';
 import { Container, ContainerOptions } from 'pixi.js';
 
-type PauseTickerType = {
-    /**
-     * Ticker ids excluded
-     */
-    tickerIdsExcluded?: string[];
-    /**
-     * Ticker ids included
-     */
-    tickerIdsIncluded?: string[];
-};
-
 /**
  * This class is used to create a canvas element to add into a Pixi Application.
  * You can use {@link canvas.add()} to add this element into the application.
@@ -60,12 +49,23 @@ interface CanvasBaseItemMemory {
     pixivnId: string;
 }
 
+type PauseTickerType = {
+    /**
+     * Ticker ids excluded
+     */
+    tickerIdsExcluded?: string[];
+    /**
+     * Ticker ids included
+     */
+    tickerIdsIncluded?: string[];
+};
+
 /**
  * Interface exported canvas
  */
 interface CanvasGameState {
     tickers: {
-        [id: string]: TickerHistoryForExport<any>;
+        [id: string]: TickerHistory<any>;
     };
     tickersSteps: {
         [alias: string]: {
@@ -77,6 +77,9 @@ interface CanvasGameState {
     };
     stage: Partial<ContainerMemory>;
     elementAliasesOrder: string[];
+    /**
+     * @deprecated
+     */
     tickersOnPause: {
         [alias: string]: PauseTickerType;
     };

package/dist/{ContainerMemory-BSDt46hh.d.ts → ContainerMemory-DrijxCcD.d.ts}

@@ -1,17 +1,6 @@
-import { b as TickerHistoryForExport, c as TickersSequence } from './TickersSequence-_GvVF_1g.js';
+import { b as TickerHistory, d as TickersSequence } from './TickersSequence-Cf1Vcu22.js';
 import { Container, ContainerOptions } from 'pixi.js';
 
-type PauseTickerType = {
-    /**
-     * Ticker ids excluded
-     */
-    tickerIdsExcluded?: string[];
-    /**
-     * Ticker ids included
-     */
-    tickerIdsIncluded?: string[];
-};
-
 /**
  * This class is used to create a canvas element to add into a Pixi Application.
  * You can use {@link canvas.add()} to add this element into the application.
@@ -60,12 +49,23 @@ interface CanvasBaseItemMemory {
     pixivnId: string;
 }
 
+type PauseTickerType = {
+    /**
+     * Ticker ids excluded
+     */
+    tickerIdsExcluded?: string[];
+    /**
+     * Ticker ids included
+     */
+    tickerIdsIncluded?: string[];
+};
+
 /**
  * Interface exported canvas
  */
 interface CanvasGameState {
     tickers: {
-        [id: string]: TickerHistoryForExport<any>;
+        [id: string]: TickerHistory<any>;
     };
     tickersSteps: {
         [alias: string]: {
@@ -77,6 +77,9 @@ interface CanvasGameState {
     };
     stage: Partial<ContainerMemory>;
     elementAliasesOrder: string[];
+    /**
+     * @deprecated
+     */
     tickersOnPause: {
         [alias: string]: PauseTickerType;
     };

package/dist/{TickersSequence-_GvVF_1g.d.cts → TickersSequence-Cf1Vcu22.d.cts}

@@ -1,4 +1,4 @@
-import { TickerCallback, UPDATE_PRIORITY } from 'pixi.js';
+import { UPDATE_PRIORITY } from 'pixi.js';
 
 /**
  * is a string that represents a ticker id.
@@ -9,19 +9,61 @@ type TickerIdType = string;
 interface TickerArgs {
 }
 
-/**
- * TickerHistory is a class that contains the name of a class and the arguments that were used to create it.
- */
-interface TickerHistory<TArgs extends TickerArgs> {
-    fn: TickerCallback<any>;
-    id: TickerIdType;
+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;
     /**
      * The aliases of the canvas elements that are connected to this ticker
      */
     canvasElementAliases: string[];
-    priority?: UPDATE_PRIORITY;
-    duration?: number;
+    /**
+     * Completes the animation and applies the final state.
+     */
+    complete: (options?: {
+        ignoreTickerSteps?: boolean;
+    }) => Promise<void> | void;
+    /**
+     * Stops the animation at its current state, and prevents it from resuming when the animation is played again.
+     */
+    stop: () => void;
+    /**
+     * Starts the ticker. This will start the ticker and begin the animation.
+     * @param id The id of the ticker.
+     */
+    start: (id: string) => void;
+    /**
+     * Pauses the animation.
+     */
+    pause: () => void;
+    /**
+     * Plays the animation.
+     */
+    play: () => void;
+    /**
+     * Checks if the ticker is paused.
+     * @returns true if the ticker is paused, false otherwise.
+     */
+    readonly paused: boolean;
+}
+
+/**
+ * TickerHistory is a class that contains the name of a class and the arguments that were used to create it.
+ */
+interface TickerInfo<TArgs extends TickerArgs> {
     /**
      * If this ticker was created by steps
      */
@@ -29,9 +71,9 @@ interface TickerHistory<TArgs extends TickerArgs> {
         canvasElementAlias: string;
         id: string;
     };
-    onEndOfTicker: () => void;
+    ticker: Ticker<TArgs>;
 }
-interface TickerHistoryForExport<TArgs extends TickerArgs> {
+interface TickerHistory<TArgs extends TickerArgs> {
     id: TickerIdType;
     args: TArgs;
     /**
@@ -40,6 +82,7 @@ interface TickerHistoryForExport<TArgs extends TickerArgs> {
     canvasElementAliases: string[];
     priority?: UPDATE_PRIORITY;
     duration?: number;
+    paused?: boolean;
 }
 
 type PauseType = {
@@ -87,4 +130,4 @@ interface TickersSequence {
     steps: (TickersStep<any> | RepeatType | PauseType)[];
 }
 
-export type { PauseType as P, RepeatType as R, TickerArgs as T, TickerHistory as a, TickerHistoryForExport as b, TickersSequence as c, TickerIdType as d };
+export type { PauseType as P, RepeatType as R, Ticker as T, TickerArgs as a, TickerHistory as b, TickerInfo as c, TickersSequence as d, TickerIdType as e };

package/dist/{TickersSequence-_GvVF_1g.d.ts → TickersSequence-Cf1Vcu22.d.ts}

@@ -1,4 +1,4 @@
-import { TickerCallback, UPDATE_PRIORITY } from 'pixi.js';
+import { UPDATE_PRIORITY } from 'pixi.js';
 
 /**
  * is a string that represents a ticker id.
@@ -9,19 +9,61 @@ type TickerIdType = string;
 interface TickerArgs {
 }
 
-/**
- * TickerHistory is a class that contains the name of a class and the arguments that were used to create it.
- */
-interface TickerHistory<TArgs extends TickerArgs> {
-    fn: TickerCallback<any>;
-    id: TickerIdType;
+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;
     /**
      * The aliases of the canvas elements that are connected to this ticker
      */
     canvasElementAliases: string[];
-    priority?: UPDATE_PRIORITY;
-    duration?: number;
+    /**
+     * Completes the animation and applies the final state.
+     */
+    complete: (options?: {
+        ignoreTickerSteps?: boolean;
+    }) => Promise<void> | void;
+    /**
+     * Stops the animation at its current state, and prevents it from resuming when the animation is played again.
+     */
+    stop: () => void;
+    /**
+     * Starts the ticker. This will start the ticker and begin the animation.
+     * @param id The id of the ticker.
+     */
+    start: (id: string) => void;
+    /**
+     * Pauses the animation.
+     */
+    pause: () => void;
+    /**
+     * Plays the animation.
+     */
+    play: () => void;
+    /**
+     * Checks if the ticker is paused.
+     * @returns true if the ticker is paused, false otherwise.
+     */
+    readonly paused: boolean;
+}
+
+/**
+ * TickerHistory is a class that contains the name of a class and the arguments that were used to create it.
+ */
+interface TickerInfo<TArgs extends TickerArgs> {
     /**
      * If this ticker was created by steps
      */
@@ -29,9 +71,9 @@ interface TickerHistory<TArgs extends TickerArgs> {
         canvasElementAlias: string;
         id: string;
     };
-    onEndOfTicker: () => void;
+    ticker: Ticker<TArgs>;
 }
-interface TickerHistoryForExport<TArgs extends TickerArgs> {
+interface TickerHistory<TArgs extends TickerArgs> {
     id: TickerIdType;
     args: TArgs;
     /**
@@ -40,6 +82,7 @@ interface TickerHistoryForExport<TArgs extends TickerArgs> {
     canvasElementAliases: string[];
     priority?: UPDATE_PRIORITY;
     duration?: number;
+    paused?: boolean;
 }
 
 type PauseType = {
@@ -87,4 +130,4 @@ interface TickersSequence {
     steps: (TickersStep<any> | RepeatType | PauseType)[];
 }
 
-export type { PauseType as P, RepeatType as R, TickerArgs as T, TickerHistory as a, TickerHistoryForExport as b, TickersSequence as c, TickerIdType as d };
+export type { PauseType as P, RepeatType as R, Ticker as T, TickerArgs as a, TickerHistory as b, TickerInfo as c, TickersSequence as d, TickerIdType as e };