@drincs/pixi-vn 0.5.7 → 0.5.9

package/dist/managers/StepManager.d.mts

@@ -176,7 +176,7 @@ declare class GameStepManager {
      * })
      * ```
      */
-    static closeChoiceMenu<T extends {}>(props: StepLabelPropsType<T>): Promise<StepLabelResultType>;
+    static closeChoiceMenu<T extends {}>(label: Label<T>, props: StepLabelPropsType<T>): Promise<StepLabelResultType>;
     /**
      * Go back to the last step and add it to the history.
      * @param navigate The navigate function.

package/dist/managers/StepManager.d.ts

@@ -176,7 +176,7 @@ declare class GameStepManager {
      * })
      * ```
      */
-    static closeChoiceMenu<T extends {}>(props: StepLabelPropsType<T>): Promise<StepLabelResultType>;
+    static closeChoiceMenu<T extends {}>(label: Label<T>, props: StepLabelPropsType<T>): Promise<StepLabelResultType>;
     /**
      * Go back to the last step and add it to the history.
      * @param navigate The navigate function.

package/dist/managers/StepManager.js

@@ -61,9 +61,79 @@ function getStepSha1(step) {
   let sha1String = sha1__default.default(step.toString().toLocaleLowerCase());
   return sha1String.toString();
 }
+function checkIfStepsIsEqual(step1, step2) {
+  return step1 === step2;
+}
+
+// src/classes/Label.ts
+var Label = class {
+  /**
+   * @param id is the id of the label
+   * @param steps is the list of steps that the label will perform
+   * @param onStepRun is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached
+   * @param choiseIndex is the index of the choice that the label will perform
+   */
+  constructor(id, steps, onStepRun, choiseIndex) {
+    this._id = id;
+    this._steps = steps;
+    this._onStepRun = onStepRun;
+    this._choiseIndex = choiseIndex;
+  }
+  /**
+   * Get the id of the label
+   */
+  get id() {
+    return this._id;
+  }
+  /**
+   * Get the steps of the label.
+   * This class should be extended and the steps method should be overridden.
+   * Every time you update this list will also be updated when the other game versions load.
+   */
+  get steps() {
+    return this._steps;
+  }
+  /**
+   * 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;
+  }
+  /**
+   * Get the function that will be executed before any step is executed, is useful for example to make sure all images used have been cached
+   * @returns Promise<void> or void
+   * @example
+   * ```typescript
+   * newLabel("id", [], () => {
+   *     Assets.load('path/to/image1.png')
+   *     Assets.load('path/to/image2.png')
+   * })
+   * ```
+   */
+  get onStepRun() {
+    return this._onStepRun;
+  }
+  get choiseIndex() {
+    return this._choiseIndex;
+  }
+};
 
 // src/classes/CloseLabel.ts
 var CLOSE_LABEL_ID = "__close-label-id__";
+function newCloseLabel(choiseIndex) {
+  return new Label(CLOSE_LABEL_ID, [], void 0, choiseIndex);
+}
 
 // src/functions/ExportUtility.ts
 function createExportableElement(element) {
@@ -1709,8 +1779,8 @@ var _GameStepManager = class _GameStepManager {
   static runCurrentStep(props, choiseMade) {
     return __async(this, null, function* () {
       if (_GameStepManager.currentLabelId) {
-        let lasteStepsLength = _GameStepManager.currentLabelStepIndex;
-        if (lasteStepsLength === null) {
+        let lastStepsLength = _GameStepManager.currentLabelStepIndex;
+        if (lastStepsLength === null) {
           console.error("[Pixi'VN] currentLabelStepIndex is null");
           return;
         }
@@ -1720,12 +1790,12 @@ var _GameStepManager = class _GameStepManager {
           return;
         }
         let n = currentLabel.steps.length;
-        if (n > lasteStepsLength) {
-          let nextStep = currentLabel.steps[lasteStepsLength];
-          let result = yield nextStep(props);
-          _GameStepManager.addStepHistory(nextStep, choiseMade);
+        if (n > lastStepsLength) {
+          let step = currentLabel.steps[lastStepsLength];
+          let result = yield step(props);
+          _GameStepManager.addStepHistory(step, choiseMade);
           return result;
-        } else if (n === lasteStepsLength) {
+        } else if (n === lastStepsLength) {
           _GameStepManager.closeCurrentLabel();
           return yield _GameStepManager.runNextStep(props);
         } else {
@@ -1770,7 +1840,8 @@ var _GameStepManager = class _GameStepManager {
       }
       try {
         if (labelId === CLOSE_LABEL_ID) {
-          return _GameStepManager.runNextStep(props);
+          let closeLabel = newCloseLabel(choiseMade);
+          return _GameStepManager.closeChoiceMenu(closeLabel, props);
         }
         let tempLabel = getLabelById(labelId);
         if (!tempLabel) {
@@ -1809,18 +1880,20 @@ var _GameStepManager = class _GameStepManager {
   static jumpLabel(label, props) {
     return __async(this, null, function* () {
       _GameStepManager.closeAllLabels();
+      let choiseMade = void 0;
       let labelId;
       if (typeof label === "string") {
         labelId = label;
       } else {
         labelId = label.id;
         if (typeof label.choiseIndex === "number") {
-          label.choiseIndex;
+          choiseMade = label.choiseIndex;
         }
       }
       try {
         if (labelId === CLOSE_LABEL_ID) {
-          return _GameStepManager.runNextStep(props);
+          let closeLabel = newCloseLabel(choiseMade);
+          return _GameStepManager.closeChoiceMenu(closeLabel, props);
         }
         let tempLabel = getLabelById(labelId);
         if (!tempLabel) {
@@ -1831,7 +1904,7 @@ var _GameStepManager = class _GameStepManager {
         console.error("[Pixi'VN] Error jumping label", e);
         return;
       }
-      return yield _GameStepManager.runCurrentStep(props);
+      return yield _GameStepManager.runCurrentStep(props, choiseMade);
     });
   }
   /**
@@ -1847,8 +1920,14 @@ var _GameStepManager = class _GameStepManager {
    * })
    * ```
    */
-  static closeChoiceMenu(props) {
+  static closeChoiceMenu(label, props) {
     return __async(this, null, function* () {
+      let choiseMade = void 0;
+      if (typeof label.choiseIndex === "number") {
+        choiseMade = label.choiseIndex;
+      }
+      _GameStepManager.addStepHistory(() => {
+      }, choiseMade);
       return _GameStepManager.runNextStep(props);
     });
   }