@drincs/pixi-vn 0.8.4 → 0.8.9

package/dist/classes/ticker/RotateTicker.cjs

@@ -1607,14 +1607,14 @@ var init_uid = __esm({
 });
 
 // node_modules/pixi.js/lib/utils/logging/deprecation.mjs
-function deprecation(version, message, ignoreDepth = 3) {
+function deprecation(version2, message, ignoreDepth = 3) {
   if (warnings[message]) {
     return;
   }
   let stack = new Error().stack;
   if (typeof stack === "undefined") {
     console.warn("PixiJS Deprecation Warning: ", `${message}
-Deprecated since v${version}`);
+Deprecated since v${version2}`);
   } else {
     stack = stack.split("\n").splice(ignoreDepth).join("\n");
     if (console.groupCollapsed) {
@@ -1623,13 +1623,13 @@ Deprecated since v${version}`);
         "color:#614108;background:#fffbe6",
         "font-weight:normal;color:#614108;background:#fffbe6",
         `${message}
-Deprecated since v${version}`
+Deprecated since v${version2}`
       );
       console.warn(stack);
       console.groupEnd();
     } else {
       console.warn("PixiJS Deprecation Warning: ", `${message}
-Deprecated since v${version}`);
+Deprecated since v${version2}`);
       console.warn(stack);
     }
   }
