@drincs/pixi-vn 0.5.2 → 0.5.4

package/dist/classes/CloseLabel.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/functions/StepLabelUtility.ts","../../src/classes/Label.ts","../../src/classes/CloseLabel.ts"],"names":[],"mappings":";AAAA,OAAO,UAAU;AAmBV,SAAS,oBAAoB,OAAiD,OAA0D;AAC3I,SAAO,UAAU;AACrB;;;ACSA,IAAqB,QAArB,MAA6D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMzD,IAAW,QAA4B;AAAE,UAAM,IAAI,MAAM,qDAAqD;AAAA,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMzG,4BAA4B,eAAgE;AAC/F,QAAI,cAAc,WAAW,GAAG;AAC5B,aAAO;AAAA,IACX;AACA,QAAI,MAAc;AAClB,kBAAc,QAAQ,CAAC,MAAM,UAAU;AACnC,UAAI,oBAAoB,MAAM,KAAK,MAAM,KAAK,CAAC,GAAG;AAC9C,cAAM;AAAA,MACV;AAAA,IACJ,CAAC;AACD,WAAO;AAAA,EACX;AAEJ;;;ACrDA,IAAqB,aAArB,cAAwC,MAAM;AAAE","sourcesContent":["import sha1 from 'crypto-js/sha1';\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\";\nimport { StepLabelType } from \"../types/StepLabelType\";\n\n/**\n * Convert StepLabel to StepHistoryData\n * @param step\n * @returns\n */\nexport function getStepSha1(step: StepLabelType): StepHistoryDataType {\n    let sha1String = sha1(step.toString().toLocaleLowerCase())\n    return sha1String.toString()\n}\n/**\n * Check if two steps are equal\n * @param step1\n * @param step2\n * @returns\n */\nexport function checkIfStepsIsEqual(step1: StepHistoryDataType | StepLabelType<any>, step2: StepHistoryDataType | StepLabelType<any>): boolean {\n    return step1 === step2\n}\n","import { checkIfStepsIsEqual } from \"../functions/StepLabelUtility\"\nimport { StorageObjectType } from \"../types\"\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\"\nimport { StepLabelType } from \"../types/StepLabelType\"\n\n/**\n * Label is a class that contains a list of steps, which will be performed as the game continues.\n * You must use the labelDecorator to register the label in the game.\n * For Ren'py this is the equivalent of a label.\n * @example\n * ```typescript\n * \\@labelDecorator() // this is equivalent to labelDecorator(\"StartLabel\")\n * export class StartLabel extends Label {\n *     override get steps(): StepLabelType[] {\n *         return [\n *             () => {\n *                 GameWindowManager.clear()\n *                 setDialogue({ character: liam, text: \"Which test do you want to perform?\" })\n *                 setChoiceMenuOptions([\n *                     new ChoiceMenuOption(\"Events Test\", EventsTestLabel),\n *                     new ChoiceMenuOption(\"Show Image Test\", ShowImageTest),\n *                 ])\n *             },\n *             () => GameStepManager.jumpLabel(StartLabel),\n *         ]\n *     }\n * }\n * GameStepManager.callLabel(StartLabel)\n * ```\n */\nexport default class Label<T extends StorageObjectType = {}> {\n    /**\n     * Get the steps of the label.\n     * This class should be extended and the steps method should be overridden.\n     * Every time you update this list will also be updated when the other game versions load.\n     */\n    public get steps(): StepLabelType<T>[] { throw new Error(\"[Pixi'VN] The method Label.steps must be overridden\") }\n    /**\n     * Get the corresponding steps number\n     * @param externalSteps\n     * @returns Numer of corresponding steps, for example, if externalSteps is [ABC, DEF, GHI] and the steps of the label is [ABC, GHT], the result will be 1\n     */\n    public getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number {\n        if (externalSteps.length === 0) {\n            return 0\n        }\n        let res: number = 0\n        externalSteps.forEach((step, index) => {\n            if (checkIfStepsIsEqual(step, this.steps[index])) {\n                res = index\n            }\n        })\n        return res\n    }\n    choiseIndex?: number\n}\n","import Label from \"./Label\"\n\nexport default class CloseLabel extends Label { }\n"]}
+{"version":3,"sources":["../../src/functions/StepLabelUtility.ts","../../src/classes/Label.ts","../../src/classes/CloseLabel.ts"],"names":[],"mappings":";AAAA,OAAO,UAAU;AAmBV,SAAS,oBAAoB,OAAiD,OAA0D;AAC3I,SAAO,UAAU;AACrB;;;ACQA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,YAAY,IAAiB,OAA2B,WAAwC,aAAsB;AAClH,SAAK,MAAM;AACX,SAAK,SAAS;AACd,SAAK,aAAa;AAClB,SAAK,eAAe;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,KAAkB;AACzB,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAW,QAA4B;AACnC,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,4BAA4B,eAAgE;AAC/F,QAAI,cAAc,WAAW,GAAG;AAC5B,aAAO;AAAA,IACX;AACA,QAAI,MAAc;AAClB,kBAAc,QAAQ,CAAC,MAAM,UAAU;AACnC,UAAI,oBAAoB,MAAM,KAAK,MAAM,KAAK,CAAC,GAAG;AAC9C,cAAM;AAAA,MACV;AAAA,IACJ,CAAC;AACD,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,IAAW,YAAsD;AAC7D,WAAO,KAAK;AAAA,EAChB;AAAA,EAGA,IAAW,cAAkC;AACzC,WAAO,KAAK;AAAA,EAChB;AACJ;;;ACjGO,IAAM,iBAAiB;AAK9B,IAAqB,aAArB,cAAwC,MAAM;AAAA,EAC1C,YAAY,aAAsB;AAC9B,UAAM,gBAAgB,CAAC,GAAG,QAAW,WAAW;AAAA,EACpD;AACJ","sourcesContent":["import sha1 from 'crypto-js/sha1';\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\";\nimport { StepLabelType } from \"../types/StepLabelType\";\n\n/**\n * Convert StepLabel to StepHistoryData\n * @param step\n * @returns\n */\nexport function getStepSha1(step: StepLabelType): StepHistoryDataType {\n    let sha1String = sha1(step.toString().toLocaleLowerCase())\n    return sha1String.toString()\n}\n/**\n * Check if two steps are equal\n * @param step1\n * @param step2\n * @returns\n */\nexport function checkIfStepsIsEqual(step1: StepHistoryDataType | StepLabelType<any>, step2: StepHistoryDataType | StepLabelType<any>): boolean {\n    return step1 === step2\n}\n","import { checkIfStepsIsEqual } from \"../functions/StepLabelUtility\"\nimport { LabelIdType } from \"../types/LabelIdType\"\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\"\nimport { StepLabelType } from \"../types/StepLabelType\"\n\n/**\n * Label is a class that contains a list of steps, which will be performed as the game continues.\n * For Ren'py this is the equivalent of a label.\n * @example\n * ```typescript\n * const START_LABEL_ID = \"StartLabel\"\n * \n * export const startLabel = newLabel(START_LABEL_ID,\n *     [\n *         (props) => {\n *             GameWindowManager.clear()\n *             setDialogue({ character: liam, text: \"Which test do you want to perform?\" })\n *             setChoiceMenuOptions([\n *                 new ChoiceMenuOption(\"Events Test\", eventsTestLabel),\n *                 new ChoiceMenuOption(\"Show Image Test\", showImageTest),\n *             ])\n *         },\n *         (props) => GameStepManager.jumpLabel(START_LABEL_ID, props),\n *     ]\n * )\n * \n * GameStepManager.callLabel(StartLabel)\n * ```\n */\nexport default class Label<T extends {} = {}> {\n    /**\n     * @param id is the id of the label\n     * @param steps is the list of steps that the label will perform\n     * @param onStepRun is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached\n     * @param choiseIndex is the index of the choice that the label will perform\n     */\n    constructor(id: LabelIdType, steps: StepLabelType<T>[], onStepRun?: () => void | Promise<void>, choiseIndex?: number) {\n        this._id = id\n        this._steps = steps\n        this._onStepRun = onStepRun\n        this._choiseIndex = choiseIndex\n    }\n\n    private _id: LabelIdType\n    /**\n     * Get the id of the label\n     */\n    public get id(): LabelIdType {\n        return this._id\n    }\n\n    private _steps: StepLabelType<T>[]\n    /**\n     * Get the steps of the label.\n     * This class should be extended and the steps method should be overridden.\n     * Every time you update this list will also be updated when the other game versions load.\n     */\n    public get steps(): StepLabelType<T>[] {\n        return this._steps\n    }\n\n    /**\n     * Get the corresponding steps number\n     * @param externalSteps\n     * @returns Numer of corresponding steps, for example, if externalSteps is [ABC, DEF, GHI] and the steps of the label is [ABC, GHT], the result will be 1\n     */\n    public getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number {\n        if (externalSteps.length === 0) {\n            return 0\n        }\n        let res: number = 0\n        externalSteps.forEach((step, index) => {\n            if (checkIfStepsIsEqual(step, this.steps[index])) {\n                res = index\n            }\n        })\n        return res\n    }\n\n    private _onStepRun: (() => void | Promise<void>) | undefined\n    /**\n     * Get the function that will be executed before any step is executed, is useful for example to make sure all images used have been cached\n     * @returns Promise<void> or void\n     * @example\n     * ```typescript\n     * newLabel(\"id\", [], () => {\n     *     Assets.load('path/to/image1.png')\n     *     Assets.load('path/to/image2.png')\n     * })\n     * ```\n     */\n    public get onStepRun(): (() => void | Promise<void>) | undefined {\n        return this._onStepRun\n    }\n\n    private _choiseIndex: number | undefined\n    public get choiseIndex(): number | undefined {\n        return this._choiseIndex\n    }\n}\n","import Label from \"./Label\"\n\nexport const CLOSE_LABEL_ID = \"__close-label-id__\"\n\n/**\n * CloseLabel is a label used for closing the menu.\n */\nexport default class CloseLabel extends Label {\n    constructor(choiseIndex?: number) {\n        super(CLOSE_LABEL_ID, [], undefined, choiseIndex)\n    }\n}\n"]}

