@drincs/pixi-vn 0.4.7 → 0.4.9

package/dist/TickerBase-CFEJHstJ.d.mts

@@ -0,0 +1,73 @@
+import { UPDATE_PRIORITY, Ticker } from 'pixi.js';
+import { StorageElementType } from './types/StorageElementType.mjs';
+
+interface ITicker<TArgs extends TickerArgsType> {
+    /**
+     * Arguments to pass to the ticker
+     */
+    args: TArgs;
+    /**
+     * Duration in milliseconds
+     */
+    duration?: number;
+    /**
+     * Priority of the ticker
+     */
+    priority?: UPDATE_PRIORITY;
+}
+
+type TickerArgsType = {
+    [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.
+ * In Ren'Py is a transform.
+ * @example
+ * ```typescript
+ * \@tickerDecorator() // this is equivalent to tickerDecorator("TickerRotate")
+ * export class TickerRotate extends TickerBase<{ speed?: number }> {
+ *     override fn(
+ *         t: Ticker,
+ *         args: {
+ *             speed?: number,
+ *         },
+ *         tags: string[]
+ *     ): void {
+ *         let speed = args.speed === undefined ? 0.1 : args.speed
+ *         tags.forEach((tag) => {
+ *                 let element = GameWindowManager.getCanvasElement(tag)
+ *                 if (element && element instanceof Container) {
+ *                     if (clockwise)
+ *                         element.rotation += speed * t.deltaTime
+ *                     else
+ *                         element.rotation -= speed * t.deltaTime
+ *                 }
+ *             })
+ *     }
+ * }
+ * ```
+ */
+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.
+     */
+    constructor(args: TArgs, duration?: number, priority?: UPDATE_PRIORITY);
+    args: TArgs;
+    duration?: number;
+    priority?: UPDATE_PRIORITY;
+    /**
+     * 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
+     */
+    fn(_t: Ticker, _args: TArgs, _tags: string | string[]): void;
+}
+
+export { type ITicker as I, TickerBase as T, type TickerArgsType as a };

package/dist/TickerBase-CjfyD6j5.d.ts

@@ -0,0 +1,73 @@
+import { UPDATE_PRIORITY, Ticker } from 'pixi.js';
+import { StorageElementType } from './types/StorageElementType.js';
+
+interface ITicker<TArgs extends TickerArgsType> {
+    /**
+     * Arguments to pass to the ticker
+     */
+    args: TArgs;
+    /**
+     * Duration in milliseconds
+     */
+    duration?: number;
+    /**
+     * Priority of the ticker
+     */
+    priority?: UPDATE_PRIORITY;
+}
+
+type TickerArgsType = {
+    [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.
+ * In Ren'Py is a transform.
+ * @example
+ * ```typescript
+ * \@tickerDecorator() // this is equivalent to tickerDecorator("TickerRotate")
+ * export class TickerRotate extends TickerBase<{ speed?: number }> {
+ *     override fn(
+ *         t: Ticker,
+ *         args: {
+ *             speed?: number,
+ *         },
+ *         tags: string[]
+ *     ): void {
+ *         let speed = args.speed === undefined ? 0.1 : args.speed
+ *         tags.forEach((tag) => {
+ *                 let element = GameWindowManager.getCanvasElement(tag)
+ *                 if (element && element instanceof Container) {
+ *                     if (clockwise)
+ *                         element.rotation += speed * t.deltaTime
+ *                     else
+ *                         element.rotation -= speed * t.deltaTime
+ *                 }
+ *             })
+ *     }
+ * }
+ * ```
+ */
+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.
+     */
+    constructor(args: TArgs, duration?: number, priority?: UPDATE_PRIORITY);
+    args: TArgs;
+    duration?: number;
+    priority?: UPDATE_PRIORITY;
+    /**
+     * 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
+     */
+    fn(_t: Ticker, _args: TArgs, _tags: string | string[]): void;
+}
+
+export { type ITicker as I, TickerBase as T, type TickerArgsType as a };

package/dist/classes/CanvasEvent.d.mts

@@ -0,0 +1,24 @@
+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.
+ * @example
+ * ```typescript
+ * \@eventDecorator() // this is equivalent to eventDecorator("EventTest")
+ * export class EventTest extends CanvasEvent<CanvasSprite> {
+ *     override fn(event: CanvasEventNamesType, sprite: CanvasSprite): void {
+ *         if (event === 'pointerdown') {
+ *             sprite.scale.x *= 1.25;
+ *             sprite.scale.y *= 1.25;
+ *         }
+ *     }
+ * }
+ * ```
+ */
+declare class CanvasEvent<C> {
+    fn(_event: CanvasEventNamesType, _element: C): void;
+}
+
+export { CanvasEvent as default };

package/dist/classes/CanvasEvent.d.ts

@@ -0,0 +1,24 @@
+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.
+ * @example
+ * ```typescript
+ * \@eventDecorator() // this is equivalent to eventDecorator("EventTest")
+ * export class EventTest extends CanvasEvent<CanvasSprite> {
+ *     override fn(event: CanvasEventNamesType, sprite: CanvasSprite): void {
+ *         if (event === 'pointerdown') {
+ *             sprite.scale.x *= 1.25;
+ *             sprite.scale.y *= 1.25;
+ *         }
+ *     }
+ * }
+ * ```
+ */
+declare class CanvasEvent<C> {
+    fn(_event: CanvasEventNamesType, _element: C): void;
+}
+
+export { CanvasEvent as default };

package/dist/classes/CanvasEvent.js

@@ -0,0 +1,12 @@
+'use strict';
+
+// src/classes/CanvasEvent.ts
+var CanvasEvent = class {
+  fn(_event, _element) {
+    throw new Error("[Pixi'VN] The method CanvasEvent.fn() must be overridden");
+  }
+};
+
+module.exports = CanvasEvent;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=CanvasEvent.js.map

package/dist/classes/CanvasEvent.js.map

@@ -0,0 +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"]}

package/dist/classes/CanvasEvent.mjs

@@ -0,0 +1,10 @@
+// src/classes/CanvasEvent.ts
+var CanvasEvent = class {
+  fn(_event, _element) {
+    throw new Error("[Pixi'VN] The method CanvasEvent.fn() must be overridden");
+  }
+};
+
+export { CanvasEvent as default };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=CanvasEvent.mjs.map

package/dist/classes/CanvasEvent.mjs.map

@@ -0,0 +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"]}

package/dist/classes/CharacterBaseModel.d.mts

@@ -0,0 +1,90 @@
+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.
+ * @example
+ * ```typescript
+ * export const liam = new CharacterBaseModel('liam', {
+ *     name: 'Liam',
+ *     surname: 'Smith',
+ *     age: 25,
+ *     icon: "https://pixijs.com/assets/eggHead.png",
+ *     color: "#9e2e12"
+ * });
+ * export const alice = new CharacterBaseModel('alice', {
+ *     name: 'Alice',
+ *     surname: 'Smith',
+ *     age: 25,
+ *     icon: "https://pixijs.com/assets/eggHead.png",
+ *     color: "#9e2e12"
+ * });
+ * saveCharacter([liam, alice]);
+ * ```
+ */
+declare class CharacterBaseModel extends StoredClassModel implements CharacterBaseModelProps {
+    /**
+     * @param id The id of the character.
+     * @param props The properties of the character.
+     */
+    constructor(id: string, props: CharacterBaseModelProps);
+    private defaultName;
+    /***
+     * The name of the character.
+     * If you set undefined, it will return the default name.
+     */
+    get name(): string;
+    set name(value: string | undefined);
+    private defaultSurname?;
+    /**
+     * The surname of the character.
+     * If you set undefined, it will return the default surname.
+     */
+    get surname(): string | undefined;
+    set surname(value: string | undefined);
+    private defaultAge?;
+    /**
+     * The age of the character.
+     * If you set undefined, it will return the default age.
+     */
+    get age(): number | undefined;
+    set age(value: number | undefined);
+    private _icon?;
+    /**
+     * The icon of the character.
+     */
+    get icon(): string | undefined;
+    private _color?;
+    /**
+     * The color of the character.
+     */
+    get color(): string | undefined;
+}
+
+export { type CharacterBaseModelProps, CharacterBaseModel as default };

package/dist/classes/CharacterBaseModel.d.ts

@@ -0,0 +1,90 @@
+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.
+ * @example
+ * ```typescript
+ * export const liam = new CharacterBaseModel('liam', {
+ *     name: 'Liam',
+ *     surname: 'Smith',
+ *     age: 25,
+ *     icon: "https://pixijs.com/assets/eggHead.png",
+ *     color: "#9e2e12"
+ * });
+ * export const alice = new CharacterBaseModel('alice', {
+ *     name: 'Alice',
+ *     surname: 'Smith',
+ *     age: 25,
+ *     icon: "https://pixijs.com/assets/eggHead.png",
+ *     color: "#9e2e12"
+ * });
+ * saveCharacter([liam, alice]);
+ * ```
+ */
+declare class CharacterBaseModel extends StoredClassModel implements CharacterBaseModelProps {
+    /**
+     * @param id The id of the character.
+     * @param props The properties of the character.
+     */
+    constructor(id: string, props: CharacterBaseModelProps);
+    private defaultName;
+    /***
+     * The name of the character.
+     * If you set undefined, it will return the default name.
+     */
+    get name(): string;
+    set name(value: string | undefined);
+    private defaultSurname?;
+    /**
+     * The surname of the character.
+     * If you set undefined, it will return the default surname.
+     */
+    get surname(): string | undefined;
+    set surname(value: string | undefined);
+    private defaultAge?;
+    /**
+     * The age of the character.
+     * If you set undefined, it will return the default age.
+     */
+    get age(): number | undefined;
+    set age(value: number | undefined);
+    private _icon?;
+    /**
+     * The icon of the character.
+     */
+    get icon(): string | undefined;
+    private _color?;
+    /**
+     * The color of the character.
+     */
+    get color(): string | undefined;
+}
+
+export { type CharacterBaseModelProps, CharacterBaseModel as default };