@drincs/pixi-vn 0.6.3 → 0.6.5

package/dist/functions/index.mjs

@@ -63,14 +63,15 @@ 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
+   * @param props is the properties of the label
    */
-  constructor(id, steps, onStepRun, choiseIndex) {
+  constructor(id, steps, 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}
@@ -107,18 +108,32 @@ 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
+   */
+  get onLoadStep() {
+    return this._onLoadStep;
+  }
+  /**
+   * Is a function that will be executed when the step ends.
    * @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 onStepEnd() {
+    return this._onStepEnd;
   }
   get choiseIndex() {
     return this._choiseIndex;
@@ -128,7 +143,9 @@ var Label = class {
 // src/classes/CloseLabel.ts
 var CLOSE_LABEL_ID = "__close-label-id__";
 function newCloseLabel(choiseIndex) {
-  return new Label(CLOSE_LABEL_ID, [], void 0, choiseIndex);
+  return new Label(CLOSE_LABEL_ID, [], {
+    choiseIndex
+  });
 }
 
 // src/decorators/LabelDecorator.ts
@@ -310,7 +327,7 @@ var TickerBase = class {
 };
 
 // src/constants.ts
-var PIXIVN_VERSION = "0.6.3";
+var PIXIVN_VERSION = "0.6.5";
 var Repeat = "repeat";
 function Pause(duration) {
   return {
@@ -400,8 +417,6 @@ function getMemoryContainer(element) {
   };
 }
 function setMemoryContainer(element, memory) {
-  memory.width && (element.width = memory.width);
-  memory.height && (element.height = memory.height);
   memory.isRenderGroup && (element.isRenderGroup = memory.isRenderGroup);
   memory.blendMode && (element.blendMode = memory.blendMode);
   memory.tint && (element.tint = memory.tint);
@@ -434,6 +449,8 @@ function setMemoryContainer(element, memory) {
   memory.interactive && (element.interactive = memory.interactive);
   memory.interactiveChildren && (element.interactiveChildren = memory.interactiveChildren);
   memory.hitArea && (element.hitArea = memory.hitArea);
+  memory.width && (element.width = memory.width);
+  memory.height && (element.height = memory.height);
 }
 function getTexture(imageUrl) {
   return __async(this, null, function* () {
@@ -1639,6 +1656,16 @@ var _GameStepManager = class _GameStepManager {
   static set originalStepData(value) {
     _GameStepManager._originalStepData = createExportableElement(value);
   }
+  static get currentStepData() {
+    let currentStepData = {
+      path: window.location.pathname,
+      storage: GameStorageManager.export(),
+      canvas: GameWindowManager.export(),
+      labelIndex: _GameStepManager.currentLabelStepIndex || 0,
+      openedLabels: createExportableElement(_GameStepManager._openedLabels)
+    };
+    return currentStepData;
+  }
   /* Edit History Methods */
   /**
    * Add a label to the history.
@@ -1646,19 +1673,13 @@ var _GameStepManager = class _GameStepManager {
    */
   static addStepHistory(step, choiseMade) {
     let stepHistory = getStepSha1(step);
-    let historyStep = {
-      path: window.location.pathname,
-      storage: GameStorageManager.export(),
-      canvas: GameWindowManager.export(),
-      labelIndex: _GameStepManager.currentLabelStepIndex || 0,
-      openedLabels: createExportableElement(_GameStepManager._openedLabels)
-    };
+    let currentStepData = _GameStepManager.currentStepData;
     if (_GameStepManager.originalStepData) {
-      if (_GameStepManager.originalStepData.openedLabels.length === historyStep.openedLabels.length) {
+      if (_GameStepManager.originalStepData.openedLabels.length === currentStepData.openedLabels.length) {
         try {
           let lastStepDataOpenedLabelsString = JSON.stringify(_GameStepManager.originalStepData.openedLabels);
-          let historyStepOpenedLabelsString = JSON.stringify(historyStep.openedLabels);
-          if (lastStepDataOpenedLabelsString === historyStepOpenedLabelsString && _GameStepManager.originalStepData.path === historyStep.path && _GameStepManager.originalStepData.labelIndex === historyStep.labelIndex) {
+          let historyStepOpenedLabelsString = JSON.stringify(currentStepData.openedLabels);
+          if (lastStepDataOpenedLabelsString === historyStepOpenedLabelsString && _GameStepManager.originalStepData.path === currentStepData.path && _GameStepManager.originalStepData.labelIndex === currentStepData.labelIndex) {
             return;
           }
         } catch (e) {
@@ -1666,7 +1687,7 @@ var _GameStepManager = class _GameStepManager {
         }
       }
     }
-    let data = diff(_GameStepManager.originalStepData, historyStep);
+    let data = diff(_GameStepManager.originalStepData, currentStepData);
     if (data) {
       let dialoge = void 0;
       let requiredChoices = void 0;
@@ -1685,7 +1706,7 @@ var _GameStepManager = class _GameStepManager {
         index: _GameStepManager.lastStepIndex,
         choiceIndexMade: choiseMade
       });
-      _GameStepManager.originalStepData = historyStep;
+      _GameStepManager.originalStepData = currentStepData;
     }
     _GameStepManager.increaseLastStepIndex();
   }
@@ -1776,6 +1797,9 @@ var _GameStepManager = class _GameStepManager {
         console.warn("[Pixi'VN] The player must make a choice");
         return;
       }
+      if (_GameStepManager.currentLabel && _GameStepManager.currentLabel.onStepEnd) {
+        yield _GameStepManager.currentLabel.onStepEnd(_GameStepManager.currentLabelStepIndex || 0, _GameStepManager.currentLabel);
+      }
       _GameStepManager.increaseCurrentStepIndex();
       return yield _GameStepManager.runCurrentStep(props, choiseMade);
     });
@@ -1800,6 +1824,10 @@ var _GameStepManager = class _GameStepManager {
           return;
         }
         if (currentLabel.steps.length > currentLabelStepIndex) {
+          let onStepRun = currentLabel.onStepStart;
+          if (onStepRun) {
+            yield onStepRun(currentLabelStepIndex, currentLabel);
+          }
           let step = currentLabel.steps[currentLabelStepIndex];
           let result = yield step(props);
           _GameStepManager.addStepHistory(step, choiseMade);
@@ -1864,6 +1892,9 @@ var _GameStepManager = class _GameStepManager {
         if (!tempLabel) {
           throw new Error(`[Pixi'VN] Label ${labelId} not found`);
         }
+        if (_GameStepManager.currentLabel && _GameStepManager.currentLabel.onStepEnd) {
+          yield _GameStepManager.currentLabel.onStepEnd(_GameStepManager.currentLabelStepIndex || 0, _GameStepManager.currentLabel);
+        }
         _GameStepManager.pushNewLabel(tempLabel.id);
       } catch (e) {
         console.error("[Pixi'VN] Error calling label", e);
@@ -1922,6 +1953,9 @@ var _GameStepManager = class _GameStepManager {
         if (!tempLabel) {
           throw new Error(`[Pixi'VN] Label ${labelId} not found`);
         }
+        if (_GameStepManager.currentLabel && _GameStepManager.currentLabel.onStepEnd) {
+          yield _GameStepManager.currentLabel.onStepEnd(_GameStepManager.currentLabelStepIndex || 0, _GameStepManager.currentLabel);
+        }
         _GameStepManager.pushNewLabel(tempLabel.id);
       } catch (e) {
         console.error("[Pixi'VN] Error jumping label", e);
@@ -2027,24 +2061,29 @@ var _GameStepManager = class _GameStepManager {
    * ```
    */
   static goBack(navigate, steps = 1) {
-    if (steps <= 0) {
-      console.warn("[Pixi'VN] Steps must be greater than 0");
-      return;
-    }
-    if (_GameStepManager._stepsHistory.length <= 1) {
-      console.warn("[Pixi'VN] No steps to go back");
-      return;
-    }
-    let restoredStep = _GameStepManager.goBackInternal(steps, _GameStepManager.originalStepData);
-    if (restoredStep) {
-      _GameStepManager._originalStepData = restoredStep;
-      _GameStepManager._openedLabels = createExportableElement(restoredStep.openedLabels);
-      GameStorageManager.import(createExportableElement(restoredStep.storage));
-      GameWindowManager.import(createExportableElement(restoredStep.canvas));
-      navigate(restoredStep.path);
-    } else {
-      console.error("[Pixi'VN] Error going back");
-    }
+    return __async(this, null, function* () {
+      if (steps <= 0) {
+        console.warn("[Pixi'VN] Steps must be greater than 0");
+        return;
+      }
+      if (_GameStepManager._stepsHistory.length <= 1) {
+        console.warn("[Pixi'VN] No steps to go back");
+        return;
+      }
+      let restoredStep = _GameStepManager.goBackInternal(steps, _GameStepManager.originalStepData);
+      if (restoredStep) {
+        _GameStepManager._originalStepData = restoredStep;
+        _GameStepManager._openedLabels = createExportableElement(restoredStep.openedLabels);
+        if (_GameStepManager.currentLabel && _GameStepManager.currentLabel.onLoadStep) {
+          yield _GameStepManager.currentLabel.onLoadStep(_GameStepManager.currentLabelStepIndex || 0, _GameStepManager.currentLabel);
+        }
+        GameStorageManager.import(createExportableElement(restoredStep.storage));
+        GameWindowManager.import(createExportableElement(restoredStep.canvas));
+        navigate(restoredStep.path);
+      } else {
+        console.error("[Pixi'VN] Error going back");
+      }
+    });
   }
   static goBackInternal(steps, restoredStep) {
     if (steps <= 0) {
@@ -2106,38 +2145,45 @@ var _GameStepManager = class _GameStepManager {
    * @param dataString The history in a JSON string.
    */
   static importJson(dataString) {
-    _GameStepManager.import(JSON.parse(dataString));
+    return __async(this, null, function* () {
+      yield _GameStepManager.import(JSON.parse(dataString));
+    });
   }
   /**
    * Import the history from an object.
    * @param data The history in an object.
    */
   static import(data) {
-    _GameStepManager.clear();
-    try {
-      if (data.hasOwnProperty("stepsHistory")) {
-        _GameStepManager._stepsHistory = data["stepsHistory"];
-      } else {
-        console.warn("[Pixi'VN] Could not import stepsHistory data, so will be ignored");
-      }
-      if (data.hasOwnProperty("openedLabels")) {
-        _GameStepManager._openedLabels = data["openedLabels"];
-      } else {
-        console.warn("[Pixi'VN] Could not import openedLabels data, so will be ignored");
-      }
-      if (data.hasOwnProperty("lastStepIndex")) {
-        _GameStepManager._lastStepIndex = data["lastStepIndex"];
-      } else {
-        console.warn("[Pixi'VN] Could not import lastStepIndex data, so will be ignored");
-      }
-      if (data.hasOwnProperty("originalStepData")) {
-        _GameStepManager._originalStepData = data["originalStepData"];
-      } else {
-        console.warn("[Pixi'VN] Could not import originalStepData data, so will be ignored");
+    return __async(this, null, function* () {
+      _GameStepManager.clear();
+      try {
+        if (data.hasOwnProperty("stepsHistory")) {
+          _GameStepManager._stepsHistory = data["stepsHistory"];
+        } else {
+          console.warn("[Pixi'VN] Could not import stepsHistory data, so will be ignored");
+        }
+        if (data.hasOwnProperty("openedLabels")) {
+          _GameStepManager._openedLabels = data["openedLabels"];
+        } else {
+          console.warn("[Pixi'VN] Could not import openedLabels data, so will be ignored");
+        }
+        if (data.hasOwnProperty("lastStepIndex")) {
+          _GameStepManager._lastStepIndex = data["lastStepIndex"];
+        } else {
+          console.warn("[Pixi'VN] Could not import lastStepIndex data, so will be ignored");
+        }
+        if (data.hasOwnProperty("originalStepData")) {
+          _GameStepManager._originalStepData = data["originalStepData"];
+        } else {
+          console.warn("[Pixi'VN] Could not import originalStepData data, so will be ignored");
+        }
+        if (_GameStepManager.currentLabel && _GameStepManager.currentLabel.onLoadStep) {
+          yield _GameStepManager.currentLabel.onLoadStep(_GameStepManager.currentLabelStepIndex || 0, _GameStepManager.currentLabel);
+        }
+      } catch (e) {
+        console.error("[Pixi'VN] Error importing data", e);
       }
-    } catch (e) {
-      console.error("[Pixi'VN] Error importing data", e);
-    }
+    });
   }
 };
 /**
@@ -2168,7 +2214,27 @@ var ChoiceMenuOptionClose = class {
      */
     this.type = Close;
     /**
-     * Properties to be passed to the label
+     * Properties to be passed to the label and olther parameters that you can use when get all the choice menu options.
+     * @example
+     * ```tsx
+     * setChoiceMenuOptions([
+     *     new ChoiceMenuOption("Hello", helloLabel, { disabled: true }),
+     * ])
+     * return <List>
+     *     {getChoiceMenuOptions()?.map((item, index) => {
+     *         return (
+     *             <ChoiceButton
+     *                 disabled={item.props.disabled}
+     *                 onClick={() => {
+     *                     afterSelectChoice(item)
+     *                 }}
+     *             >
+     *                 {item.text}
+     *             </ChoiceButton>
+     *         )
+     *     })}
+     * </List>
+     * ```
      */
     this.props = {};
     this.text = text;
@@ -2286,7 +2352,10 @@ function getChoiceMenuOptions() {
       }
       let label = getLabelById(option.label);
       if (label) {
-        let itemLabel = new Label(label.id, label.steps, label.onStepRun, index);
+        let itemLabel = new Label(label.id, label.steps, {
+          onStepStart: label.onStepStart,
+          choiseIndex: index
+        });
         options.push(__spreadProps(__spreadValues({}, option), {
           label: itemLabel
         }));
@@ -2410,8 +2479,9 @@ FadeAlphaTicker = __decorateClass([
 ], FadeAlphaTicker);
 
 // src/functions/TickerUtility.ts
-function updateTickerProgression(args, propertyName, progression) {
-  if (args[propertyName] === void 0 || !progression || args[propertyName] === progression.limit) {
+function updateTickerProgression(args, propertyName, progression, valueConvert) {
+  let limit = valueConvert && progression.limit ? valueConvert(progression.limit) : progression.limit;
+  if (args[propertyName] === void 0 || !progression || args[propertyName] === limit) {
     return;
   }
   if (typeof args[propertyName] === "number") {
@@ -2430,22 +2500,25 @@ function updateTickerProgression(args, propertyName, progression) {
     }
   }
 }
-function getLinearProgression(number, progression) {
-  if (progression.limit !== void 0) {
-    if (number > progression.limit && progression.amt > 0) {
-      return progression.limit;
-    } else if (number < progression.limit && progression.amt < 0) {
-      return progression.limit;
+function getLinearProgression(number, progression, valueConvert) {
+  let limit = valueConvert && progression.limit ? valueConvert(progression.limit) : progression.limit;
+  let amt = valueConvert ? valueConvert(progression.amt) : progression.amt;
+  if (limit !== void 0) {
+    if (number > limit && amt > 0) {
+      return limit;
+    } else if (number < limit && amt < 0) {
+      return limit;
     }
   }
-  return number + progression.amt / 60;
+  return number + amt;
 }
-function getExponentialProgression(number, progression) {
-  if (progression.limit !== void 0) {
-    if (number > progression.limit && progression.percentage > 0) {
-      return progression.limit;
-    } else if (number < progression.limit && progression.percentage < 0) {
-      return progression.limit;
+function getExponentialProgression(number, progression, valueConvert) {
+  let limit = valueConvert && progression.limit ? valueConvert(progression.limit) : progression.limit;
+  if (limit !== void 0) {
+    if (number > limit && progression.percentage > 0) {
+      return limit;
+    } else if (number < limit && progression.percentage < 0) {
+      return limit;
     }
   }
   return number + number * progression.percentage;
@@ -2458,15 +2531,13 @@ var MoveTicker = class extends TickerBase {
     let ySpeed = 1;
     if (args.speed) {
       if (typeof args.speed === "number") {
-        xSpeed = args.speed;
-        ySpeed = args.speed;
+        xSpeed = this.speedConvert(args.speed);
+        ySpeed = this.speedConvert(args.speed);
       } else {
-        xSpeed = args.speed.x;
-        ySpeed = args.speed.y;
+        xSpeed = this.speedConvert(args.speed.x);
+        ySpeed = this.speedConvert(args.speed.y);
       }
     }
-    xSpeed /= 60;
-    ySpeed /= 60;
     let destination = args.destination;
     let tagToRemoveAfter2 = args.tagToRemoveAfter || [];
     if (typeof tagToRemoveAfter2 === "string") {
@@ -2506,7 +2577,10 @@ var MoveTicker = class extends TickerBase {
       }
     });
     if (args.speedProgression)
-      updateTickerProgression(args, "speed", args.speedProgression);
+      updateTickerProgression(args, "speed", args.speedProgression, this.speedConvert);
+  }
+  speedConvert(speed) {
+    return speed / 6;
   }
 };
 MoveTicker = __decorateClass([
@@ -2514,7 +2588,7 @@ MoveTicker = __decorateClass([
 ], MoveTicker);
 var RotateTicker = class extends TickerBase {
   fn(ticker, args, tags, tickerId) {
-    let speed = (args.speed === void 0 ? 1 : args.speed) / 60;
+    let speed = this.speedConvert(args.speed === void 0 ? 1 : args.speed);
     let clockwise = args.clockwise === void 0 ? true : args.clockwise;
     let tagToRemoveAfter2 = args.tagToRemoveAfter || [];
     if (typeof tagToRemoveAfter2 === "string") {
@@ -2542,7 +2616,10 @@ var RotateTicker = class extends TickerBase {
       }
     });
     if (args.speedProgression)
-      updateTickerProgression(args, "speed", args.speedProgression);
+      updateTickerProgression(args, "speed", args.speedProgression, this.speedConvert);
+  }
+  speedConvert(speed) {
+    return speed / 60;
   }
 };
 RotateTicker = __decorateClass([
@@ -2554,15 +2631,13 @@ var ZoomTicker = class extends TickerBase {
     let ySpeed = 0.1;
     if (args.speed) {
       if (typeof args.speed === "number") {
-        xSpeed = args.speed;
-        ySpeed = args.speed;
+        xSpeed = this.speedConvert(args.speed);
+        ySpeed = this.speedConvert(args.speed);
       } else {
-        xSpeed = args.speed.x;
-        ySpeed = args.speed.y;
+        xSpeed = this.speedConvert(args.speed.x);
+        ySpeed = this.speedConvert(args.speed.y);
       }
     }
-    xSpeed /= 60;
-    ySpeed /= 60;
     let tagToRemoveAfter2 = args.tagToRemoveAfter || [];
     if (typeof tagToRemoveAfter2 === "string") {
       tagToRemoveAfter2 = [tagToRemoveAfter2];
@@ -2629,7 +2704,10 @@ var ZoomTicker = class extends TickerBase {
       }
     });
     if (args.speedProgression)
-      updateTickerProgression(args, "speed", args.speedProgression);
+      updateTickerProgression(args, "speed", args.speedProgression, this.speedConvert);
+  }
+  speedConvert(speed) {
+    return speed / 60;
   }
   onEndOfTicker(tag, tickerId, _element, tagToRemoveAfter2) {
     GameWindowManager.onEndOfTicker(tag, this, tagToRemoveAfter2, tickerId);
@@ -2827,14 +2905,14 @@ function zoomIn(_0, _1) {
     } else {
       canvasElement = image;
     }
-    if (canvasElement instanceof CanvasImage && ((_a = canvasElement.texture) == null ? void 0 : _a.label) == "EMPTY") {
-      yield canvasElement.load();
-    }
     let container = new CanvasContainer();
     container.addChild(canvasElement);
     container.height = GameWindowManager.canvasHeight;
     container.width = GameWindowManager.canvasWidth;
     GameWindowManager.addCanvasElement(tag, container);
+    if (canvasElement instanceof CanvasImage && ((_a = canvasElement.texture) == null ? void 0 : _a.label) == "EMPTY") {
+      yield canvasElement.load();
+    }
     if (props.direction == "up") {
       container.pivot.y = GameWindowManager.canvasHeight;
       container.pivot.x = GameWindowManager.canvasWidth / 2;
@@ -2922,13 +3000,17 @@ function getSaveJson() {
   return JSON.stringify(saveData);
 }
 function loadSaveData(data, navigate) {
-  GameStepManager.import(data.stepData);
-  GameStorageManager.import(data.storageData);
-  GameWindowManager.import(data.canvasData);
-  navigate(data.path);
+  return __async(this, null, function* () {
+    yield GameStepManager.import(data.stepData);
+    GameStorageManager.import(data.storageData);
+    GameWindowManager.import(data.canvasData);
+    navigate(data.path);
+  });
 }
 function loadSaveJson(dataString, navigate) {
-  loadSaveData(jsonToSaveData(dataString), navigate);
+  return __async(this, null, function* () {
+    yield loadSaveData(jsonToSaveData(dataString), navigate);
+  });
 }
 function jsonToSaveData(json) {
   return JSON.parse(json);