package/dist/classes/Label.d.mts

@@ -1,34 +1,46 @@
-import { StepLabelType } from '../types/StepLabelType.mjs';
-import { StorageObjectType } from '../types/StorageElementType.mjs';
+import { LabelIdType } from '../types/LabelIdType.mjs';
 import { StepHistoryDataType } from '../types/StepHistoryDataType.mjs';
+import { StepLabelType } from '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
 
 /**
  * Label is a class that contains a list of steps, which will be performed as the game continues.
- * You must use the labelDecorator to register the label in the game.
  * For Ren'py this is the equivalent of a label.
  * @example
  * ```typescript
- * \@labelDecorator() // this is equivalent to labelDecorator("StartLabel")
- * export class StartLabel extends Label {
- *     override get steps(): StepLabelType[] {
- *         return [
- *             () => {
- *                 GameWindowManager.clear()
- *                 setDialogue({ character: liam, text: "Which test do you want to perform?" })
- *                 setChoiceMenuOptions([
- *                     new ChoiceMenuOption("Events Test", EventsTestLabel),
- *                     new ChoiceMenuOption("Show Image Test", ShowImageTest),
- *                 ])
- *             },
- *             () => GameStepManager.jumpLabel(StartLabel),
- *         ]
- *     }
- * }
+ * const START_LABEL_ID = "StartLabel"
+ *
+ * export const startLabel = newLabel(START_LABEL_ID,
+ *     [
+ *         (props) => {
+ *             GameWindowManager.clear()
+ *             setDialogue({ character: liam, text: "Which test do you want to perform?" })
+ *             setChoiceMenuOptions([
+ *                 new ChoiceMenuOption("Events Test", eventsTestLabel),
+ *                 new ChoiceMenuOption("Show Image Test", showImageTest),
+ *             ])
+ *         },
+ *         (props) => GameStepManager.jumpLabel(START_LABEL_ID, props),
+ *     ]
+ * )
+ *
  * GameStepManager.callLabel(StartLabel)
  * ```
  */
