@drincs/pixi-vn 0.6.0 → 0.6.2

package/dist/classes/CloseLabel.d.mts

@@ -8,6 +8,6 @@ declare const CLOSE_LABEL_ID = "__close-label-id__";
 /**
  * CloseLabel is a label used for closing the menu.
  */
-declare function newCloseLabel(choiseIndex?: number): Label<{}>;
+declare function newCloseLabel<T extends {} = {}>(choiseIndex?: number): Label<T>;
 
 export { CLOSE_LABEL_ID, newCloseLabel as default };

package/dist/classes/CloseLabel.d.ts

@@ -8,6 +8,6 @@ declare const CLOSE_LABEL_ID = "__close-label-id__";
 /**
  * CloseLabel is a label used for closing the menu.
  */
-declare function newCloseLabel(choiseIndex?: number): Label<{}>;
+declare function newCloseLabel<T extends {} = {}>(choiseIndex?: number): Label<T>;
 
 export { CLOSE_LABEL_ID, newCloseLabel as default };

package/dist/classes/CloseLabel.js

@@ -24,7 +24,7 @@ var Label = class {
     this._choiseIndex = choiseIndex;
   }
   /**
-   * Get the id of the label
+   * 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;

package/dist/classes/CloseLabel.js.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;;;ACQA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,YAAY,IAAiB,OAAwD,WAAwC,aAAsB;AAC/I,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,QAAI,OAAO,KAAK,WAAW,YAAY;AACnC,aAAO,KAAK,OAAO;AAAA,IACvB;AACA,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;;;ACpGO,IAAM,iBAAiB;AAKf,SAAR,cAA+B,aAAsB;AAAE,SAAO,IAAI,MAAM,gBAAgB,CAAC,GAAG,QAAW,WAAW;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 { 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\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","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 function newCloseLabel(choiseIndex?: number) { return new Label(CLOSE_LABEL_ID, [], undefined, choiseIndex) }\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;;;ACSA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,YAAY,IAAiB,OAAwD,WAAwC,aAAsB;AAC/I,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,QAAI,OAAO,KAAK,WAAW,YAAY;AACnC,aAAO,KAAK,OAAO;AAAA,IACvB;AACA,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;;;ACrGO,IAAM,iBAAiB;AAKf,SAAR,cAAkD,aAAsB;AAAE,SAAO,IAAI,MAAS,gBAAgB,CAAC,GAAG,QAAW,WAAW;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 { 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","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 function newCloseLabel<T extends {} = {}>(choiseIndex?: number) { return new Label<T>(CLOSE_LABEL_ID, [], undefined, choiseIndex) }\n"]}

package/dist/classes/CloseLabel.mjs

@@ -20,7 +20,7 @@ var Label = class {
     this._choiseIndex = choiseIndex;
   }
   /**
-   * Get the id of the label
+   * 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;

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;;;ACQA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,YAAY,IAAiB,OAAwD,WAAwC,aAAsB;AAC/I,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,QAAI,OAAO,KAAK,WAAW,YAAY;AACnC,aAAO,KAAK,OAAO;AAAA,IACvB;AACA,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;;;ACpGO,IAAM,iBAAiB;AAKf,SAAR,cAA+B,aAAsB;AAAE,SAAO,IAAI,MAAM,gBAAgB,CAAC,GAAG,QAAW,WAAW;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 { 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\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","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 function newCloseLabel(choiseIndex?: number) { return new Label(CLOSE_LABEL_ID, [], undefined, choiseIndex) }\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;;;ACSA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,YAAY,IAAiB,OAAwD,WAAwC,aAAsB;AAC/I,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,QAAI,OAAO,KAAK,WAAW,YAAY;AACnC,aAAO,KAAK,OAAO;AAAA,IACvB;AACA,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;;;ACrGO,IAAM,iBAAiB;AAKf,SAAR,cAAkD,aAAsB;AAAE,SAAO,IAAI,MAAS,gBAAgB,CAAC,GAAG,QAAW,WAAW;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 { 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","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 function newCloseLabel<T extends {} = {}>(choiseIndex?: number) { return new Label<T>(CLOSE_LABEL_ID, [], undefined, choiseIndex) }\n"]}

package/dist/classes/DialogueBaseModel.d.mts

@@ -1,5 +1,6 @@
 import CharacterBaseModel from './CharacterBaseModel.mjs';
 import { StorageElementType } from '../types/StorageElementType.mjs';
+import '../interface/CharacterBaseModelProps.mjs';
 import './StoredClassModel.mjs';
 
 type DialogueData = {
@@ -10,7 +11,7 @@ type DialogueData = {
     /**
      * The id of the character that is speaking.
      */
