@drincs/pixi-vn 0.5.11 → 0.6.1

package/dist/{TickerBase-CjfyD6j5.d.ts → TickerBase-BAUiHet_.d.ts}

@@ -7,7 +7,7 @@ interface ITicker<TArgs extends TickerArgsType> {
      */
     args: TArgs;
     /**
-     * Duration in milliseconds
+     * Duration in seconds to run the ticker
      */
     duration?: number;
     /**
@@ -18,23 +18,27 @@ interface ITicker<TArgs extends TickerArgsType> {
 
 type TickerArgsType = {
     [id: string]: StorageElementType;
-};
+} | {
+    tagToRemoveAfter?: string[] | string;
+    [id: string]: StorageElementType;
+}[];
 /**
  * A class is used to create a ticker element to add into a Pixi Application.
  * You can use GameWindowManager.addTicker() to add this element into the application.
  * This class should be extended and the fn method should be overridden.
- * You must use the tickerDecorator to register the ticker in the game.
+ * 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("TickerRotate")
- * export class TickerRotate extends TickerBase<{ speed?: number }> {
+ * \@tickerDecorator() // this is equivalent to tickerDecorator("RotateTicker")
+ * export class RotateTicker extends TickerBase<{ speed?: number }> {
  *     override fn(
- *         t: Ticker,
- *         args: {
+ *         t: Ticker, // the ticker that is calling this method
+ *         args: { // the arguments that you passed when you added the ticker
  *             speed?: number,
  *         },
- *         tags: string[]
+ *         tags: string[], // the tags 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 GameWindowManager.currentTickers
  *     ): void {
  *         let speed = args.speed === undefined ? 0.1 : args.speed
  *         tags.forEach((tag) => {
@@ -53,8 +57,8 @@ type TickerArgsType = {
 declare class TickerBase<TArgs extends TickerArgsType> implements ITicker<TArgs> {
     /**
      * @param args The arguments that you want to pass to the ticker.
-     * @param duration The duration of the ticker. If is undefined, the ticker will be called every frame.
-     * @param priority The priority of the ticker. If is undefined, the priority will be UPDATE_PRIORITY.NORMAL.
+     * @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);
     args: TArgs;
@@ -63,11 +67,12 @@ declare class TickerBase<TArgs extends TickerArgsType> implements ITicker<TArgs>
     /**
      * The method that will be called every frame.
      * This method should be overridden and you can use GameWindowManager.addCanvasElement() to get the canvas element of the canvas, and edit them.
-     * @param t The ticker that is calling this method
-     * @param args The arguments that you passed when you added the ticker
-     * @param tags The tags of the canvas elements that are connected to this ticker
+     * @param _ticker The ticker that is calling this method
+     * @param _args The arguments that you passed when you added the ticker
+     * @param _tags The tags 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 GameWindowManager.currentTickers}
      */
-    fn(_t: Ticker, _args: TArgs, _tags: string | string[]): void;
+    fn(_ticker: Ticker, _args: TArgs, _tags: string | string[], _tickerId: string): void;
 }
 
 export { type ITicker as I, TickerBase as T, type TickerArgsType as a };

package/dist/{TickerBase-CFEJHstJ.d.mts → TickerBase-BctFf13y.d.mts}