-declare class Label<T extends StorageObjectType = {}> {
+declare class Label<T extends {} = {}> {
+    /**
+     * @param id is the id of the label
+     * @param steps is the list of steps that the label will perform
+     * @param onStepRun is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached
+     * @param choiseIndex is the index of the choice that the label will perform
+     */
+    constructor(id: LabelIdType, steps: StepLabelType<T>[], onStepRun?: () => void | Promise<void>, choiseIndex?: number);
+    private _id;
+    /**
+     * Get the id of the label
+     */
+    get id(): LabelIdType;
+    private _steps;
     /**
      * Get the steps of the label.
      * This class should be extended and the steps method should be overridden.
@@ -41,7 +53,21 @@ declare class Label<T extends StorageObjectType = {}> {
      * @returns Numer of corresponding steps, for example, if externalSteps is [ABC, DEF, GHI] and the steps of the label is [ABC, GHT], the result will be 1
      */
     getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number;
-    choiseIndex?: number;
+    private _onStepRun;
+    /**
+     * Get the function that will be executed before any step is executed, is useful for example to make sure all images used have been cached
+     * @returns Promise<void> or void
+     * @example
+     * ```typescript
+     * newLabel("id", [], () => {
+     *     Assets.load('path/to/image1.png')
+     *     Assets.load('path/to/image2.png')
+     * })
+     * ```
+     */
+    get onStepRun(): (() => void | Promise<void>) | undefined;
+    private _choiseIndex;
+    get choiseIndex(): number | undefined;
 }
 
 export { Label as default };

package/dist/classes/Label.d.ts

@@ -1,34 +1,46 @@
-import { StepLabelType } from '../types/StepLabelType.js';
-import { StorageObjectType } from '../types/StorageElementType.js';
+import { LabelIdType } from '../types/LabelIdType.js';
 import { StepHistoryDataType } from '../types/StepHistoryDataType.js';
+import { StepLabelType } from '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
 
 /**
  * Label is a class that contains a list of steps, which will be performed as the game continues.
- * You must use the labelDecorator to register the label in the game.
  * For Ren'py this is the equivalent of a label.
  * @example
  * ```typescript
- * \@labelDecorator() // this is equivalent to labelDecorator("StartLabel")
- * export class StartLabel extends Label {
- *     override get steps(): StepLabelType[] {
- *         return [
- *             () => {
- *                 GameWindowManager.clear()
- *                 setDialogue({ character: liam, text: "Which test do you want to perform?" })
- *                 setChoiceMenuOptions([
- *                     new ChoiceMenuOption("Events Test", EventsTestLabel),
- *                     new ChoiceMenuOption("Show Image Test", ShowImageTest),
- *                 ])
- *             },
- *             () => GameStepManager.jumpLabel(StartLabel),
- *         ]
- *     }
- * }
+ * const START_LABEL_ID = "StartLabel"
+ *
+ * export const startLabel = newLabel(START_LABEL_ID,
+ *     [
+ *         (props) => {
+ *             GameWindowManager.clear()
+ *             setDialogue({ character: liam, text: "Which test do you want to perform?" })
+ *             setChoiceMenuOptions([
+ *                 new ChoiceMenuOption("Events Test", eventsTestLabel),
+ *                 new ChoiceMenuOption("Show Image Test", showImageTest),
+ *             ])
+ *         },
+ *         (props) => GameStepManager.jumpLabel(START_LABEL_ID, props),
+ *     ]
+ * )
+ *
  * GameStepManager.callLabel(StartLabel)
  * ```
  */
-declare class Label<T extends StorageObjectType = {}> {
+declare class Label<T extends {} = {}> {
+    /**
+     * @param id is the id of the label
+     * @param steps is the list of steps that the label will perform
+     * @param onStepRun is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached
+     * @param choiseIndex is the index of the choice that the label will perform
+     */
+    constructor(id: LabelIdType, steps: StepLabelType<T>[], onStepRun?: () => void | Promise<void>, choiseIndex?: number);
+    private _id;
+    /**
+     * Get the id of the label
+     */
+    get id(): LabelIdType;
+    private _steps;
     /**
      * Get the steps of the label.
      * This class should be extended and the steps method should be overridden.
@@ -41,7 +53,21 @@ declare class Label<T extends StorageObjectType = {}> {
      * @returns Numer of corresponding steps, for example, if externalSteps is [ABC, DEF, GHI] and the steps of the label is [ABC, GHT], the result will be 1
      */
     getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number;
-    choiseIndex?: number;
+    private _onStepRun;
+    /**
+     * Get the function that will be executed before any step is executed, is useful for example to make sure all images used have been cached
+     * @returns Promise<void> or void
+     * @example
+     * ```typescript
+     * newLabel("id", [], () => {
+     *     Assets.load('path/to/image1.png')
+     *     Assets.load('path/to/image2.png')
+     * })
+     * ```
+     */
+    get onStepRun(): (() => void | Promise<void>) | undefined;
+    private _choiseIndex;
+    get choiseIndex(): number | undefined;
 }
 
 export { Label as default };

package/dist/classes/Label.js

@@ -9,13 +9,31 @@ function checkIfStepsIsEqual(step1, step2) {
 
 // src/classes/Label.ts
 var Label = class {
+  /**
+   * @param id is the id of the label
+   * @param steps is the list of steps that the label will perform
+   * @param onStepRun is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached
+   * @param choiseIndex is the index of the choice that the label will perform
+   */
+  constructor(id, steps, onStepRun, choiseIndex) {
+    this._id = id;
+    this._steps = steps;
+    this._onStepRun = onStepRun;
+    this._choiseIndex = choiseIndex;
+  }
+  /**
+   * Get the id of the label
+   */
+  get id() {
+    return this._id;
+  }
   /**
    * Get the steps of the label.
    * This class should be extended and the steps method should be overridden.
    * Every time you update this list will also be updated when the other game versions load.
    */
   get steps() {
-    throw new Error("[Pixi'VN] The method Label.steps must be overridden");
+    return this._steps;
   }
   /**
    * Get the corresponding steps number
@@ -34,6 +52,23 @@ var Label = class {
     });
     return res;
   }
+  /**
+   * Get the function that will be executed before any step is executed, is useful for example to make sure all images used have been cached
+   * @returns Promise<void> or void
+   * @example
+   * ```typescript
+   * newLabel("id", [], () => {
+   *     Assets.load('path/to/image1.png')
+   *     Assets.load('path/to/image2.png')
+   * })
+   * ```
+   */
+  get onStepRun() {
+    return this._onStepRun;
+  }
+  get choiseIndex() {
+    return this._choiseIndex;
+  }
 };
 
 module.exports = Label;

package/dist/classes/Label.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/functions/StepLabelUtility.ts","../../src/classes/Label.ts"],"names":[],"mappings":";AAAA,OAAO,UAAU;AAmBV,SAAS,oBAAoB,OAAiD,OAA0D;AAC3I,SAAO,UAAU;AACrB;;;ACSA,IAAqB,QAArB,MAA6D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMzD,IAAW,QAA4B;AAAE,UAAM,IAAI,MAAM,qDAAqD;AAAA,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMzG,4BAA4B,eAAgE;AAC/F,QAAI,cAAc,WAAW,GAAG;AAC5B,aAAO;AAAA,IACX;AACA,QAAI,MAAc;AAClB,kBAAc,QAAQ,CAAC,MAAM,UAAU;AACnC,UAAI,oBAAoB,MAAM,KAAK,MAAM,KAAK,CAAC,GAAG;AAC9C,cAAM;AAAA,MACV;AAAA,IACJ,CAAC;AACD,WAAO;AAAA,EACX;AAEJ","sourcesContent":["import sha1 from 'crypto-js/sha1';\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\";\nimport { StepLabelType } from \"../types/StepLabelType\";\n\n/**\n * Convert StepLabel to StepHistoryData\n * @param step\n * @returns\n */\nexport function getStepSha1(step: StepLabelType): StepHistoryDataType {\n    let sha1String = sha1(step.toString().toLocaleLowerCase())\n    return sha1String.toString()\n}\n/**\n * Check if two steps are equal\n * @param step1\n * @param step2\n * @returns\n */\nexport function checkIfStepsIsEqual(step1: StepHistoryDataType | StepLabelType<any>, step2: StepHistoryDataType | StepLabelType<any>): boolean {\n    return step1 === step2\n}\n","import { checkIfStepsIsEqual } from \"../functions/StepLabelUtility\"\nimport { StorageObjectType } from \"../types\"\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\"\nimport { StepLabelType } from \"../types/StepLabelType\"\n\n/**\n * Label is a class that contains a list of steps, which will be performed as the game continues.\n * You must use the labelDecorator to register the label in the game.\n * For Ren'py this is the equivalent of a label.\n * @example\n * ```typescript\n * \\@labelDecorator() // this is equivalent to labelDecorator(\"StartLabel\")\n * export class StartLabel extends Label {\n *     override get steps(): StepLabelType[] {\n *         return [\n *             () => {\n *                 GameWindowManager.clear()\n *                 setDialogue({ character: liam, text: \"Which test do you want to perform?\" })\n *                 setChoiceMenuOptions([\n *                     new ChoiceMenuOption(\"Events Test\", EventsTestLabel),\n *                     new ChoiceMenuOption(\"Show Image Test\", ShowImageTest),\n *                 ])\n *             },\n *             () => GameStepManager.jumpLabel(StartLabel),\n *         ]\n *     }\n * }\n * GameStepManager.callLabel(StartLabel)\n * ```\n */\nexport default class Label<T extends StorageObjectType = {}> {\n    /**\n     * Get the steps of the label.\n     * This class should be extended and the steps method should be overridden.\n     * Every time you update this list will also be updated when the other game versions load.\n     */\n    public get steps(): StepLabelType<T>[] { throw new Error(\"[Pixi'VN] The method Label.steps must be overridden\") }\n    /**\n     * Get the corresponding steps number\n     * @param externalSteps\n     * @returns Numer of corresponding steps, for example, if externalSteps is [ABC, DEF, GHI] and the steps of the label is [ABC, GHT], the result will be 1\n     */\n    public getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number {\n        if (externalSteps.length === 0) {\n            return 0\n        }\n        let res: number = 0\n        externalSteps.forEach((step, index) => {\n            if (checkIfStepsIsEqual(step, this.steps[index])) {\n                res = index\n            }\n        })\n        return res\n    }\n    choiseIndex?: number\n}\n"]}
+{"version":3,"sources":["../../src/functions/StepLabelUtility.ts","../../src/classes/Label.ts"],"names":[],"mappings":";AAAA,OAAO,UAAU;AAmBV,SAAS,oBAAoB,OAAiD,OAA0D;AAC3I,SAAO,UAAU;AACrB;;;ACQA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,YAAY,IAAiB,OAA2B,WAAwC,aAAsB;AAClH,SAAK,MAAM;AACX,SAAK,SAAS;AACd,SAAK,aAAa;AAClB,SAAK,eAAe;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,KAAkB;AACzB,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAW,QAA4B;AACnC,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,4BAA4B,eAAgE;AAC/F,QAAI,cAAc,WAAW,GAAG;AAC5B,aAAO;AAAA,IACX;AACA,QAAI,MAAc;AAClB,kBAAc,QAAQ,CAAC,MAAM,UAAU;AACnC,UAAI,oBAAoB,MAAM,KAAK,MAAM,KAAK,CAAC,GAAG;AAC9C,cAAM;AAAA,MACV;AAAA,IACJ,CAAC;AACD,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,IAAW,YAAsD;AAC7D,WAAO,KAAK;AAAA,EAChB;AAAA,EAGA,IAAW,cAAkC;AACzC,WAAO,KAAK;AAAA,EAChB;AACJ","sourcesContent":["import sha1 from 'crypto-js/sha1';\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\";\nimport { StepLabelType } from \"../types/StepLabelType\";\n\n/**\n * Convert StepLabel to StepHistoryData\n * @param step\n * @returns\n */\nexport function getStepSha1(step: StepLabelType): StepHistoryDataType {\n    let sha1String = sha1(step.toString().toLocaleLowerCase())\n    return sha1String.toString()\n}\n/**\n * Check if two steps are equal\n * @param step1\n * @param step2\n * @returns\n */\nexport function checkIfStepsIsEqual(step1: StepHistoryDataType | StepLabelType<any>, step2: StepHistoryDataType | StepLabelType<any>): boolean {\n    return step1 === step2\n}\n","import { checkIfStepsIsEqual } from \"../functions/StepLabelUtility\"\nimport { LabelIdType } from \"../types/LabelIdType\"\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\"\nimport { StepLabelType } from \"../types/StepLabelType\"\n\n/**\n * Label is a class that contains a list of steps, which will be performed as the game continues.\n * For Ren'py this is the equivalent of a label.\n * @example\n * ```typescript\n * const START_LABEL_ID = \"StartLabel\"\n * \n * export const startLabel = newLabel(START_LABEL_ID,\n *     [\n *         (props) => {\n *             GameWindowManager.clear()\n *             setDialogue({ character: liam, text: \"Which test do you want to perform?\" })\n *             setChoiceMenuOptions([\n *                 new ChoiceMenuOption(\"Events Test\", eventsTestLabel),\n *                 new ChoiceMenuOption(\"Show Image Test\", showImageTest),\n *             ])\n *         },\n *         (props) => GameStepManager.jumpLabel(START_LABEL_ID, props),\n *     ]\n * )\n * \n * GameStepManager.callLabel(StartLabel)\n * ```\n */\nexport default class Label<T extends {} = {}> {\n    /**\n     * @param id is the id of the label\n     * @param steps is the list of steps that the label will perform\n     * @param onStepRun is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached\n     * @param choiseIndex is the index of the choice that the label will perform\n     */\n    constructor(id: LabelIdType, steps: StepLabelType<T>[], onStepRun?: () => void | Promise<void>, choiseIndex?: number) {\n        this._id = id\n        this._steps = steps\n        this._onStepRun = onStepRun\n        this._choiseIndex = choiseIndex\n    }\n\n    private _id: LabelIdType\n    /**\n     * Get the id of the label\n     */\n    public get id(): LabelIdType {\n        return this._id\n    }\n\n    private _steps: StepLabelType<T>[]\n    /**\n     * Get the steps of the label.\n     * This class should be extended and the steps method should be overridden.\n     * Every time you update this list will also be updated when the other game versions load.\n     */\n    public get steps(): StepLabelType<T>[] {\n        return this._steps\n    }\n\n    /**\n     * Get the corresponding steps number\n     * @param externalSteps\n     * @returns Numer of corresponding steps, for example, if externalSteps is [ABC, DEF, GHI] and the steps of the label is [ABC, GHT], the result will be 1\n     */\n    public getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number {\n        if (externalSteps.length === 0) {\n            return 0\n        }\n        let res: number = 0\n        externalSteps.forEach((step, index) => {\n            if (checkIfStepsIsEqual(step, this.steps[index])) {\n                res = index\n            }\n        })\n        return res\n    }\n\n    private _onStepRun: (() => void | Promise<void>) | undefined\n    /**\n     * Get the function that will be executed before any step is executed, is useful for example to make sure all images used have been cached\n     * @returns Promise<void> or void\n     * @example\n     * ```typescript\n     * newLabel(\"id\", [], () => {\n     *     Assets.load('path/to/image1.png')\n     *     Assets.load('path/to/image2.png')\n     * })\n     * ```\n     */\n    public get onStepRun(): (() => void | Promise<void>) | undefined {\n        return this._onStepRun\n    }\n\n    private _choiseIndex: number | undefined\n    public get choiseIndex(): number | undefined {\n        return this._choiseIndex\n    }\n}\n"]}

package/dist/classes/Label.mjs

@@ -7,13 +7,31 @@ function checkIfStepsIsEqual(step1, step2) {
 
 // src/classes/Label.ts
 var Label = class {
+  /**
+   * @param id is the id of the label
+   * @param steps is the list of steps that the label will perform
+   * @param onStepRun is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached
+   * @param choiseIndex is the index of the choice that the label will perform
+   */
+  constructor(id, steps, onStepRun, choiseIndex) {
+    this._id = id;
+    this._steps = steps;
+    this._onStepRun = onStepRun;
+    this._choiseIndex = choiseIndex;
+  }
+  /**
+   * Get the id of the label
+   */
+  get id() {
+    return this._id;
+  }
   /**
    * Get the steps of the label.
    * This class should be extended and the steps method should be overridden.
    * Every time you update this list will also be updated when the other game versions load.
    */
   get steps() {
-    throw new Error("[Pixi'VN] The method Label.steps must be overridden");
+    return this._steps;
   }
   /**
    * Get the corresponding steps number
@@ -32,6 +50,23 @@ var Label = class {
     });
     return res;
   }
+  /**
+   * Get the function that will be executed before any step is executed, is useful for example to make sure all images used have been cached
+   * @returns Promise<void> or void
+   * @example
+   * ```typescript
+   * newLabel("id", [], () => {
+   *     Assets.load('path/to/image1.png')
+   *     Assets.load('path/to/image2.png')
+   * })
+   * ```
+   */
+  get onStepRun() {
+    return this._onStepRun;
+  }
+  get choiseIndex() {
+    return this._choiseIndex;
+  }
 };
 
 export { Label as default };

package/dist/classes/Label.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/functions/StepLabelUtility.ts","../../src/classes/Label.ts"],"names":[],"mappings":";AAAA,OAAO,UAAU;AAmBV,SAAS,oBAAoB,OAAiD,OAA0D;AAC3I,SAAO,UAAU;AACrB;;;ACSA,IAAqB,QAArB,MAA6D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMzD,IAAW,QAA4B;AAAE,UAAM,IAAI,MAAM,qDAAqD;AAAA,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMzG,4BAA4B,eAAgE;AAC/F,QAAI,cAAc,WAAW,GAAG;AAC5B,aAAO;AAAA,IACX;AACA,QAAI,MAAc;AAClB,kBAAc,QAAQ,CAAC,MAAM,UAAU;AACnC,UAAI,oBAAoB,MAAM,KAAK,MAAM,KAAK,CAAC,GAAG;AAC9C,cAAM;AAAA,MACV;AAAA,IACJ,CAAC;AACD,WAAO;AAAA,EACX;AAEJ","sourcesContent":["import sha1 from 'crypto-js/sha1';\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\";\nimport { StepLabelType } from \"../types/StepLabelType\";\n\n/**\n * Convert StepLabel to StepHistoryData\n * @param step\n * @returns\n */\nexport function getStepSha1(step: StepLabelType): StepHistoryDataType {\n    let sha1String = sha1(step.toString().toLocaleLowerCase())\n    return sha1String.toString()\n}\n/**\n * Check if two steps are equal\n * @param step1\n * @param step2\n * @returns\n */\nexport function checkIfStepsIsEqual(step1: StepHistoryDataType | StepLabelType<any>, step2: StepHistoryDataType | StepLabelType<any>): boolean {\n    return step1 === step2\n}\n","import { checkIfStepsIsEqual } from \"../functions/StepLabelUtility\"\nimport { StorageObjectType } from \"../types\"\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\"\nimport { StepLabelType } from \"../types/StepLabelType\"\n\n/**\n * Label is a class that contains a list of steps, which will be performed as the game continues.\n * You must use the labelDecorator to register the label in the game.\n * For Ren'py this is the equivalent of a label.\n * @example\n * ```typescript\n * \\@labelDecorator() // this is equivalent to labelDecorator(\"StartLabel\")\n * export class StartLabel extends Label {\n *     override get steps(): StepLabelType[] {\n *         return [\n *             () => {\n *                 GameWindowManager.clear()\n *                 setDialogue({ character: liam, text: \"Which test do you want to perform?\" })\n *                 setChoiceMenuOptions([\n *                     new ChoiceMenuOption(\"Events Test\", EventsTestLabel),\n *                     new ChoiceMenuOption(\"Show Image Test\", ShowImageTest),\n *                 ])\n *             },\n *             () => GameStepManager.jumpLabel(StartLabel),\n *         ]\n *     }\n * }\n * GameStepManager.callLabel(StartLabel)\n * ```\n */\nexport default class Label<T extends StorageObjectType = {}> {\n    /**\n     * Get the steps of the label.\n     * This class should be extended and the steps method should be overridden.\n     * Every time you update this list will also be updated when the other game versions load.\n     */\n    public get steps(): StepLabelType<T>[] { throw new Error(\"[Pixi'VN] The method Label.steps must be overridden\") }\n    /**\n     * Get the corresponding steps number\n     * @param externalSteps\n     * @returns Numer of corresponding steps, for example, if externalSteps is [ABC, DEF, GHI] and the steps of the label is [ABC, GHT], the result will be 1\n     */\n    public getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number {\n        if (externalSteps.length === 0) {\n            return 0\n        }\n        let res: number = 0\n        externalSteps.forEach((step, index) => {\n            if (checkIfStepsIsEqual(step, this.steps[index])) {\n                res = index\n            }\n        })\n        return res\n    }\n    choiseIndex?: number\n}\n"]}
+{"version":3,"sources":["../../src/functions/StepLabelUtility.ts","../../src/classes/Label.ts"],"names":[],"mappings":";AAAA,OAAO,UAAU;AAmBV,SAAS,oBAAoB,OAAiD,OAA0D;AAC3I,SAAO,UAAU;AACrB;;;ACQA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,YAAY,IAAiB,OAA2B,WAAwC,aAAsB;AAClH,SAAK,MAAM;AACX,SAAK,SAAS;AACd,SAAK,aAAa;AAClB,SAAK,eAAe;AAAA,EACxB;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,KAAkB;AACzB,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAW,QAA4B;AACnC,WAAO,KAAK;AAAA,EAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,4BAA4B,eAAgE;AAC/F,QAAI,cAAc,WAAW,GAAG;AAC5B,aAAO;AAAA,IACX;AACA,QAAI,MAAc;AAClB,kBAAc,QAAQ,CAAC,MAAM,UAAU;AACnC,UAAI,oBAAoB,MAAM,KAAK,MAAM,KAAK,CAAC,GAAG;AAC9C,cAAM;AAAA,MACV;AAAA,IACJ,CAAC;AACD,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,IAAW,YAAsD;AAC7D,WAAO,KAAK;AAAA,EAChB;AAAA,EAGA,IAAW,cAAkC;AACzC,WAAO,KAAK;AAAA,EAChB;AACJ","sourcesContent":["import sha1 from 'crypto-js/sha1';\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\";\nimport { StepLabelType } from \"../types/StepLabelType\";\n\n/**\n * Convert StepLabel to StepHistoryData\n * @param step\n * @returns\n */\nexport function getStepSha1(step: StepLabelType): StepHistoryDataType {\n    let sha1String = sha1(step.toString().toLocaleLowerCase())\n    return sha1String.toString()\n}\n/**\n * Check if two steps are equal\n * @param step1\n * @param step2\n * @returns\n */\nexport function checkIfStepsIsEqual(step1: StepHistoryDataType | StepLabelType<any>, step2: StepHistoryDataType | StepLabelType<any>): boolean {\n    return step1 === step2\n}\n","import { checkIfStepsIsEqual } from \"../functions/StepLabelUtility\"\nimport { LabelIdType } from \"../types/LabelIdType\"\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\"\nimport { StepLabelType } from \"../types/StepLabelType\"\n\n/**\n * Label is a class that contains a list of steps, which will be performed as the game continues.\n * For Ren'py this is the equivalent of a label.\n * @example\n * ```typescript\n * const START_LABEL_ID = \"StartLabel\"\n * \n * export const startLabel = newLabel(START_LABEL_ID,\n *     [\n *         (props) => {\n *             GameWindowManager.clear()\n *             setDialogue({ character: liam, text: \"Which test do you want to perform?\" })\n *             setChoiceMenuOptions([\n *                 new ChoiceMenuOption(\"Events Test\", eventsTestLabel),\n *                 new ChoiceMenuOption(\"Show Image Test\", showImageTest),\n *             ])\n *         },\n *         (props) => GameStepManager.jumpLabel(START_LABEL_ID, props),\n *     ]\n * )\n * \n * GameStepManager.callLabel(StartLabel)\n * ```\n */\nexport default class Label<T extends {} = {}> {\n    /**\n     * @param id is the id of the label\n     * @param steps is the list of steps that the label will perform\n     * @param onStepRun is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached\n     * @param choiseIndex is the index of the choice that the label will perform\n     */\n    constructor(id: LabelIdType, steps: StepLabelType<T>[], onStepRun?: () => void | Promise<void>, choiseIndex?: number) {\n        this._id = id\n        this._steps = steps\n        this._onStepRun = onStepRun\n        this._choiseIndex = choiseIndex\n    }\n\n    private _id: LabelIdType\n    /**\n     * Get the id of the label\n     */\n    public get id(): LabelIdType {\n        return this._id\n    }\n\n    private _steps: StepLabelType<T>[]\n    /**\n     * Get the steps of the label.\n     * This class should be extended and the steps method should be overridden.\n     * Every time you update this list will also be updated when the other game versions load.\n     */\n    public get steps(): StepLabelType<T>[] {\n        return this._steps\n    }\n\n    /**\n     * Get the corresponding steps number\n     * @param externalSteps\n     * @returns Numer of corresponding steps, for example, if externalSteps is [ABC, DEF, GHI] and the steps of the label is [ABC, GHT], the result will be 1\n     */\n    public getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number {\n        if (externalSteps.length === 0) {\n            return 0\n        }\n        let res: number = 0\n        externalSteps.forEach((step, index) => {\n            if (checkIfStepsIsEqual(step, this.steps[index])) {\n                res = index\n            }\n        })\n        return res\n    }\n\n    private _onStepRun: (() => void | Promise<void>) | undefined\n    /**\n     * Get the function that will be executed before any step is executed, is useful for example to make sure all images used have been cached\n     * @returns Promise<void> or void\n     * @example\n     * ```typescript\n     * newLabel(\"id\", [], () => {\n     *     Assets.load('path/to/image1.png')\n     *     Assets.load('path/to/image2.png')\n     * })\n     * ```\n     */\n    public get onStepRun(): (() => void | Promise<void>) | undefined {\n        return this._onStepRun\n    }\n\n    private _choiseIndex: number | undefined\n    public get choiseIndex(): number | undefined {\n        return this._choiseIndex\n    }\n}\n"]}