-    characterId?: string;
+    character?: string;
     /**
      * Other parameters that can be stored in the dialogue.
      */
@@ -40,7 +41,7 @@ declare class DialogueBaseModel<TCharacter extends CharacterBaseModel = Characte
     /**
      * The id of the character that is speaking.
      */
-    characterId?: string;
+    character?: string;
     /**
      * Other parameters that can be stored in the dialogue.
      */

package/dist/classes/DialogueBaseModel.d.ts

@@ -1,5 +1,6 @@
 import CharacterBaseModel from './CharacterBaseModel.js';
 import { StorageElementType } from '../types/StorageElementType.js';
+import '../interface/CharacterBaseModelProps.js';
 import './StoredClassModel.js';
 
 type DialogueData = {
@@ -10,7 +11,7 @@ type DialogueData = {
     /**
      * The id of the character that is speaking.
      */
-    characterId?: string;
+    character?: string;
     /**
      * Other parameters that can be stored in the dialogue.
      */
@@ -40,7 +41,7 @@ declare class DialogueBaseModel<TCharacter extends CharacterBaseModel = Characte
     /**
      * The id of the character that is speaking.
      */
-    characterId?: string;
+    character?: string;
     /**
      * Other parameters that can be stored in the dialogue.
      */

package/dist/classes/DialogueBaseModel.js

@@ -19,15 +19,15 @@ var DialogueBaseModel = class {
     if (typeof text === "string") {
       this.text = text;
       if (typeof character === "string") {
-        this.characterId = character;
+        this.character = character;
       } else {
-        this.characterId = character == null ? void 0 : character.id;
+        this.character = character == null ? void 0 : character.id;
       }
       this.oltherParams = oltherParams;
     } else {
       this.text = text.text;
-      if (text.characterId) {
-        this.characterId = text.characterId;
+      if (text.character) {
+        this.character = text.character;
       }
       this.oltherParams = text.oltherParams || {};
     }
@@ -40,7 +40,7 @@ var DialogueBaseModel = class {
   export() {
     return {
       text: this.text,
-      characterId: this.characterId,
+      character: this.character,
       oltherParams: this.oltherParams
     };
   }

package/dist/classes/DialogueBaseModel.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/classes/DialogueBaseModel.ts"],"names":[],"mappings":";AA0BA,IAAqB,oBAArB,MAA2H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvH,YAAY,MAA6B,WAAiC,eAAsD,CAAC,GAAG;AAsBpI;AAAA;AAAA;AAAA,gBAAe;AAQf;AAAA;AAAA;AAAA,wBAAsD,CAAC;AA7BnD,QAAI,OAAO,SAAS,UAAU;AAC1B,WAAK,OAAO;AACZ,UAAI,OAAO,cAAc,UAAU;AAC/B,aAAK,cAAc;AAAA,MACvB,OACK;AACD,aAAK,cAAc,uCAAW;AAAA,MAClC;AACA,WAAK,eAAe;AAAA,IACxB,OACK;AACD,WAAK,OAAO,KAAK;AACjB,UAAI,KAAK,aAAa;AAClB,aAAK,cAAc,KAAK;AAAA,MAC5B;AACA,WAAK,eAAe,KAAK,gBAAgB,CAAC;AAAA,IAC9C;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,SAAuB;AACnB,WAAO;AAAA,MACH,MAAM,KAAK;AAAA,MACX,aAAa,KAAK;AAAA,MAClB,cAAc,KAAK;AAAA,IACvB;AAAA,EACJ;AACJ","sourcesContent":["import { StorageElementType } from \"../types\"\nimport CharacterBaseModel from \"./CharacterBaseModel\"\n\nexport type DialogueData = {\n    /**\n     * The text of the dialogue.\n     */\n    text: string\n    /**\n     * The id of the character that is speaking.\n     */\n    characterId?: string\n    /**\n     * Other parameters that can be stored in the dialogue.\n     */\n    oltherParams?: Record<string | number | symbol, StorageElementType>\n}\n\n/**\n * Base class for all dialogue models.\n * You can extend this class, but it is not reccomended. You can use the oltherParams property to store any other data you need.\n * @example\n * ```typescript\n * setDialogue(new DialogueBaseModel(\"Hello World\", character))\n * ```\n */\nexport default class DialogueBaseModel<TCharacter extends CharacterBaseModel = CharacterBaseModel> implements DialogueData {\n    /**\n     * @param text The text of the dialogue.\n     * @param character The id of the character that is speaking. \n     * @param oltherParams Other parameters that can be stored in the dialogue.\n     */\n    constructor(text: string | DialogueData, character?: string | TCharacter, oltherParams: { [key: string]: StorageElementType } = {}) {\n        if (typeof text === \"string\") {\n            this.text = text\n            if (typeof character === \"string\") {\n                this.characterId = character\n            }\n            else {\n                this.characterId = character?.id\n            }\n            this.oltherParams = oltherParams\n        }\n        else {\n            this.text = text.text\n            if (text.characterId) {\n                this.characterId = text.characterId\n            }\n            this.oltherParams = text.oltherParams || {}\n        }\n    }\n    /**\n     * The text of the dialogue.\n     */\n    text: string = \"\"\n    /**\n     * The id of the character that is speaking.\n     */\n    characterId?: string\n    /**\n     * Other parameters that can be stored in the dialogue.\n     */\n    oltherParams: { [key: string]: StorageElementType } = {}\n    /**\n     * Export the dialogue to a DialogueBaseData object.\n     * \n     * @returns The data of the dialogue.\n     */\n    export(): DialogueData {\n        return {\n            text: this.text,\n            characterId: this.characterId,\n            oltherParams: this.oltherParams\n        }\n    }\n}\n"]}
+{"version":3,"sources":["../../src/classes/DialogueBaseModel.ts"],"names":[],"mappings":";AA0BA,IAAqB,oBAArB,MAA2H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvH,YAAY,MAA6B,WAAiC,eAAsD,CAAC,GAAG;AAsBpI;AAAA;AAAA;AAAA,gBAAe;AAQf;AAAA;AAAA;AAAA,wBAAsD,CAAC;AA7BnD,QAAI,OAAO,SAAS,UAAU;AAC1B,WAAK,OAAO;AACZ,UAAI,OAAO,cAAc,UAAU;AAC/B,aAAK,YAAY;AAAA,MACrB,OACK;AACD,aAAK,YAAY,uCAAW;AAAA,MAChC;AACA,WAAK,eAAe;AAAA,IACxB,OACK;AACD,WAAK,OAAO,KAAK;AACjB,UAAI,KAAK,WAAW;AAChB,aAAK,YAAY,KAAK;AAAA,MAC1B;AACA,WAAK,eAAe,KAAK,gBAAgB,CAAC;AAAA,IAC9C;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,SAAuB;AACnB,WAAO;AAAA,MACH,MAAM,KAAK;AAAA,MACX,WAAW,KAAK;AAAA,MAChB,cAAc,KAAK;AAAA,IACvB;AAAA,EACJ;AACJ","sourcesContent":["import { StorageElementType } from \"../types\"\nimport CharacterBaseModel from \"./CharacterBaseModel\"\n\nexport type DialogueData = {\n    /**\n     * The text of the dialogue.\n     */\n    text: string\n    /**\n     * The id of the character that is speaking.\n     */\n    character?: string\n    /**\n     * Other parameters that can be stored in the dialogue.\n     */\n    oltherParams?: Record<string | number | symbol, StorageElementType>\n}\n\n/**\n * Base class for all dialogue models.\n * You can extend this class, but it is not reccomended. You can use the oltherParams property to store any other data you need.\n * @example\n * ```typescript\n * setDialogue(new DialogueBaseModel(\"Hello World\", character))\n * ```\n */\nexport default class DialogueBaseModel<TCharacter extends CharacterBaseModel = CharacterBaseModel> implements DialogueData {\n    /**\n     * @param text The text of the dialogue.\n     * @param character The id of the character that is speaking. \n     * @param oltherParams Other parameters that can be stored in the dialogue.\n     */\n    constructor(text: string | DialogueData, character?: string | TCharacter, oltherParams: { [key: string]: StorageElementType } = {}) {\n        if (typeof text === \"string\") {\n            this.text = text\n            if (typeof character === \"string\") {\n                this.character = character\n            }\n            else {\n                this.character = character?.id\n            }\n            this.oltherParams = oltherParams\n        }\n        else {\n            this.text = text.text\n            if (text.character) {\n                this.character = text.character\n            }\n            this.oltherParams = text.oltherParams || {}\n        }\n    }\n    /**\n     * The text of the dialogue.\n     */\n    text: string = \"\"\n    /**\n     * The id of the character that is speaking.\n     */\n    character?: string\n    /**\n     * Other parameters that can be stored in the dialogue.\n     */\n    oltherParams: { [key: string]: StorageElementType } = {}\n    /**\n     * Export the dialogue to a DialogueBaseData object.\n     * \n     * @returns The data of the dialogue.\n     */\n    export(): DialogueData {\n        return {\n            text: this.text,\n            character: this.character,\n            oltherParams: this.oltherParams\n        }\n    }\n}\n"]}

package/dist/classes/DialogueBaseModel.mjs

@@ -17,15 +17,15 @@ var DialogueBaseModel = class {
     if (typeof text === "string") {
       this.text = text;
       if (typeof character === "string") {
-        this.characterId = character;
+        this.character = character;
       } else {
-        this.characterId = character == null ? void 0 : character.id;
+        this.character = character == null ? void 0 : character.id;
       }
       this.oltherParams = oltherParams;
     } else {
       this.text = text.text;
-      if (text.characterId) {
-        this.characterId = text.characterId;
+      if (text.character) {
+        this.character = text.character;
       }
       this.oltherParams = text.oltherParams || {};
     }
@@ -38,7 +38,7 @@ var DialogueBaseModel = class {
   export() {
     return {
       text: this.text,
-      characterId: this.characterId,
+      character: this.character,
       oltherParams: this.oltherParams
     };
   }

package/dist/classes/DialogueBaseModel.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/classes/DialogueBaseModel.ts"],"names":[],"mappings":";AA0BA,IAAqB,oBAArB,MAA2H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvH,YAAY,MAA6B,WAAiC,eAAsD,CAAC,GAAG;AAsBpI;AAAA;AAAA;AAAA,gBAAe;AAQf;AAAA;AAAA;AAAA,wBAAsD,CAAC;AA7BnD,QAAI,OAAO,SAAS,UAAU;AAC1B,WAAK,OAAO;AACZ,UAAI,OAAO,cAAc,UAAU;AAC/B,aAAK,cAAc;AAAA,MACvB,OACK;AACD,aAAK,cAAc,uCAAW;AAAA,MAClC;AACA,WAAK,eAAe;AAAA,IACxB,OACK;AACD,WAAK,OAAO,KAAK;AACjB,UAAI,KAAK,aAAa;AAClB,aAAK,cAAc,KAAK;AAAA,MAC5B;AACA,WAAK,eAAe,KAAK,gBAAgB,CAAC;AAAA,IAC9C;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,SAAuB;AACnB,WAAO;AAAA,MACH,MAAM,KAAK;AAAA,MACX,aAAa,KAAK;AAAA,MAClB,cAAc,KAAK;AAAA,IACvB;AAAA,EACJ;AACJ","sourcesContent":["import { StorageElementType } from \"../types\"\nimport CharacterBaseModel from \"./CharacterBaseModel\"\n\nexport type DialogueData = {\n    /**\n     * The text of the dialogue.\n     */\n    text: string\n    /**\n     * The id of the character that is speaking.\n     */\n    characterId?: string\n    /**\n     * Other parameters that can be stored in the dialogue.\n     */\n    oltherParams?: Record<string | number | symbol, StorageElementType>\n}\n\n/**\n * Base class for all dialogue models.\n * You can extend this class, but it is not reccomended. You can use the oltherParams property to store any other data you need.\n * @example\n * ```typescript\n * setDialogue(new DialogueBaseModel(\"Hello World\", character))\n * ```\n */\nexport default class DialogueBaseModel<TCharacter extends CharacterBaseModel = CharacterBaseModel> implements DialogueData {\n    /**\n     * @param text The text of the dialogue.\n     * @param character The id of the character that is speaking. \n     * @param oltherParams Other parameters that can be stored in the dialogue.\n     */\n    constructor(text: string | DialogueData, character?: string | TCharacter, oltherParams: { [key: string]: StorageElementType } = {}) {\n        if (typeof text === \"string\") {\n            this.text = text\n            if (typeof character === \"string\") {\n                this.characterId = character\n            }\n            else {\n                this.characterId = character?.id\n            }\n            this.oltherParams = oltherParams\n        }\n        else {\n            this.text = text.text\n            if (text.characterId) {\n                this.characterId = text.characterId\n            }\n            this.oltherParams = text.oltherParams || {}\n        }\n    }\n    /**\n     * The text of the dialogue.\n     */\n    text: string = \"\"\n    /**\n     * The id of the character that is speaking.\n     */\n    characterId?: string\n    /**\n     * Other parameters that can be stored in the dialogue.\n     */\n    oltherParams: { [key: string]: StorageElementType } = {}\n    /**\n     * Export the dialogue to a DialogueBaseData object.\n     * \n     * @returns The data of the dialogue.\n     */\n    export(): DialogueData {\n        return {\n            text: this.text,\n            characterId: this.characterId,\n            oltherParams: this.oltherParams\n        }\n    }\n}\n"]}
+{"version":3,"sources":["../../src/classes/DialogueBaseModel.ts"],"names":[],"mappings":";AA0BA,IAAqB,oBAArB,MAA2H;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMvH,YAAY,MAA6B,WAAiC,eAAsD,CAAC,GAAG;AAsBpI;AAAA;AAAA;AAAA,gBAAe;AAQf;AAAA;AAAA;AAAA,wBAAsD,CAAC;AA7BnD,QAAI,OAAO,SAAS,UAAU;AAC1B,WAAK,OAAO;AACZ,UAAI,OAAO,cAAc,UAAU;AAC/B,aAAK,YAAY;AAAA,MACrB,OACK;AACD,aAAK,YAAY,uCAAW;AAAA,MAChC;AACA,WAAK,eAAe;AAAA,IACxB,OACK;AACD,WAAK,OAAO,KAAK;AACjB,UAAI,KAAK,WAAW;AAChB,aAAK,YAAY,KAAK;AAAA,MAC1B;AACA,WAAK,eAAe,KAAK,gBAAgB,CAAC;AAAA,IAC9C;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAkBA,SAAuB;AACnB,WAAO;AAAA,MACH,MAAM,KAAK;AAAA,MACX,WAAW,KAAK;AAAA,MAChB,cAAc,KAAK;AAAA,IACvB;AAAA,EACJ;AACJ","sourcesContent":["import { StorageElementType } from \"../types\"\nimport CharacterBaseModel from \"./CharacterBaseModel\"\n\nexport type DialogueData = {\n    /**\n     * The text of the dialogue.\n     */\n    text: string\n    /**\n     * The id of the character that is speaking.\n     */\n    character?: string\n    /**\n     * Other parameters that can be stored in the dialogue.\n     */\n    oltherParams?: Record<string | number | symbol, StorageElementType>\n}\n\n/**\n * Base class for all dialogue models.\n * You can extend this class, but it is not reccomended. You can use the oltherParams property to store any other data you need.\n * @example\n * ```typescript\n * setDialogue(new DialogueBaseModel(\"Hello World\", character))\n * ```\n */\nexport default class DialogueBaseModel<TCharacter extends CharacterBaseModel = CharacterBaseModel> implements DialogueData {\n    /**\n     * @param text The text of the dialogue.\n     * @param character The id of the character that is speaking. \n     * @param oltherParams Other parameters that can be stored in the dialogue.\n     */\n    constructor(text: string | DialogueData, character?: string | TCharacter, oltherParams: { [key: string]: StorageElementType } = {}) {\n        if (typeof text === \"string\") {\n            this.text = text\n            if (typeof character === \"string\") {\n                this.character = character\n            }\n            else {\n                this.character = character?.id\n            }\n            this.oltherParams = oltherParams\n        }\n        else {\n            this.text = text.text\n            if (text.character) {\n                this.character = text.character\n            }\n            this.oltherParams = text.oltherParams || {}\n        }\n    }\n    /**\n     * The text of the dialogue.\n     */\n    text: string = \"\"\n    /**\n     * The id of the character that is speaking.\n     */\n    character?: string\n    /**\n     * Other parameters that can be stored in the dialogue.\n     */\n    oltherParams: { [key: string]: StorageElementType } = {}\n    /**\n     * Export the dialogue to a DialogueBaseData object.\n     * \n     * @returns The data of the dialogue.\n     */\n    export(): DialogueData {\n        return {\n            text: this.text,\n            character: this.character,\n            oltherParams: this.oltherParams\n        }\n    }\n}\n"]}

package/dist/classes/Label.d.mts

@@ -37,7 +37,7 @@ declare class Label<T extends {} = {}> {
     constructor(id: LabelIdType, steps: StepLabelType<T>[] | (() => StepLabelType<T>[]), onStepRun?: () => void | Promise<void>, choiseIndex?: number);
     private _id;
     /**
-     * Get the id of the label
+     * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}
      */
     get id(): LabelIdType;
     private _steps;

package/dist/classes/Label.d.ts

@@ -37,7 +37,7 @@ declare class Label<T extends {} = {}> {
     constructor(id: LabelIdType, steps: StepLabelType<T>[] | (() => StepLabelType<T>[]), onStepRun?: () => void | Promise<void>, choiseIndex?: number);
     private _id;
     /**
-     * Get the id of the label
+     * Get the id of the label. This variable is used in the system to get the label by id, {@link getLabelById}
      */
     get id(): LabelIdType;
     private _steps;

package/dist/classes/Label.js

@@ -22,7 +22,7 @@ var Label = class {
     this._choiseIndex = choiseIndex;
   }
   /**
-   * Get the id of the label
+   * 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;

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;;;ACQA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,YAAY,IAAiB,OAAwD,WAAwC,aAAsB;AAC/I,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,QAAI,OAAO,KAAK,WAAW,YAAY;AACnC,aAAO,KAAK,OAAO;AAAA,IACvB;AACA,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>[] | (() => 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>[] | (() => 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/Label.ts"],"names":[],"mappings":";AAAA,OAAO,UAAU;AAmBV,SAAS,oBAAoB,OAAiD,OAA0D;AAC3I,SAAO,UAAU;AACrB;;;ACSA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,YAAY,IAAiB,OAAwD,WAAwC,aAAsB;AAC/I,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,QAAI,OAAO,KAAK,WAAW,YAAY;AACnC,aAAO,KAAK,OAAO;AAAA,IACvB;AACA,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 { 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"]}

package/dist/classes/Label.mjs

@@ -20,7 +20,7 @@ var Label = class {
     this._choiseIndex = choiseIndex;
   }
   /**
-   * Get the id of the label
+   * 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;

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;;;ACQA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,YAAY,IAAiB,OAAwD,WAAwC,aAAsB;AAC/I,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,QAAI,OAAO,KAAK,WAAW,YAAY;AACnC,aAAO,KAAK,OAAO;AAAA,IACvB;AACA,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>[] | (() => 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>[] | (() => 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/Label.ts"],"names":[],"mappings":";AAAA,OAAO,UAAU;AAmBV,SAAS,oBAAoB,OAAiD,OAA0D;AAC3I,SAAO,UAAU;AACrB;;;ACSA,IAAqB,QAArB,MAA8C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1C,YAAY,IAAiB,OAAwD,WAAwC,aAAsB;AAC/I,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,QAAI,OAAO,KAAK,WAAW,YAAY;AACnC,aAAO,KAAK,OAAO;AAAA,IACvB;AACA,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 { 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"]}

package/dist/classes/StoredClassModel.d.mts

@@ -43,13 +43,13 @@ declare class StoredClassModel {
      * @param propertyName The name of the property to set.
      * @param value The value to set. If is undefined, the property will be removed from the storage.
      */
-    setStorageProperty<T>(propertyName: string, value: T | undefined): void;
+    protected setStorageProperty<T>(propertyName: string, value: T | undefined): void;
     /**
      * Get a property from the storage.
      * @param propertyName The name of the property to get.
      * @returns The value of the property. If the property is not found, returns undefined.
      */
-    getStorageProperty<T>(propertyName: string): T | undefined;
+    protected getStorageProperty<T>(propertyName: string): T | undefined;
 }
 
 export { StoredClassModel as default };

package/dist/classes/StoredClassModel.d.ts

@@ -43,13 +43,13 @@ declare class StoredClassModel {
      * @param propertyName The name of the property to set.
      * @param value The value to set. If is undefined, the property will be removed from the storage.
      */
-    setStorageProperty<T>(propertyName: string, value: T | undefined): void;
+    protected setStorageProperty<T>(propertyName: string, value: T | undefined): void;
     /**
      * Get a property from the storage.
      * @param propertyName The name of the property to get.
      * @returns The value of the property. If the property is not found, returns undefined.
      */
-    getStorageProperty<T>(propertyName: string): T | undefined;
+    protected getStorageProperty<T>(propertyName: string): T | undefined;
 }
 
 export { StoredClassModel as default };