@@ -42998,7 +42998,7 @@ var require_dom = __commonJS({
        * @see https://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#ID-5CED94D7 DOM Level 1 Core
        * @see https://dom.spec.whatwg.org/#dom-domimplementation-hasfeature DOM Living Standard
        */
-      hasFeature: function(feature, version) {
+      hasFeature: function(feature, version2) {
         return true;
       },
       /**
@@ -43119,8 +43119,8 @@ var require_dom = __commonJS({
         }
       },
       // Introduced in DOM Level 2:
-      isSupported: function(feature, version) {
-        return this.ownerDocument.implementation.hasFeature(feature, version);
+      isSupported: function(feature, version2) {
+        return this.ownerDocument.implementation.hasFeature(feature, version2);
       },
       // Introduced in DOM Level 2:
       hasAttributes: function() {
@@ -57404,6 +57404,7 @@ var filters = {
   StreamFilter: filters_exports.StreamFilter,
   TelephoneFilter: filters_exports.TelephoneFilter
 };
+var CANVAS_APP_STAGE_ALIAS = "_stage_";
 
 // src/managers/CanvasManager.ts
 init_lib();
@@ -57714,7 +57715,7 @@ function createExportableElement(element) {
     let elementString = JSON.stringify(element);
     return JSON.parse(elementString);
   } catch (e2) {
-    console.error("[Pixi\u2019VN] Error creating exportable element", e2);
+    console.error("[Pixi\u2019VN] Error creating exportable element", element, e2);
     throw new Error("[Pixi\u2019VN] Error creating exportable element");
   }
 }
@@ -58147,6 +58148,10 @@ var CanvasManager = class {
    * ```
    */
   add(alias, canvasElement, options = {}) {
+    if (alias === CANVAS_APP_STAGE_ALIAS) {
+      console.error(`[Pixi\u2019VN] The alias ${CANVAS_APP_STAGE_ALIAS} is reserved`);
+      return;
+    }
     let ignoreOldStyle = options?.ignoreOldStyle;
     let oldCanvasElement = this.find(alias);
     if (oldCanvasElement) {
@@ -58177,6 +58182,10 @@ var CanvasManager = class {
    * ```
    */
   remove(alias, options = {}) {
+    if (alias === CANVAS_APP_STAGE_ALIAS) {
+      console.error(`[Pixi\u2019VN] The alias ${CANVAS_APP_STAGE_ALIAS} is reserved`);
+      return;
+    }
     let ignoreTickers = options.ignoreTickers;
     if (typeof alias === "string") {
       alias = [alias];
@@ -58205,6 +58214,9 @@ var CanvasManager = class {
    * ```
    */
   find(alias) {
+    if (alias === CANVAS_APP_STAGE_ALIAS) {
+      return this.app.stage;
+    }
     return CanvasManagerStatic._children[alias];
   }
   /**
@@ -58231,16 +58243,17 @@ var CanvasManager = class {
     this.removeAllTickers();
   }
   /**
-   * Edit the alias of a canvas element.
+   * Edit the alias of a canvas element. The tickers that are connected to the canvas element will be transferred.
    * @param oldAlias The old alias of the canvas element.
    * @param newAlias The new alias of the canvas element.
+   * @param options The options of the canvas element.
    */
-  editAlias(oldAlias, newAlias) {
+  editAlias(oldAlias, newAlias, options = {}) {
     if (CanvasManagerStatic._children[oldAlias]) {
       CanvasManagerStatic._children[newAlias] = CanvasManagerStatic._children[oldAlias];
       delete CanvasManagerStatic._children[oldAlias];
     }
-    this.transferTickers(oldAlias, newAlias, "move");
+    !options.ignoreTickers && this.transferTickers(oldAlias, newAlias, "move");
   }
   /** Edit Tickers Methods */
   /**
@@ -58315,12 +58328,16 @@ var CanvasManager = class {
   pushTicker(id3, tickerData, ticker) {
     CanvasManagerStatic._currentTickers[id3] = tickerData;
     tickerData.fn = (t2) => {
-      if (tickerData.createdByTicketSteps && this.isTickerPaused(tickerData.createdByTicketSteps.canvasElementAlias, tickerData.createdByTicketSteps.id)) {
-        return;
-      }
       let data = CanvasManagerStatic._currentTickers[id3];
       if (data) {
-        let canvasElementAliases = data.canvasElementAliases.filter((alias) => !this.isTickerPaused(alias, id3));
+        let canvasElementAliases = data.canvasElementAliases;
+        if (tickerData.createdByTicketSteps) {
+          if (this.isTickerPaused(tickerData.createdByTicketSteps.canvasElementAlias, tickerData.createdByTicketSteps.id)) {
+            return;
+          }
+        } else {
+          canvasElementAliases = canvasElementAliases.filter((alias) => !this.isTickerPaused(alias, id3));
+        }
         ticker?.fn(t2, data.args, canvasElementAliases, id3);
       }
     };
@@ -58667,15 +58684,19 @@ var CanvasManager = class {
     });
     CanvasManagerStatic._tickersMustBeCompletedBeforeNextStep.stepAlias.forEach(({ alias, id: id3 }) => {
       let ticker = CanvasManagerStatic._currentTickersSteps[alias];
-      if (ticker && ticker[id3] && !ticker[id3].steps.includes(Repeat)) {
-        ticker[id3].steps.forEach((step) => {
-          if (typeof step === "object" && "ticker" in step) {
-            let ticker2 = geTickerInstanceById(step.ticker, step.args, step.duration, step.priority);
-            if (ticker2) {
-              ticker2.onEndOfTicker([alias], id3, step.args);
+      if (ticker && ticker[id3]) {
+        if (ticker[id3].steps.includes(Repeat)) {
+          console.error(`[Pixi\u2019VN] The ticker alias: ${alias} id: ${id3} contains a RepeatType, so it can't be forced to complete`, ticker[id3]);
+        } else {
+          ticker[id3].steps.forEach((step) => {
+            if (typeof step === "object" && "ticker" in step) {
+              let ticker2 = geTickerInstanceById(step.ticker, step.args, step.duration, step.priority);
+              if (ticker2) {
+                ticker2.onEndOfTicker([alias], id3, step.args);
+              }
             }
-          }
-        });
+          });
+        }
       }
     });
     CanvasManagerStatic._tickersMustBeCompletedBeforeNextStep = { tikersIds: [], stepAlias: [] };
@@ -58716,6 +58737,7 @@ var CanvasManager = class {
       tickers: createExportableElement(CanvasManagerStatic.currentTickersWithoutCreatedBySteps),
       tickersSteps: createExportableElement(CanvasManagerStatic._currentTickersSteps),
       elements: createExportableElement(currentElements),
+      stage: createExportableElement(getMemoryContainer(this.app.stage)),
       elementAliasesOrder: createExportableElement(CanvasManagerStatic.childrenAliasesOrder),
       tickersOnPause: createExportableElement(CanvasManagerStatic._tickersOnPause)
     };
@@ -58749,6 +58771,11 @@ var CanvasManager = class {
         console.error("[Pixi\u2019VN] The data does not have the properties elementAliasesOrder and elements");
         return;
       }
+      if (data.hasOwnProperty("stage") && data.hasOwnProperty("stage")) {
+        setMemoryContainer(this.app.stage, data["stage"]);
+      } else {
+        console.error("[Pixi\u2019VN] The data does not have the properties stage");
+      }
       if (data.hasOwnProperty("tickers")) {
         let tickers = data["tickers"];
         Object.entries(tickers).forEach(([oldId, t2]) => {
@@ -59176,8 +59203,8 @@ function getExponentialProgression(number, progression, valueConvert) {
 // src/classes/ticker/MoveTicker.ts
 var MoveTicker = class extends TickerBase {
   fn(ticker, args, aliases, tickerId) {
-    let xSpeed = 1;
-    let ySpeed = 1;
+    let xSpeed = 10;
+    let ySpeed = 10;
     if (args.speed) {
       if (typeof args.speed === "number") {
         xSpeed = this.speedConvert(args.speed);
@@ -59241,6 +59268,10 @@ var MoveTicker = class extends TickerBase {
         let destination = args.destination;
         element.x = destination.x;
         element.y = destination.y;
+        if (args.isPushInOut && element.children.length > 0) {
+          let elementChild = element.children[0];
+          canvas.add(alias2, elementChild, { ignoreOldStyle: true });
+        }
       }
     });
     super.onEndOfTicker(alias, tickerId, args);
@@ -59628,6 +59659,7 @@ var NarrationManagerStatic = class _NarrationManagerStatic {
         canvas: {
           elementAliasesOrder: [],
           elements: {},
+          stage: {},
           tickers: {},
           tickersSteps: {},
           tickersOnPause: {}
@@ -60207,8 +60239,10 @@ var NarrationManager = class {
           console.warn("[Pixi\u2019VN] stepSha not found");
         }
         try {
+          if (NarrationManagerStatic.stepsRunning === 0) {
+            canvas.forceCompletionOfReportedTickers();
+          }
           NarrationManagerStatic.stepsRunning++;
-          canvas.forceCompletionOfReportedTickers();
           let result = await step(props);
           if (this.choiceMenuOptions?.length === 1 && this.choiceMenuOptions[0].autoSelect) {
             let choice = this.choiceMenuOptions[0];

package/dist/classes/ticker/RotateTicker.d.cts

@@ -1,9 +1,10 @@
 import { Ticker } from 'pixi.js';
 import { RotateTickerProps } from '../../types/ticker/RotateTickerProps.cjs';
-import { T as TickerBase } from '../../TickerBase-eU4Hvvy0.cjs';
+import TickerBase from './TickerBase.cjs';
 import '../../interface/TickerProgrationType.cjs';
-import '../../types/StorageElementType.cjs';
 import '../../types/TickerIdType.cjs';
+import '../../interface/TickerArgs.cjs';
+import '../../interface/Ticker.cjs';
 
 /**
  * A ticker that rotates the canvas element of the canvas. For centre rotation, set the anchor of the canvas element to 0.5.

package/dist/classes/ticker/RotateTicker.d.ts

@@ -1,9 +1,10 @@
 import { Ticker } from 'pixi.js';
 import { RotateTickerProps } from '../../types/ticker/RotateTickerProps.js';
-import { T as TickerBase } from '../../TickerBase-DbIg7gDS.js';
+import TickerBase from './TickerBase.js';
 import '../../interface/TickerProgrationType.js';
-import '../../types/StorageElementType.js';
 import '../../types/TickerIdType.js';
+import '../../interface/TickerArgs.js';
+import '../../interface/Ticker.js';
 
 /**
  * A ticker that rotates the canvas element of the canvas. For centre rotation, set the anchor of the canvas element to 0.5.

package/dist/classes/ticker/RotateTicker.js

@@ -1,11 +1,11 @@
 import {
   RotateTicker
-} from "../../chunk-3FJYYZOP.js";
+} from "../../chunk-D3ZQSJKZ.js";
 import "../../chunk-OMPJ74CO.js";
 import "../../chunk-2BUPSB7O.js";
 import "../../chunk-CZKJI26F.js";
 import "../../chunk-I6TNJEE3.js";
-import "../../chunk-66F5CGHV.js";
+import "../../chunk-DPUSONJ3.js";
 import "../../chunk-P44J5BE2.js";
 import "../../chunk-CAUF2LKZ.js";
 import "../../chunk-VXCA724Z.js";
@@ -13,12 +13,12 @@ import "../../chunk-3DOISWD6.js";
 import "../../chunk-I4UGLC3A.js";
 import "../../chunk-ZZLQ3ILH.js";
 import "../../chunk-JTQGULTR.js";
-import "../../chunk-6SZOXEOR.js";
+import "../../chunk-FHNQBWIZ.js";
 import "../../chunk-ZBUW3MBH.js";
-import "../../chunk-D3NHF5OS.js";
+import "../../chunk-PIYIZHZL.js";
 import "../../chunk-WX267JP2.js";
 import "../../chunk-LEMOIFSV.js";
-import "../../chunk-FYCYVQTG.js";
+import "../../chunk-A4NKPUL5.js";
 import "../../chunk-RATGPKD3.js";
 import "../../chunk-2PXN34ON.js";
 import "../../chunk-TAJJZPEH.js";

package/dist/classes/ticker/TickerBase.cjs

@@ -1607,14 +1607,14 @@ var init_uid = __esm({
 });
 
 // node_modules/pixi.js/lib/utils/logging/deprecation.mjs
-function deprecation(version, message, ignoreDepth = 3) {
+function deprecation(version2, message, ignoreDepth = 3) {
   if (warnings[message]) {
     return;
   }
   let stack = new Error().stack;
   if (typeof stack === "undefined") {
     console.warn("PixiJS Deprecation Warning: ", `${message}
-Deprecated since v${version}`);
+Deprecated since v${version2}`);
   } else {
     stack = stack.split("\n").splice(ignoreDepth).join("\n");
     if (console.groupCollapsed) {
@@ -1623,13 +1623,13 @@ Deprecated since v${version}`);
         "color:#614108;background:#fffbe6",
         "font-weight:normal;color:#614108;background:#fffbe6",
         `${message}
-Deprecated since v${version}`
+Deprecated since v${version2}`
       );
       console.warn(stack);
       console.groupEnd();
     } else {
       console.warn("PixiJS Deprecation Warning: ", `${message}
-Deprecated since v${version}`);
+Deprecated since v${version2}`);
       console.warn(stack);
     }
   }
@@ -42998,7 +42998,7 @@ var require_dom = __commonJS({
        * @see https://www.w3.org/TR/REC-DOM-Level-1/level-one-core.html#ID-5CED94D7 DOM Level 1 Core
        * @see https://dom.spec.whatwg.org/#dom-domimplementation-hasfeature DOM Living Standard
        */
-      hasFeature: function(feature, version) {
+      hasFeature: function(feature, version2) {
         return true;
       },
       /**
@@ -43119,8 +43119,8 @@ var require_dom = __commonJS({
         }
       },
       // Introduced in DOM Level 2:
-      isSupported: function(feature, version) {
-        return this.ownerDocument.implementation.hasFeature(feature, version);
+      isSupported: function(feature, version2) {
+        return this.ownerDocument.implementation.hasFeature(feature, version2);
       },
       // Introduced in DOM Level 2:
       hasAttributes: function() {
@@ -57406,6 +57406,7 @@ var filters = {
   StreamFilter: filters_exports.StreamFilter,
   TelephoneFilter: filters_exports.TelephoneFilter
 };
+var CANVAS_APP_STAGE_ALIAS = "_stage_";
 
 // src/functions/canvas/canvas-utility.ts
 function getTextureMemory(texture) {
@@ -58371,7 +58372,7 @@ function createExportableElement(element) {
     let elementString = JSON.stringify(element);
     return JSON.parse(elementString);
   } catch (e2) {
-    console.error("[Pixi\u2019VN] Error creating exportable element", e2);
+    console.error("[Pixi\u2019VN] Error creating exportable element", element, e2);
     throw new Error("[Pixi\u2019VN] Error creating exportable element");
   }
 }
@@ -58804,6 +58805,10 @@ var CanvasManager = class {
    * ```
    */
   add(alias, canvasElement, options = {}) {
+    if (alias === CANVAS_APP_STAGE_ALIAS) {
+      console.error(`[Pixi\u2019VN] The alias ${CANVAS_APP_STAGE_ALIAS} is reserved`);
+      return;
+    }
     let ignoreOldStyle = options?.ignoreOldStyle;
     let oldCanvasElement = this.find(alias);
     if (oldCanvasElement) {
@@ -58834,6 +58839,10 @@ var CanvasManager = class {
    * ```
    */
   remove(alias, options = {}) {
+    if (alias === CANVAS_APP_STAGE_ALIAS) {
+      console.error(`[Pixi\u2019VN] The alias ${CANVAS_APP_STAGE_ALIAS} is reserved`);
+      return;
+    }
     let ignoreTickers = options.ignoreTickers;
     if (typeof alias === "string") {
       alias = [alias];
@@ -58862,6 +58871,9 @@ var CanvasManager = class {
    * ```
    */
   find(alias) {
+    if (alias === CANVAS_APP_STAGE_ALIAS) {
+      return this.app.stage;
+    }
     return CanvasManagerStatic._children[alias];
   }
   /**
@@ -58888,16 +58900,17 @@ var CanvasManager = class {
     this.removeAllTickers();
   }
   /**
-   * Edit the alias of a canvas element.
+   * Edit the alias of a canvas element. The tickers that are connected to the canvas element will be transferred.
    * @param oldAlias The old alias of the canvas element.
    * @param newAlias The new alias of the canvas element.
+   * @param options The options of the canvas element.
    */
-  editAlias(oldAlias, newAlias) {
+  editAlias(oldAlias, newAlias, options = {}) {
     if (CanvasManagerStatic._children[oldAlias]) {
       CanvasManagerStatic._children[newAlias] = CanvasManagerStatic._children[oldAlias];
       delete CanvasManagerStatic._children[oldAlias];
     }
-    this.transferTickers(oldAlias, newAlias, "move");
+    !options.ignoreTickers && this.transferTickers(oldAlias, newAlias, "move");
   }
   /** Edit Tickers Methods */
   /**
@@ -58972,12 +58985,16 @@ var CanvasManager = class {
   pushTicker(id3, tickerData, ticker) {
     CanvasManagerStatic._currentTickers[id3] = tickerData;
     tickerData.fn = (t2) => {
-      if (tickerData.createdByTicketSteps && this.isTickerPaused(tickerData.createdByTicketSteps.canvasElementAlias, tickerData.createdByTicketSteps.id)) {
-        return;
-      }
       let data = CanvasManagerStatic._currentTickers[id3];
       if (data) {
-        let canvasElementAliases = data.canvasElementAliases.filter((alias) => !this.isTickerPaused(alias, id3));
+        let canvasElementAliases = data.canvasElementAliases;
+        if (tickerData.createdByTicketSteps) {
+          if (this.isTickerPaused(tickerData.createdByTicketSteps.canvasElementAlias, tickerData.createdByTicketSteps.id)) {
+            return;
+          }
+        } else {
+          canvasElementAliases = canvasElementAliases.filter((alias) => !this.isTickerPaused(alias, id3));
+        }
         ticker?.fn(t2, data.args, canvasElementAliases, id3);
       }
     };
@@ -59324,15 +59341,19 @@ var CanvasManager = class {
     });
     CanvasManagerStatic._tickersMustBeCompletedBeforeNextStep.stepAlias.forEach(({ alias, id: id3 }) => {
       let ticker = CanvasManagerStatic._currentTickersSteps[alias];
-      if (ticker && ticker[id3] && !ticker[id3].steps.includes(Repeat)) {
-        ticker[id3].steps.forEach((step) => {
-          if (typeof step === "object" && "ticker" in step) {
-            let ticker2 = geTickerInstanceById(step.ticker, step.args, step.duration, step.priority);
-            if (ticker2) {
-              ticker2.onEndOfTicker([alias], id3, step.args);
+      if (ticker && ticker[id3]) {
+        if (ticker[id3].steps.includes(Repeat)) {
+          console.error(`[Pixi\u2019VN] The ticker alias: ${alias} id: ${id3} contains a RepeatType, so it can't be forced to complete`, ticker[id3]);
+        } else {
+          ticker[id3].steps.forEach((step) => {
+            if (typeof step === "object" && "ticker" in step) {
+              let ticker2 = geTickerInstanceById(step.ticker, step.args, step.duration, step.priority);
+              if (ticker2) {
+                ticker2.onEndOfTicker([alias], id3, step.args);
+              }
             }
-          }
-        });
+          });
+        }
       }
     });
     CanvasManagerStatic._tickersMustBeCompletedBeforeNextStep = { tikersIds: [], stepAlias: [] };
@@ -59373,6 +59394,7 @@ var CanvasManager = class {
       tickers: createExportableElement(CanvasManagerStatic.currentTickersWithoutCreatedBySteps),
       tickersSteps: createExportableElement(CanvasManagerStatic._currentTickersSteps),
       elements: createExportableElement(currentElements),
+      stage: createExportableElement(getMemoryContainer(this.app.stage)),
       elementAliasesOrder: createExportableElement(CanvasManagerStatic.childrenAliasesOrder),
       tickersOnPause: createExportableElement(CanvasManagerStatic._tickersOnPause)
     };
@@ -59406,6 +59428,11 @@ var CanvasManager = class {
         console.error("[Pixi\u2019VN] The data does not have the properties elementAliasesOrder and elements");
         return;
       }
+      if (data.hasOwnProperty("stage") && data.hasOwnProperty("stage")) {
+        setMemoryContainer(this.app.stage, data["stage"]);
+      } else {
+        console.error("[Pixi\u2019VN] The data does not have the properties stage");
+      }
       if (data.hasOwnProperty("tickers")) {
         let tickers = data["tickers"];
         Object.entries(tickers).forEach(([oldId, t2]) => {
@@ -59567,8 +59594,8 @@ function getExponentialProgression(number, progression, valueConvert) {
 // src/classes/ticker/MoveTicker.ts
 var MoveTicker = class extends TickerBase {
   fn(ticker, args, aliases, tickerId) {
-    let xSpeed = 1;
-    let ySpeed = 1;
+    let xSpeed = 10;
+    let ySpeed = 10;
     if (args.speed) {
       if (typeof args.speed === "number") {
         xSpeed = this.speedConvert(args.speed);
@@ -59632,6 +59659,10 @@ var MoveTicker = class extends TickerBase {
         let destination = args.destination;
         element.x = destination.x;
         element.y = destination.y;
+        if (args.isPushInOut && element.children.length > 0) {
+          let elementChild = element.children[0];
+          canvas.add(alias2, elementChild, { ignoreOldStyle: true });
+        }
       }
     });
     super.onEndOfTicker(alias, tickerId, args);
@@ -60064,6 +60095,7 @@ var NarrationManagerStatic = class _NarrationManagerStatic {
         canvas: {
           elementAliasesOrder: [],
           elements: {},
+          stage: {},
           tickers: {},
           tickersSteps: {},
           tickersOnPause: {}
@@ -60643,8 +60675,10 @@ var NarrationManager = class {
           console.warn("[Pixi\u2019VN] stepSha not found");
         }
         try {
+          if (NarrationManagerStatic.stepsRunning === 0) {
+            canvas.forceCompletionOfReportedTickers();
+          }
           NarrationManagerStatic.stepsRunning++;
-          canvas.forceCompletionOfReportedTickers();
           let result = await step(props);
           if (this.choiceMenuOptions?.length === 1 && this.choiceMenuOptions[0].autoSelect) {
             let choice = this.choiceMenuOptions[0];

package/dist/classes/ticker/TickerBase.d.cts

@@ -1,4 +1,70 @@
-import 'pixi.js';
-export { a as TickerArgsType, T as default } from '../../TickerBase-eU4Hvvy0.cjs';
-import '../../types/StorageElementType.cjs';
-import '../../types/TickerIdType.cjs';
+import { UPDATE_PRIORITY, Ticker as Ticker$1 } from 'pixi.js';
+import { TickerIdType } from '../../types/TickerIdType.cjs';
+import TickerArgs from '../../interface/TickerArgs.cjs';
+import Ticker from '../../interface/Ticker.cjs';
+
+/**
+ * A class is used to create a ticker element to add into a Pixi Application.
+ * You can use {@link canvas.addTicker()} to add this element into the application.
+ * 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.
+ * @example
+ * ```typescript
+ * \@tickerDecorator() // this is equivalent to tickerDecorator("RotateTicker")
+ * export class RotateTicker extends TickerBase<{ speed?: number }> {
+ *     override fn(
+ *         t: TickerValue, // the ticker that is calling this method
+ *         args: { // the arguments that you passed when you added the ticker
+ *             speed?: number,
+ *         },
+ *         aliases: string[], // the aliases of the canvas elements that are connected to this ticker
+ *         tickerId: string, // the id of the ticker. You can use this to get the ticker from the canvas.currentTickers
+ *     ): void {
+ *         let speed = args.speed === undefined ? 0.1 : args.speed
+ *         aliases.forEach((alias) => {
+ *                 let element = canvas.find(alias)
+ *                 if (element && element instanceof Container) {
+ *                     if (clockwise)
+ *                         element.rotation += speed * t.deltaTime
+ *                     else
+ *                         element.rotation -= speed * t.deltaTime
+ *                 }
+ *             })
+ *     }
+ * }
+ * ```
+ */
+declare class TickerBase<TArgs extends TickerArgs | {}> implements Ticker<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
+     * @param priority The priority of the ticker. @default UPDATE_PRIORITY.NORMAL
+     */
+    constructor(args: TArgs, duration?: number, priority?: UPDATE_PRIORITY);
+    /**
+     * Get the id of the ticker. This variable is used in the system to get the ticker by id, {@link geTickerInstanceById}
+     */
+    id: TickerIdType;
+    args: TArgs;
+    duration?: number;
+    priority?: UPDATE_PRIORITY;
+    /**
+     * 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.
+     * @param _ticker The ticker that is calling this method
+     * @param _args The arguments that you passed when you added the ticker
+     * @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: Ticker$1, _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;
+}
+
+export { TickerBase as default };

package/dist/classes/ticker/TickerBase.d.ts

@@ -1,4 +1,70 @@
-import 'pixi.js';
-export { a as TickerArgsType, T as default } from '../../TickerBase-DbIg7gDS.js';
-import '../../types/StorageElementType.js';
-import '../../types/TickerIdType.js';
+import { UPDATE_PRIORITY, Ticker as Ticker$1 } from 'pixi.js';
+import { TickerIdType } from '../../types/TickerIdType.js';
+import TickerArgs from '../../interface/TickerArgs.js';
+import Ticker from '../../interface/Ticker.js';
+
+/**
+ * A class is used to create a ticker element to add into a Pixi Application.
+ * You can use {@link canvas.addTicker()} to add this element into the application.
+ * 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.
+ * @example
+ * ```typescript
+ * \@tickerDecorator() // this is equivalent to tickerDecorator("RotateTicker")
+ * export class RotateTicker extends TickerBase<{ speed?: number }> {
+ *     override fn(
+ *         t: TickerValue, // the ticker that is calling this method
+ *         args: { // the arguments that you passed when you added the ticker
+ *             speed?: number,
+ *         },
+ *         aliases: string[], // the aliases of the canvas elements that are connected to this ticker
+ *         tickerId: string, // the id of the ticker. You can use this to get the ticker from the canvas.currentTickers
+ *     ): void {
+ *         let speed = args.speed === undefined ? 0.1 : args.speed
+ *         aliases.forEach((alias) => {
+ *                 let element = canvas.find(alias)
+ *                 if (element && element instanceof Container) {
+ *                     if (clockwise)
+ *                         element.rotation += speed * t.deltaTime
+ *                     else
+ *                         element.rotation -= speed * t.deltaTime
+ *                 }
+ *             })
+ *     }
+ * }
+ * ```
+ */
+declare class TickerBase<TArgs extends TickerArgs | {}> implements Ticker<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
+     * @param priority The priority of the ticker. @default UPDATE_PRIORITY.NORMAL
+     */
+    constructor(args: TArgs, duration?: number, priority?: UPDATE_PRIORITY);
+    /**
+     * Get the id of the ticker. This variable is used in the system to get the ticker by id, {@link geTickerInstanceById}
+     */
+    id: TickerIdType;
+    args: TArgs;
+    duration?: number;
+    priority?: UPDATE_PRIORITY;
+    /**
+     * 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.
+     * @param _ticker The ticker that is calling this method
+     * @param _args The arguments that you passed when you added the ticker
+     * @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: Ticker$1, _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;
+}
+
+export { TickerBase as default };