package/dist/classes/StoredClassModel.js

@@ -54,40 +54,6 @@ var __async = (__this, __arguments, generator) => {
   });
 };
 
-// src/types/PauseType.ts
-var PauseValueType = "pause";
-
-// src/types/RepeatType.ts
-var Repeat = "repeat";
-
-// src/decorators/CanvasElementDecorator.ts
-var registeredCanvasElement = {};
-function getCanvasElementInstanceByClassName(canvasName) {
-  try {
-    let eventType = registeredCanvasElement[canvasName];
-    if (!eventType) {
-      if (canvasName === "CanvasContainer") {
-        eventType = CanvasContainer;
-      } else if (canvasName === "CanvasImage") {
-        eventType = CanvasImage;
-      } else if (canvasName === "CanvasSprite") {
-        eventType = CanvasSprite;
-      } else if (canvasName === "CanvasText") {
-        eventType = CanvasText;
-      }
-    }
-    if (!eventType) {
-      console.error(`[Pixi'VN] CanvasElement ${canvasName} not found`);
-      return;
-    }
-    let canvasElement = new eventType();
-    return canvasElement;
-  } catch (e) {
-    console.error(`[Pixi'VN] Error while getting CanvasElement ${canvasName}`, e);
-    return;
-  }
-}
-
 // src/functions/CanvasUtility.ts
 function getTextureMemory(texture) {
   let sourceTexture = texture.source;
@@ -523,29 +489,33 @@ function setMemoryText(element, memory) {
   }
 }
 