@@ -7,7 +7,7 @@ interface ITicker<TArgs extends TickerArgsType> {
      */
     args: TArgs;
     /**
-     * Duration in milliseconds
+     * Duration in seconds to run the ticker
      */
     duration?: number;
     /**
@@ -18,23 +18,27 @@ interface ITicker<TArgs extends TickerArgsType> {
 
 type TickerArgsType = {
     [id: string]: StorageElementType;
-};
+} | {
+    tagToRemoveAfter?: string[] | string;
+    [id: string]: StorageElementType;
+}[];
 /**
  * A class is used to create a ticker element to add into a Pixi Application.
  * You can use GameWindowManager.addTicker() to add this element into the application.
  * This class should be extended and the fn method should be overridden.
- * You must use the tickerDecorator to register the ticker in the game.
+ * 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("TickerRotate")
- * export class TickerRotate extends TickerBase<{ speed?: number }> {
+ * \@tickerDecorator() // this is equivalent to tickerDecorator("RotateTicker")
+ * export class RotateTicker extends TickerBase<{ speed?: number }> {
  *     override fn(
- *         t: Ticker,
- *         args: {
+ *         t: Ticker, // the ticker that is calling this method
+ *         args: { // the arguments that you passed when you added the ticker
  *             speed?: number,
  *         },
- *         tags: string[]
+ *         tags: string[], // the tags 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 GameWindowManager.currentTickers
  *     ): void {
  *         let speed = args.speed === undefined ? 0.1 : args.speed
  *         tags.forEach((tag) => {
@@ -53,8 +57,8 @@ type TickerArgsType = {
 declare class TickerBase<TArgs extends TickerArgsType> implements ITicker<TArgs> {
     /**
      * @param args The arguments that you want to pass to the ticker.
-     * @param duration The duration of the ticker. If is undefined, the ticker will be called every frame.
-     * @param priority The priority of the ticker. If is undefined, the priority will be UPDATE_PRIORITY.NORMAL.
+     * @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);
     args: TArgs;
@@ -63,11 +67,12 @@ declare class TickerBase<TArgs extends TickerArgsType> implements ITicker<TArgs>
     /**
      * The method that will be called every frame.
      * This method should be overridden and you can use GameWindowManager.addCanvasElement() to get the canvas element of the canvas, and edit them.
-     * @param t The ticker that is calling this method
-     * @param args The arguments that you passed when you added the ticker
-     * @param tags The tags of the canvas elements that are connected to this ticker
+     * @param _ticker The ticker that is calling this method
+     * @param _args The arguments that you passed when you added the ticker
+     * @param _tags The tags 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 GameWindowManager.currentTickers}
      */
-    fn(_t: Ticker, _args: TArgs, _tags: string | string[]): void;
+    fn(_ticker: Ticker, _args: TArgs, _tags: string | string[], _tickerId: string): void;
 }
 
 export { type ITicker as I, TickerBase as T, type TickerArgsType as a };

package/dist/classes/CanvasEvent.d.mts

