@drincs/pixi-vn 0.6.4 → 0.6.6

package/dist/classes/Label.js

@@ -2,24 +2,42 @@
 
 require('crypto-js/sha1');
 
-// src/functions/StepLabelUtility.ts
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
 function checkIfStepsIsEqual(step1, step2) {
   return step1 === step2;
 }
 
-// src/classes/Label.ts
-var Label = class {
+// src/classes/LabelAbstract.ts
+var LabelAbstract = 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
+   * @param props is the properties of the label
    */
-  constructor(id, steps, onStepRun, choiseIndex) {
+  constructor(id, props) {
     this._id = id;
-    this._steps = steps;
-    this._onStepRun = onStepRun;
-    this._choiseIndex = choiseIndex;
+    this._onStepStart = props == null ? void 0 : props.onStepStart;
+    this._onLoadStep = props == null ? void 0 : props.onLoadStep;
+    this._onStepEnd = props == null ? void 0 : props.onStepEnd;
+    this._choiseIndex = props == null ? void 0 : props.choiseIndex;
   }
   /**
    * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}
@@ -27,17 +45,6 @@ var Label = class {
   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() {
-    if (typeof this._steps === "function") {
-      return this._steps();
-    }
-    return this._steps;
-  }
   /**
    * Get the corresponding steps number
    * @param externalSteps
@@ -56,24 +63,60 @@ 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
+   * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.
+   * @returns Promise<void> or void
+   */
+  get onStepStart() {
+    return (stepIndex, label) => __async(this, null, function* () {
+      if (this._onLoadStep) {
+        yield this._onLoadStep(stepIndex, label);
+      }
+      if (this._onStepStart) {
+        return yield this._onStepStart(stepIndex, label);
+      }
+    });
+  }
+  /**
+   * Get the function that will be executed a old step is reloaded. A step is reloaded when the user goes back to it or when the user laods a save file.
    * @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 onLoadStep() {
+    return this._onLoadStep;
+  }
+  /**
+   * Is a function that will be executed when the step ends.
+   * @returns Promise<void> or void
+   */
+  get onStepEnd() {
+    return this._onStepEnd;
   }
   get choiseIndex() {
     return this._choiseIndex;
   }
 };
 
+// src/classes/Label.ts
+var Label = class extends LabelAbstract {
+  /**
+   * @param id is the id of the label
+   * @param steps is the list of steps that the label will perform
+   * @param props is the properties of the label
+   */
+  constructor(id, steps, props) {
+    super(id, props);
+    this._steps = steps;
+  }
+  /**
+   * Get the steps of the label.
+   */
+  get steps() {
+    if (typeof this._steps === "function") {
+      return this._steps();
+    }
+    return this._steps;
+  }
+};
+
 module.exports = Label;
 //# sourceMappingURL=Label.js.map
 //# sourceMappingURL=Label.js.map

package/dist/classes/Label.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/functions/StepLabelUtility.ts","../../src/classes/Label.ts"],"names":[],"mappings":";;;;;AAmBO,SAAS,mBAAA,CAAoB,OAAiD,KAA0D,EAAA;AAC3I,EAAA,OAAO,KAAU,KAAA,KAAA,CAAA;AACrB,CAAA;;;ACSA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,WAAY,CAAA,EAAA,EAAiB,KAAwD,EAAA,SAAA,EAAwC,WAAsB,EAAA;AAC/I,IAAA,IAAA,CAAK,GAAM,GAAA,EAAA,CAAA;AACX,IAAA,IAAA,CAAK,MAAS,GAAA,KAAA,CAAA;AACd,IAAA,IAAA,CAAK,UAAa,GAAA,SAAA,CAAA;AAClB,IAAA,IAAA,CAAK,YAAe,GAAA,WAAA,CAAA;AAAA,GACxB;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,EAAkB,GAAA;AACzB,IAAA,OAAO,IAAK,CAAA,GAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAW,KAA4B,GAAA;AACnC,IAAI,IAAA,OAAO,IAAK,CAAA,MAAA,KAAW,UAAY,EAAA;AACnC,MAAA,OAAO,KAAK,MAAO,EAAA,CAAA;AAAA,KACvB;AACA,IAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,4BAA4B,aAAgE,EAAA;AAC/F,IAAI,IAAA,aAAA,CAAc,WAAW,CAAG,EAAA;AAC5B,MAAO,OAAA,CAAA,CAAA;AAAA,KACX;AACA,IAAA,IAAI,GAAc,GAAA,CAAA,CAAA;AAClB,IAAc,aAAA,CAAA,OAAA,CAAQ,CAAC,IAAA,EAAM,KAAU,KAAA;AACnC,MAAA,IAAI,oBAAoB,IAAM,EAAA,IAAA,CAAK,KAAM,CAAA,KAAK,CAAC,CAAG,EAAA;AAC9C,QAAM,GAAA,GAAA,KAAA,CAAA;AAAA,OACV;AAAA,KACH,CAAA,CAAA;AACD,IAAO,OAAA,GAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,IAAW,SAAsD,GAAA;AAC7D,IAAA,OAAO,IAAK,CAAA,UAAA,CAAA;AAAA,GAChB;AAAA,EAGA,IAAW,WAAkC,GAAA;AACzC,IAAA,OAAO,IAAK,CAAA,YAAA,CAAA;AAAA,GAChB;AACJ","file":"Label.js","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 { getLabelById } from \"../decorators\"\nimport { 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>[] | (() => 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. This variable is used in the system to get the label by id, {@link getLabelById}\n     */\n    public get id(): LabelIdType {\n        return this._id\n    }\n\n    private _steps: StepLabelType<T>[] | (() => 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        if (typeof this._steps === \"function\") {\n            return this._steps()\n        }\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"]}
+{"version":3,"sources":["../../src/functions/StepLabelUtility.ts","../../src/classes/LabelAbstract.ts","../../src/classes/Label.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAmBO,SAAS,mBAAA,CAAoB,OAAiD,KAA0D,EAAA;AAC3I,EAAA,OAAO,KAAU,KAAA,KAAA,CAAA;AACrB,CAAA;;;ACdA,IAA8B,gBAA9B,MAA4E;AAAA;AAAA;AAAA;AAAA;AAAA,EAKxE,WAAA,CAAY,IAAiB,KAA4B,EAAA;AACrD,IAAA,IAAA,CAAK,GAAM,GAAA,EAAA,CAAA;AACX,IAAA,IAAA,CAAK,eAAe,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,WAAA,CAAA;AAC3B,IAAA,IAAA,CAAK,cAAc,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,UAAA,CAAA;AAC1B,IAAA,IAAA,CAAK,aAAa,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,SAAA,CAAA;AACzB,IAAA,IAAA,CAAK,eAAe,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,WAAA,CAAA;AAAA,GAC/B;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,EAAkB,GAAA;AACzB,IAAA,OAAO,IAAK,CAAA,GAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYU,4BAA4B,aAAgE,EAAA;AAClG,IAAI,IAAA,aAAA,CAAc,WAAW,CAAG,EAAA;AAC5B,MAAO,OAAA,CAAA,CAAA;AAAA,KACX;AACA,IAAA,IAAI,GAAc,GAAA,CAAA,CAAA;AAClB,IAAc,aAAA,CAAA,OAAA,CAAQ,CAAC,IAAA,EAAM,KAAU,KAAA;AACnC,MAAA,IAAI,oBAAoB,IAAM,EAAA,IAAA,CAAK,KAAM,CAAA,KAAK,CAAC,CAAG,EAAA;AAC9C,QAAM,GAAA,GAAA,KAAA,CAAA;AAAA,OACV;AAAA,KACH,CAAA,CAAA;AACD,IAAO,OAAA,GAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,WAAwF,GAAA;AAC/F,IAAO,OAAA,CAAO,WAAmB,KAAkB,KAAA,OAAA,CAAA,IAAA,EAAA,IAAA,EAAA,aAAA;AAC/C,MAAA,IAAI,KAAK,WAAa,EAAA;AAClB,QAAM,MAAA,IAAA,CAAK,WAAY,CAAA,SAAA,EAAW,KAAK,CAAA,CAAA;AAAA,OAC3C;AACA,MAAA,IAAI,KAAK,YAAc,EAAA;AACnB,QAAA,OAAO,MAAM,IAAA,CAAK,YAAa,CAAA,SAAA,EAAW,KAAK,CAAA,CAAA;AAAA,OACnD;AAAA,KACJ,CAAA,CAAA;AAAA,GACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,UAAuF,GAAA;AAC9F,IAAA,OAAO,IAAK,CAAA,WAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,SAAsF,GAAA;AAC7F,IAAA,OAAO,IAAK,CAAA,UAAA,CAAA;AAAA,GAChB;AAAA,EAGA,IAAW,WAAkC,GAAA;AACzC,IAAA,OAAO,IAAK,CAAA,YAAA,CAAA;AAAA,GAChB;AACJ,CAAA,CAAA;;;AC5DqB,IAAA,KAAA,GAArB,cAAsD,aAA2B,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM7E,WAAA,CAAY,EAAiB,EAAA,KAAA,EAAwD,KAA8B,EAAA;AAC/G,IAAA,KAAA,CAAM,IAAI,KAAK,CAAA,CAAA;AACf,IAAA,IAAA,CAAK,MAAS,GAAA,KAAA,CAAA;AAAA,GAClB;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,KAA4B,GAAA;AACnC,IAAI,IAAA,OAAO,IAAK,CAAA,MAAA,KAAW,UAAY,EAAA;AACnC,MAAA,OAAO,KAAK,MAAO,EAAA,CAAA;AAAA,KACvB;AACA,IAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AAAA,GAChB;AACJ","file":"Label.js","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 { getLabelById } from \"../decorators\"\nimport { checkIfStepsIsEqual } from \"../functions/StepLabelUtility\"\nimport { LabelProps } from \"../interface\"\nimport { LabelIdType } from \"../types/LabelIdType\"\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\"\nimport { StepLabelType } from \"../types/StepLabelType\"\n\nexport default abstract class LabelAbstract<TLabel, TProps extends {} = {}> {\n    /**\n     * @param id is the id of the label\n     * @param props is the properties of the label\n     */\n    constructor(id: LabelIdType, props?: LabelProps<TLabel>) {\n        this._id = id\n        this._onStepStart = props?.onStepStart\n        this._onLoadStep = props?.onLoadStep\n        this._onStepEnd = props?.onStepEnd\n        this._choiseIndex = props?.choiseIndex\n    }\n\n    private _id: LabelIdType\n    /**\n     * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}\n     */\n    public get id(): LabelIdType {\n        return this._id\n    }\n\n    /**\n     * Get the steps of the label.\n     */\n    public abstract get steps(): StepLabelType<TProps>[]\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    protected 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 _onStepStart: ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined\n    /**\n     * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.\n     * @returns Promise<void> or void\n     */\n    public get onStepStart(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined {\n        return async (stepIndex: number, label: TLabel) => {\n            if (this._onLoadStep) {\n                await this._onLoadStep(stepIndex, label)\n            }\n            if (this._onStepStart) {\n                return await this._onStepStart(stepIndex, label)\n            }\n        }\n    }\n\n    private _onLoadStep: ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined\n    /**\n     * Get the function that will be executed a old step is reloaded. A step is reloaded when the user goes back to it or when the user laods a save file.\n     * @returns Promise<void> or void\n     */\n    public get onLoadStep(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined {\n        return this._onLoadStep\n    }\n\n    private _onStepEnd: ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined\n    /**\n     * Is a function that will be executed when the step ends.\n     * @returns Promise<void> or void\n     */\n    public get onStepEnd(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined {\n        return this._onStepEnd\n    }\n\n    private _choiseIndex: number | undefined\n    public get choiseIndex(): number | undefined {\n        return this._choiseIndex\n    }\n}\n","import { LabelProps } from \"../interface\"\nimport { LabelIdType } from \"../types/LabelIdType\"\nimport { StepLabelType } from \"../types/StepLabelType\"\nimport LabelAbstract from \"./LabelAbstract\"\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 {} = {}> extends LabelAbstract<Label<T>, T> {\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 props is the properties of the label\n     */\n    constructor(id: LabelIdType, steps: StepLabelType<T>[] | (() => StepLabelType<T>[]), props?: LabelProps<Label<T>>) {\n        super(id, props)\n        this._steps = steps\n    }\n\n    private _steps: StepLabelType<T>[] | (() => StepLabelType<T>[])\n    /**\n     * Get the steps of the label.\n     */\n    public get steps(): StepLabelType<T>[] {\n        if (typeof this._steps === \"function\") {\n            return this._steps()\n        }\n        return this._steps\n    }\n}\n"]}