-// src/classes/ticker/TickerBase.ts
-var TickerBase = class {
-  /**
-   * @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, duration, priority) {
-    this.args = args;
-    this.duration = duration;
-    this.priority = 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, _args, _tags) {
-    throw new Error("[Pixi'VN] The method TickerBase.fn() must be overridden");
+// src/decorators/CanvasElementDecorator.ts
+var registeredCanvasElement = {};
+function getCanvasElementInstanceByClassName(canvasName) {
+  try {
+    let eventType = registeredCanvasElement[canvasName];
+    if (!eventType) {
+      if (canvasName === "CanvasContainer") {
+        eventType = CanvasContainer;
+      } else if (canvasName === "CanvasImage") {
+        eventType = CanvasImage;
+      } else if (canvasName === "CanvasSprite") {
+        eventType = CanvasSprite;
+      } else if (canvasName === "CanvasText") {
+        eventType = CanvasText;
+      }
+    }
+    if (!eventType) {
+      console.error(`[Pixi'VN] CanvasElement ${canvasName} not found`);
+      return;
+    }
+    let canvasElement = new eventType();
+    return canvasElement;
+  } catch (e) {
+    console.error(`[Pixi'VN] Error while getting CanvasElement ${canvasName}`, e);
+    return;
   }
-};
+}
 
 // src/decorators/TickerDecorator.ts
 var registeredTickers = {};
@@ -574,7 +544,35 @@ function geTickerInstanceByClassName(tickerName, args, duration, priority) {
   }
 }
 
-// src/classes/ticker/TickerFadeAlpha.ts
+// src/types/PauseType.ts
+var PauseValueType = "pause";
+
+// src/types/RepeatType.ts
+var Repeat = "repeat";
+
+// src/classes/ticker/TickerBase.ts
+var TickerBase = class {
+  /**
+   * @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, duration, priority) {
+    this.args = args;
+    this.duration = duration;
+    this.priority = 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, _args, _tags) {
+    throw new Error("[Pixi'VN] The method TickerBase.fn() must be overridden");
+  }
+};
 var TickerFadeAlpha = class extends TickerBase {
   /**
    * The method that will be called every frame to fade the alpha of the canvas element of the canvas.