@@ -1,9 +1,9 @@
-import { CanvasEventNamesType } from '../types/CanvasEventNamesType.mjs';
+import CanvasEventNamesType from '../types/CanvasEventNamesType.mjs';
 
 /**
  * CanvasEvent is a class that is used to create a pixi event, and connect it to a canvas element, with on().
  * This class should be extended and the fn method should be overridden.
- * You must use the eventDecorator to register the event in the game.
+ * You must use the {@link eventDecorator} to register the event in the game.
  * @example
  * ```typescript
  * \@eventDecorator() // this is equivalent to eventDecorator("EventTest")

package/dist/classes/CanvasEvent.d.ts

@@ -1,9 +1,9 @@
-import { CanvasEventNamesType } from '../types/CanvasEventNamesType.js';
+import CanvasEventNamesType from '../types/CanvasEventNamesType.js';
 
 /**
  * CanvasEvent is a class that is used to create a pixi event, and connect it to a canvas element, with on().
  * This class should be extended and the fn method should be overridden.
- * You must use the eventDecorator to register the event in the game.
+ * You must use the {@link eventDecorator} to register the event in the game.
  * @example
  * ```typescript
  * \@eventDecorator() // this is equivalent to eventDecorator("EventTest")

package/dist/classes/CanvasEvent.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/classes/CanvasEvent.ts"],"names":[],"mappings":";AAmBA,IAAqB,cAArB,MAAoC;AAAA,EAChC,GAAG,QAA8B,UAAa;AAAE,UAAM,IAAI,MAAM,0DAA0D;AAAA,EAAE;AAChI","sourcesContent":["import { CanvasEventNamesType } from \"../types/CanvasEventNamesType\";\n\n/**\n * CanvasEvent is a class that is used to create a pixi event, and connect it to a canvas element, with on().\n * This class should be extended and the fn method should be overridden.\n * You must use the eventDecorator to register the event in the game.\n * @example\n * ```typescript\n * \\@eventDecorator() // this is equivalent to eventDecorator(\"EventTest\")\n * export class EventTest extends CanvasEvent<CanvasSprite> {\n *     override fn(event: CanvasEventNamesType, sprite: CanvasSprite): void {\n *         if (event === 'pointerdown') {\n *             sprite.scale.x *= 1.25;\n *             sprite.scale.y *= 1.25;\n *         }\n *     }\n * }\n * ```\n */\nexport default class CanvasEvent<C> {\n    fn(_event: CanvasEventNamesType, _element: C) { throw new Error(\"[Pixi'VN] The method CanvasEvent.fn() must be overridden\") }\n}\n"]}
+{"version":3,"sources":["../../src/classes/CanvasEvent.ts"],"names":[],"mappings":";AAoBA,IAAqB,cAArB,MAAoC;AAAA,EAChC,GAAG,QAA8B,UAAa;AAAE,UAAM,IAAI,MAAM,0DAA0D;AAAA,EAAE;AAChI","sourcesContent":["import { eventDecorator } from \"../decorators\";\nimport { CanvasEventNamesType } from \"../types\";\n\n/**\n * CanvasEvent is a class that is used to create a pixi event, and connect it to a canvas element, with on().\n * This class should be extended and the fn method should be overridden.\n * You must use the {@link eventDecorator} to register the event in the game.\n * @example\n * ```typescript\n * \\@eventDecorator() // this is equivalent to eventDecorator(\"EventTest\")\n * export class EventTest extends CanvasEvent<CanvasSprite> {\n *     override fn(event: CanvasEventNamesType, sprite: CanvasSprite): void {\n *         if (event === 'pointerdown') {\n *             sprite.scale.x *= 1.25;\n *             sprite.scale.y *= 1.25;\n *         }\n *     }\n * }\n * ```\n */\nexport default class CanvasEvent<C> {\n    fn(_event: CanvasEventNamesType, _element: C) { throw new Error(\"[Pixi'VN] The method CanvasEvent.fn() must be overridden\") }\n}\n"]}

package/dist/classes/CanvasEvent.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/classes/CanvasEvent.ts"],"names":[],"mappings":";AAmBA,IAAqB,cAArB,MAAoC;AAAA,EAChC,GAAG,QAA8B,UAAa;AAAE,UAAM,IAAI,MAAM,0DAA0D;AAAA,EAAE;AAChI","sourcesContent":["import { CanvasEventNamesType } from \"../types/CanvasEventNamesType\";\n\n/**\n * CanvasEvent is a class that is used to create a pixi event, and connect it to a canvas element, with on().\n * This class should be extended and the fn method should be overridden.\n * You must use the eventDecorator to register the event in the game.\n * @example\n * ```typescript\n * \\@eventDecorator() // this is equivalent to eventDecorator(\"EventTest\")\n * export class EventTest extends CanvasEvent<CanvasSprite> {\n *     override fn(event: CanvasEventNamesType, sprite: CanvasSprite): void {\n *         if (event === 'pointerdown') {\n *             sprite.scale.x *= 1.25;\n *             sprite.scale.y *= 1.25;\n *         }\n *     }\n * }\n * ```\n */\nexport default class CanvasEvent<C> {\n    fn(_event: CanvasEventNamesType, _element: C) { throw new Error(\"[Pixi'VN] The method CanvasEvent.fn() must be overridden\") }\n}\n"]}
+{"version":3,"sources":["../../src/classes/CanvasEvent.ts"],"names":[],"mappings":";AAoBA,IAAqB,cAArB,MAAoC;AAAA,EAChC,GAAG,QAA8B,UAAa;AAAE,UAAM,IAAI,MAAM,0DAA0D;AAAA,EAAE;AAChI","sourcesContent":["import { eventDecorator } from \"../decorators\";\nimport { CanvasEventNamesType } from \"../types\";\n\n/**\n * CanvasEvent is a class that is used to create a pixi event, and connect it to a canvas element, with on().\n * This class should be extended and the fn method should be overridden.\n * You must use the {@link eventDecorator} to register the event in the game.\n * @example\n * ```typescript\n * \\@eventDecorator() // this is equivalent to eventDecorator(\"EventTest\")\n * export class EventTest extends CanvasEvent<CanvasSprite> {\n *     override fn(event: CanvasEventNamesType, sprite: CanvasSprite): void {\n *         if (event === 'pointerdown') {\n *             sprite.scale.x *= 1.25;\n *             sprite.scale.y *= 1.25;\n *         }\n *     }\n * }\n * ```\n */\nexport default class CanvasEvent<C> {\n    fn(_event: CanvasEventNamesType, _element: C) { throw new Error(\"[Pixi'VN] The method CanvasEvent.fn() must be overridden\") }\n}\n"]}