package/dist/classes/Label.mjs

@@ -1,23 +1,41 @@
 import 'crypto-js/sha1';
 
-// src/functions/StepLabelUtility.ts
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
 function checkIfStepsIsEqual(step1, step2) {
   return step1 === step2;
 }
 
-// src/classes/Label.ts
-var Label = class {
+// src/classes/LabelAbstract.ts
+var LabelAbstract = 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
+   * @param props is the properties of the label
    */
-  constructor(id, steps, onStepRun, choiseIndex) {
+  constructor(id, props) {
     this._id = id;
-    this._steps = steps;
-    this._onStepRun = onStepRun;
-    this._choiseIndex = choiseIndex;
+    this._onStepStart = props == null ? void 0 : props.onStepStart;
+    this._onLoadStep = props == null ? void 0 : props.onLoadStep;
+    this._onStepEnd = props == null ? void 0 : props.onStepEnd;
+    this._choiseIndex = props == null ? void 0 : props.choiseIndex;
   }
   /**
    * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}
@@ -25,17 +43,6 @@ var Label = class {
   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() {
-    if (typeof this._steps === "function") {
-      return this._steps();
-    }
-    return this._steps;
-  }
   /**
    * Get the corresponding steps number
    * @param externalSteps
@@ -54,24 +61,60 @@ 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
+   * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.
+   * @returns Promise<void> or void
+   */
+  get onStepStart() {
+    return (stepIndex, label) => __async(this, null, function* () {
+      if (this._onLoadStep) {
+        yield this._onLoadStep(stepIndex, label);
+      }
+      if (this._onStepStart) {
+        return yield this._onStepStart(stepIndex, label);
+      }
+    });
+  }
+  /**
+   * Get the function that will be executed a old step is reloaded. A step is reloaded when the user goes back to it or when the user laods a save file.
    * @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 onLoadStep() {
+    return this._onLoadStep;
+  }
+  /**
+   * Is a function that will be executed when the step ends.
+   * @returns Promise<void> or void
+   */
+  get onStepEnd() {
+    return this._onStepEnd;
   }
   get choiseIndex() {
     return this._choiseIndex;
   }
 };
 
+// src/classes/Label.ts
+var Label = class extends LabelAbstract {
+  /**
+   * @param id is the id of the label
+   * @param steps is the list of steps that the label will perform
+   * @param props is the properties of the label
+   */
+  constructor(id, steps, props) {
+    super(id, props);
+    this._steps = steps;
+  }
+  /**
+   * Get the steps of the label.
+   */
+  get steps() {
+    if (typeof this._steps === "function") {
+      return this._steps();
+    }
+    return this._steps;
+  }
+};
+
 export { Label as default };
 //# sourceMappingURL=Label.mjs.map
 //# sourceMappingURL=Label.mjs.map

package/dist/classes/Label.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/functions/StepLabelUtility.ts","../../src/classes/Label.ts"],"names":[],"mappings":";;;AAmBO,SAAS,mBAAA,CAAoB,OAAiD,KAA0D,EAAA;AAC3I,EAAA,OAAO,KAAU,KAAA,KAAA,CAAA;AACrB,CAAA;;;ACSA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,WAAY,CAAA,EAAA,EAAiB,KAAwD,EAAA,SAAA,EAAwC,WAAsB,EAAA;AAC/I,IAAA,IAAA,CAAK,GAAM,GAAA,EAAA,CAAA;AACX,IAAA,IAAA,CAAK,MAAS,GAAA,KAAA,CAAA;AACd,IAAA,IAAA,CAAK,UAAa,GAAA,SAAA,CAAA;AAClB,IAAA,IAAA,CAAK,YAAe,GAAA,WAAA,CAAA;AAAA,GACxB;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,EAAkB,GAAA;AACzB,IAAA,OAAO,IAAK,CAAA,GAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,IAAW,KAA4B,GAAA;AACnC,IAAI,IAAA,OAAO,IAAK,CAAA,MAAA,KAAW,UAAY,EAAA;AACnC,MAAA,OAAO,KAAK,MAAO,EAAA,CAAA;AAAA,KACvB;AACA,IAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOO,4BAA4B,aAAgE,EAAA;AAC/F,IAAI,IAAA,aAAA,CAAc,WAAW,CAAG,EAAA;AAC5B,MAAO,OAAA,CAAA,CAAA;AAAA,KACX;AACA,IAAA,IAAI,GAAc,GAAA,CAAA,CAAA;AAClB,IAAc,aAAA,CAAA,OAAA,CAAQ,CAAC,IAAA,EAAM,KAAU,KAAA;AACnC,MAAA,IAAI,oBAAoB,IAAM,EAAA,IAAA,CAAK,KAAM,CAAA,KAAK,CAAC,CAAG,EAAA;AAC9C,QAAM,GAAA,GAAA,KAAA,CAAA;AAAA,OACV;AAAA,KACH,CAAA,CAAA;AACD,IAAO,OAAA,GAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,IAAW,SAAsD,GAAA;AAC7D,IAAA,OAAO,IAAK,CAAA,UAAA,CAAA;AAAA,GAChB;AAAA,EAGA,IAAW,WAAkC,GAAA;AACzC,IAAA,OAAO,IAAK,CAAA,YAAA,CAAA;AAAA,GAChB;AACJ","file":"Label.mjs","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 { getLabelById } from \"../decorators\"\nimport { 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>[] | (() => 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. This variable is used in the system to get the label by id, {@link getLabelById}\n     */\n    public get id(): LabelIdType {\n        return this._id\n    }\n\n    private _steps: StepLabelType<T>[] | (() => 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        if (typeof this._steps === \"function\") {\n            return this._steps()\n        }\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"]}
+{"version":3,"sources":["../../src/functions/StepLabelUtility.ts","../../src/classes/LabelAbstract.ts","../../src/classes/Label.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAmBO,SAAS,mBAAA,CAAoB,OAAiD,KAA0D,EAAA;AAC3I,EAAA,OAAO,KAAU,KAAA,KAAA,CAAA;AACrB,CAAA;;;ACdA,IAA8B,gBAA9B,MAA4E;AAAA;AAAA;AAAA;AAAA;AAAA,EAKxE,WAAA,CAAY,IAAiB,KAA4B,EAAA;AACrD,IAAA,IAAA,CAAK,GAAM,GAAA,EAAA,CAAA;AACX,IAAA,IAAA,CAAK,eAAe,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,WAAA,CAAA;AAC3B,IAAA,IAAA,CAAK,cAAc,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,UAAA,CAAA;AAC1B,IAAA,IAAA,CAAK,aAAa,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,SAAA,CAAA;AACzB,IAAA,IAAA,CAAK,eAAe,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,WAAA,CAAA;AAAA,GAC/B;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,EAAkB,GAAA;AACzB,IAAA,OAAO,IAAK,CAAA,GAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYU,4BAA4B,aAAgE,EAAA;AAClG,IAAI,IAAA,aAAA,CAAc,WAAW,CAAG,EAAA;AAC5B,MAAO,OAAA,CAAA,CAAA;AAAA,KACX;AACA,IAAA,IAAI,GAAc,GAAA,CAAA,CAAA;AAClB,IAAc,aAAA,CAAA,OAAA,CAAQ,CAAC,IAAA,EAAM,KAAU,KAAA;AACnC,MAAA,IAAI,oBAAoB,IAAM,EAAA,IAAA,CAAK,KAAM,CAAA,KAAK,CAAC,CAAG,EAAA;AAC9C,QAAM,GAAA,GAAA,KAAA,CAAA;AAAA,OACV;AAAA,KACH,CAAA,CAAA;AACD,IAAO,OAAA,GAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,WAAwF,GAAA;AAC/F,IAAO,OAAA,CAAO,WAAmB,KAAkB,KAAA,OAAA,CAAA,IAAA,EAAA,IAAA,EAAA,aAAA;AAC/C,MAAA,IAAI,KAAK,WAAa,EAAA;AAClB,QAAM,MAAA,IAAA,CAAK,WAAY,CAAA,SAAA,EAAW,KAAK,CAAA,CAAA;AAAA,OAC3C;AACA,MAAA,IAAI,KAAK,YAAc,EAAA;AACnB,QAAA,OAAO,MAAM,IAAA,CAAK,YAAa,CAAA,SAAA,EAAW,KAAK,CAAA,CAAA;AAAA,OACnD;AAAA,KACJ,CAAA,CAAA;AAAA,GACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,UAAuF,GAAA;AAC9F,IAAA,OAAO,IAAK,CAAA,WAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,SAAsF,GAAA;AAC7F,IAAA,OAAO,IAAK,CAAA,UAAA,CAAA;AAAA,GAChB;AAAA,EAGA,IAAW,WAAkC,GAAA;AACzC,IAAA,OAAO,IAAK,CAAA,YAAA,CAAA;AAAA,GAChB;AACJ,CAAA,CAAA;;;AC5DqB,IAAA,KAAA,GAArB,cAAsD,aAA2B,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM7E,WAAA,CAAY,EAAiB,EAAA,KAAA,EAAwD,KAA8B,EAAA;AAC/G,IAAA,KAAA,CAAM,IAAI,KAAK,CAAA,CAAA;AACf,IAAA,IAAA,CAAK,MAAS,GAAA,KAAA,CAAA;AAAA,GAClB;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,KAA4B,GAAA;AACnC,IAAI,IAAA,OAAO,IAAK,CAAA,MAAA,KAAW,UAAY,EAAA;AACnC,MAAA,OAAO,KAAK,MAAO,EAAA,CAAA;AAAA,KACvB;AACA,IAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AAAA,GAChB;AACJ","file":"Label.mjs","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 { getLabelById } from \"../decorators\"\nimport { checkIfStepsIsEqual } from \"../functions/StepLabelUtility\"\nimport { LabelProps } from \"../interface\"\nimport { LabelIdType } from \"../types/LabelIdType\"\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\"\nimport { StepLabelType } from \"../types/StepLabelType\"\n\nexport default abstract class LabelAbstract<TLabel, TProps extends {} = {}> {\n    /**\n     * @param id is the id of the label\n     * @param props is the properties of the label\n     */\n    constructor(id: LabelIdType, props?: LabelProps<TLabel>) {\n        this._id = id\n        this._onStepStart = props?.onStepStart\n        this._onLoadStep = props?.onLoadStep\n        this._onStepEnd = props?.onStepEnd\n        this._choiseIndex = props?.choiseIndex\n    }\n\n    private _id: LabelIdType\n    /**\n     * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}\n     */\n    public get id(): LabelIdType {\n        return this._id\n    }\n\n    /**\n     * Get the steps of the label.\n     */\n    public abstract get steps(): StepLabelType<TProps>[]\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    protected 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 _onStepStart: ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined\n    /**\n     * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.\n     * @returns Promise<void> or void\n     */\n    public get onStepStart(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined {\n        return async (stepIndex: number, label: TLabel) => {\n            if (this._onLoadStep) {\n                await this._onLoadStep(stepIndex, label)\n            }\n            if (this._onStepStart) {\n                return await this._onStepStart(stepIndex, label)\n            }\n        }\n    }\n\n    private _onLoadStep: ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined\n    /**\n     * Get the function that will be executed a old step is reloaded. A step is reloaded when the user goes back to it or when the user laods a save file.\n     * @returns Promise<void> or void\n     */\n    public get onLoadStep(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined {\n        return this._onLoadStep\n    }\n\n    private _onStepEnd: ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined\n    /**\n     * Is a function that will be executed when the step ends.\n     * @returns Promise<void> or void\n     */\n    public get onStepEnd(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined {\n        return this._onStepEnd\n    }\n\n    private _choiseIndex: number | undefined\n    public get choiseIndex(): number | undefined {\n        return this._choiseIndex\n    }\n}\n","import { LabelProps } from \"../interface\"\nimport { LabelIdType } from \"../types/LabelIdType\"\nimport { StepLabelType } from \"../types/StepLabelType\"\nimport LabelAbstract from \"./LabelAbstract\"\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 {} = {}> extends LabelAbstract<Label<T>, T> {\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 props is the properties of the label\n     */\n    constructor(id: LabelIdType, steps: StepLabelType<T>[] | (() => StepLabelType<T>[]), props?: LabelProps<Label<T>>) {\n        super(id, props)\n        this._steps = steps\n    }\n\n    private _steps: StepLabelType<T>[] | (() => StepLabelType<T>[])\n    /**\n     * Get the steps of the label.\n     */\n    public get steps(): StepLabelType<T>[] {\n        if (typeof this._steps === \"function\") {\n            return this._steps()\n        }\n        return this._steps\n    }\n}\n"]}