package/dist/classes/CharacterBaseModel.d.mts

@@ -1,34 +1,10 @@
+import CharacterBaseModelProps from '../interface/CharacterBaseModelProps.mjs';
 import StoredClassModel from './StoredClassModel.mjs';
 
-/**
- * CharacterBaseModelProps is an interface that is used to create a character model.
- */
-interface CharacterBaseModelProps {
-    /**
-     * The name of the character.
-     */
-    name: string;
-    /**
-     * The surname of the character.
-     */
-    surname?: string;
-    /**
-     * The age of the character.
-     */
-    age?: number;
-    /**
-     * The icon of the character.
-     */
-    icon?: string;
-    /**
-     * The color of the character.
-     */
-    color?: string;
-}
 /**
  * CharacterBaseModel is a class that is used to create a character model.
  * I suggest you extend this class to create your own character models.
- * You must use the saveCharacter function to save the character in the game.
+ * You must use the {@link saveCharacter} function to save the character in the game.
  * @example
  * ```typescript
  * export const liam = new CharacterBaseModel('liam', {
@@ -87,4 +63,4 @@ declare class CharacterBaseModel extends StoredClassModel implements CharacterBa
     get color(): string | undefined;
 }
 
-export { type CharacterBaseModelProps, CharacterBaseModel as default };
+export { CharacterBaseModel as default };

package/dist/classes/CharacterBaseModel.d.ts

@@ -1,34 +1,10 @@
+import CharacterBaseModelProps from '../interface/CharacterBaseModelProps.js';
 import StoredClassModel from './StoredClassModel.js';
 
-/**
- * CharacterBaseModelProps is an interface that is used to create a character model.
- */
-interface CharacterBaseModelProps {
-    /**
-     * The name of the character.
-     */
-    name: string;
-    /**
-     * The surname of the character.
-     */
-    surname?: string;
-    /**
-     * The age of the character.
-     */
-    age?: number;
-    /**
-     * The icon of the character.
-     */
-    icon?: string;
-    /**
-     * The color of the character.
-     */
-    color?: string;
-}
 /**
  * CharacterBaseModel is a class that is used to create a character model.
  * I suggest you extend this class to create your own character models.
- * You must use the saveCharacter function to save the character in the game.
+ * You must use the {@link saveCharacter} function to save the character in the game.
  * @example
  * ```typescript
  * export const liam = new CharacterBaseModel('liam', {
@@ -87,4 +63,4 @@ declare class CharacterBaseModel extends StoredClassModel implements CharacterBa
     get color(): string | undefined;
 }
 
-export { type CharacterBaseModelProps, CharacterBaseModel as default };
+export { CharacterBaseModel as default };