package/dist/classes/LabelAbstract.d.mts

@@ -0,0 +1,50 @@
+import { LabelIdType } from '../types/LabelIdType.mjs';
+import { StepLabelType } from '../types/StepLabelType.mjs';
+import { StepHistoryDataType } from '../types/StepHistoryDataType.mjs';
+import LabelProps from '../interface/LabelProps.mjs';
+import '@drincs/pixi-vn/dist/override';
+
+declare abstract class LabelAbstract<TLabel, TProps extends {} = {}> {
+    /**
+     * @param id is the id of the label
+     * @param props is the properties of the label
+     */
+    constructor(id: LabelIdType, props?: LabelProps<TLabel>);
+    private _id;
+    /**
+     * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}
+     */
+    get id(): LabelIdType;
+    /**
+     * Get the steps of the label.
+     */
+    abstract get steps(): StepLabelType<TProps>[];
+    /**
+     * Get the corresponding steps number
+     * @param externalSteps
+     * @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
+     */
+    protected getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number;
+    private _onStepStart;
+    /**
+     * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.
+     * @returns Promise<void> or void
+     */
+    get onStepStart(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined;
+    private _onLoadStep;
+    /**
+     * Get the function that will be executed a old step is reloaded. A step is reloaded when the user goes back to it or when the user laods a save file.
+     * @returns Promise<void> or void
+     */
+    get onLoadStep(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined;
+    private _onStepEnd;
+    /**
+     * Is a function that will be executed when the step ends.
+     * @returns Promise<void> or void
+     */
+    get onStepEnd(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined;
+    private _choiseIndex;
+    get choiseIndex(): number | undefined;
+}
+
+export { LabelAbstract as default };

package/dist/classes/LabelAbstract.d.ts

@@ -0,0 +1,50 @@
+import { LabelIdType } from '../types/LabelIdType.js';
+import { StepLabelType } from '../types/StepLabelType.js';
+import { StepHistoryDataType } from '../types/StepHistoryDataType.js';
+import LabelProps from '../interface/LabelProps.js';
+import '@drincs/pixi-vn/dist/override';
+
+declare abstract class LabelAbstract<TLabel, TProps extends {} = {}> {
+    /**
+     * @param id is the id of the label
+     * @param props is the properties of the label
+     */
+    constructor(id: LabelIdType, props?: LabelProps<TLabel>);
+    private _id;
+    /**
+     * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}
+     */
+    get id(): LabelIdType;
+    /**
+     * Get the steps of the label.
+     */
+    abstract get steps(): StepLabelType<TProps>[];
+    /**
+     * Get the corresponding steps number
+     * @param externalSteps
+     * @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
+     */
+    protected getCorrespondingStepsNumber(externalSteps: StepHistoryDataType[] | StepLabelType[]): number;
+    private _onStepStart;
+    /**
+     * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.
+     * @returns Promise<void> or void
+     */
+    get onStepStart(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined;
+    private _onLoadStep;
+    /**
+     * Get the function that will be executed a old step is reloaded. A step is reloaded when the user goes back to it or when the user laods a save file.
+     * @returns Promise<void> or void
+     */
+    get onLoadStep(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined;
+    private _onStepEnd;
+    /**
+     * Is a function that will be executed when the step ends.
+     * @returns Promise<void> or void
+     */
+    get onStepEnd(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined;
+    private _choiseIndex;
+    get choiseIndex(): number | undefined;
+}
+
+export { LabelAbstract as default };

package/dist/classes/LabelAbstract.js

@@ -0,0 +1,100 @@
+'use strict';
+
+require('crypto-js/sha1');
+
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+function checkIfStepsIsEqual(step1, step2) {
+  return step1 === step2;
+}
+
+// src/classes/LabelAbstract.ts
+var LabelAbstract = class {
+  /**
+   * @param id is the id of the label
+   * @param props is the properties of the label
+   */
+  constructor(id, props) {
+    this._id = id;
+    this._onStepStart = props == null ? void 0 : props.onStepStart;
+    this._onLoadStep = props == null ? void 0 : props.onLoadStep;
+    this._onStepEnd = props == null ? void 0 : props.onStepEnd;
+    this._choiseIndex = props == null ? void 0 : props.choiseIndex;
+  }
+  /**
+   * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}
+   */
+  get id() {
+    return this._id;
+  }
+  /**
+   * Get the corresponding steps number
+   * @param externalSteps
+   * @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) {
+    if (externalSteps.length === 0) {
+      return 0;
+    }
+    let res = 0;
+    externalSteps.forEach((step, index) => {
+      if (checkIfStepsIsEqual(step, this.steps[index])) {
+        res = index;
+      }
+    });
+    return res;
+  }
+  /**
+   * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.
+   * @returns Promise<void> or void
+   */
+  get onStepStart() {
+    return (stepIndex, label) => __async(this, null, function* () {
+      if (this._onLoadStep) {
+        yield this._onLoadStep(stepIndex, label);
+      }
+      if (this._onStepStart) {
+        return yield this._onStepStart(stepIndex, label);
+      }
+    });
+  }
+  /**
+   * Get the function that will be executed a old step is reloaded. A step is reloaded when the user goes back to it or when the user laods a save file.
+   * @returns Promise<void> or void
+   */
+  get onLoadStep() {
+    return this._onLoadStep;
+  }
+  /**
+   * Is a function that will be executed when the step ends.
+   * @returns Promise<void> or void
+   */
+  get onStepEnd() {
+    return this._onStepEnd;
+  }
+  get choiseIndex() {
+    return this._choiseIndex;
+  }
+};
+
+module.exports = LabelAbstract;
+//# sourceMappingURL=LabelAbstract.js.map
+//# sourceMappingURL=LabelAbstract.js.map

package/dist/classes/LabelAbstract.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/functions/StepLabelUtility.ts","../../src/classes/LabelAbstract.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAmBO,SAAS,mBAAA,CAAoB,OAAiD,KAA0D,EAAA;AAC3I,EAAA,OAAO,KAAU,KAAA,KAAA,CAAA;AACrB,CAAA;;;ACdA,IAA8B,gBAA9B,MAA4E;AAAA;AAAA;AAAA;AAAA;AAAA,EAKxE,WAAA,CAAY,IAAiB,KAA4B,EAAA;AACrD,IAAA,IAAA,CAAK,GAAM,GAAA,EAAA,CAAA;AACX,IAAA,IAAA,CAAK,eAAe,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,WAAA,CAAA;AAC3B,IAAA,IAAA,CAAK,cAAc,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,UAAA,CAAA;AAC1B,IAAA,IAAA,CAAK,aAAa,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,SAAA,CAAA;AACzB,IAAA,IAAA,CAAK,eAAe,KAAO,IAAA,IAAA,GAAA,KAAA,CAAA,GAAA,KAAA,CAAA,WAAA,CAAA;AAAA,GAC/B;AAAA;AAAA;AAAA;AAAA,EAMA,IAAW,EAAkB,GAAA;AACzB,IAAA,OAAO,IAAK,CAAA,GAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYU,4BAA4B,aAAgE,EAAA;AAClG,IAAI,IAAA,aAAA,CAAc,WAAW,CAAG,EAAA;AAC5B,MAAO,OAAA,CAAA,CAAA;AAAA,KACX;AACA,IAAA,IAAI,GAAc,GAAA,CAAA,CAAA;AAClB,IAAc,aAAA,CAAA,OAAA,CAAQ,CAAC,IAAA,EAAM,KAAU,KAAA;AACnC,MAAA,IAAI,oBAAoB,IAAM,EAAA,IAAA,CAAK,KAAM,CAAA,KAAK,CAAC,CAAG,EAAA;AAC9C,QAAM,GAAA,GAAA,KAAA,CAAA;AAAA,OACV;AAAA,KACH,CAAA,CAAA;AACD,IAAO,OAAA,GAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,WAAwF,GAAA;AAC/F,IAAO,OAAA,CAAO,WAAmB,KAAkB,KAAA,OAAA,CAAA,IAAA,EAAA,IAAA,EAAA,aAAA;AAC/C,MAAA,IAAI,KAAK,WAAa,EAAA;AAClB,QAAM,MAAA,IAAA,CAAK,WAAY,CAAA,SAAA,EAAW,KAAK,CAAA,CAAA;AAAA,OAC3C;AACA,MAAA,IAAI,KAAK,YAAc,EAAA;AACnB,QAAA,OAAO,MAAM,IAAA,CAAK,YAAa,CAAA,SAAA,EAAW,KAAK,CAAA,CAAA;AAAA,OACnD;AAAA,KACJ,CAAA,CAAA;AAAA,GACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,UAAuF,GAAA;AAC9F,IAAA,OAAO,IAAK,CAAA,WAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,IAAW,SAAsF,GAAA;AAC7F,IAAA,OAAO,IAAK,CAAA,UAAA,CAAA;AAAA,GAChB;AAAA,EAGA,IAAW,WAAkC,GAAA;AACzC,IAAA,OAAO,IAAK,CAAA,YAAA,CAAA;AAAA,GAChB;AACJ","file":"LabelAbstract.js","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 { getLabelById } from \"../decorators\"\nimport { checkIfStepsIsEqual } from \"../functions/StepLabelUtility\"\nimport { LabelProps } from \"../interface\"\nimport { LabelIdType } from \"../types/LabelIdType\"\nimport { StepHistoryDataType } from \"../types/StepHistoryDataType\"\nimport { StepLabelType } from \"../types/StepLabelType\"\n\nexport default abstract class LabelAbstract<TLabel, TProps extends {} = {}> {\n    /**\n     * @param id is the id of the label\n     * @param props is the properties of the label\n     */\n    constructor(id: LabelIdType, props?: LabelProps<TLabel>) {\n        this._id = id\n        this._onStepStart = props?.onStepStart\n        this._onLoadStep = props?.onLoadStep\n        this._onStepEnd = props?.onStepEnd\n        this._choiseIndex = props?.choiseIndex\n    }\n\n    private _id: LabelIdType\n    /**\n     * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}\n     */\n    public get id(): LabelIdType {\n        return this._id\n    }\n\n    /**\n     * Get the steps of the label.\n     */\n    public abstract get steps(): StepLabelType<TProps>[]\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    protected 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 _onStepStart: ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined\n    /**\n     * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.\n     * @returns Promise<void> or void\n     */\n    public get onStepStart(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined {\n        return async (stepIndex: number, label: TLabel) => {\n            if (this._onLoadStep) {\n                await this._onLoadStep(stepIndex, label)\n            }\n            if (this._onStepStart) {\n                return await this._onStepStart(stepIndex, label)\n            }\n        }\n    }\n\n    private _onLoadStep: ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined\n    /**\n     * Get the function that will be executed a old step is reloaded. A step is reloaded when the user goes back to it or when the user laods a save file.\n     * @returns Promise<void> or void\n     */\n    public get onLoadStep(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined {\n        return this._onLoadStep\n    }\n\n    private _onStepEnd: ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined\n    /**\n     * Is a function that will be executed when the step ends.\n     * @returns Promise<void> or void\n     */\n    public get onStepEnd(): ((stepIndex: number, label: TLabel) => void | Promise<void>) | undefined {\n        return this._onStepEnd\n    }\n\n    private _choiseIndex: number | undefined\n    public get choiseIndex(): number | undefined {\n        return this._choiseIndex\n    }\n}\n"]}