@drincs/pixi-vn 0.5.2 → 0.5.4

package/dist/functions/SavesUtility.d.mts

@@ -11,12 +11,12 @@ import '../interface/IHistoryStep.mjs';
 import 'deep-diff';
 import '../classes/ChoiceMenuOption.mjs';
 import '../classes/Label.mjs';
+import '../types/LabelIdType.mjs';
+import '../types/StepHistoryDataType.mjs';
 import '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
-import '../types/StepHistoryDataType.mjs';
 import '../types/CloseType.mjs';
 import '../types/LabelRunModeType.mjs';
-import '../types/LabelIdType.mjs';
 import '../classes/DialogueBaseModel.mjs';
 import '../classes/CharacterBaseModel.mjs';
 import '../classes/StoredClassModel.mjs';

package/dist/functions/SavesUtility.d.ts

@@ -11,12 +11,12 @@ import '../interface/IHistoryStep.js';
 import 'deep-diff';
 import '../classes/ChoiceMenuOption.js';
 import '../classes/Label.js';
+import '../types/LabelIdType.js';
+import '../types/StepHistoryDataType.js';
 import '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
-import '../types/StepHistoryDataType.js';
 import '../types/CloseType.js';
 import '../types/LabelRunModeType.js';
-import '../types/LabelIdType.js';
 import '../classes/DialogueBaseModel.js';
 import '../classes/CharacterBaseModel.js';
 import '../classes/StoredClassModel.js';

package/dist/functions/SavesUtility.js

@@ -59,107 +59,14 @@ var __async = (__this, __arguments, generator) => {
 };
 
 // src/constants.ts
-var PIXIVN_VERSION = "0.5.2";
-
-// src/types/PauseType.ts
-var PauseValueType = "pause";
-
-// src/types/RepeatType.ts
-var Repeat = "repeat";
+var PIXIVN_VERSION = "0.5.4";
 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 {
-  /**
-   * Get the steps of the label.
-   * This class should be extended and the steps method should be overridden.
-   * Every time you update this list will also be updated when the other game versions load.
-   */
-  get steps() {
-    throw new Error("[Pixi'VN] The method Label.steps must be overridden");
-  }
-  /**
-   * 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;
-  }
-};
 
 // src/classes/CloseLabel.ts
-var CloseLabel = class extends Label {
-};
-
-// src/decorators/LabelDecorator.ts
-var registeredLabels = {};
-function getLabelInstanceByClassName(labelName) {
-  try {
-    let labelType = registeredLabels[labelName];
-    if (!labelType) {
-      console.error(`[Pixi'VN] Label ${labelName} not found`);
-      return;
-    }
-    let label = new labelType();
-    let step = label.steps;
-    if (step.length = 0) {
-      console.warn(`[Pixi'VN] Label ${labelName} has no steps`);
-    }
-    return label;
-  } catch (e) {
-    console.error(`[Pixi'VN] Error while getting Label ${labelName}`, e);
-    return;
-  }
-}
-
-// src/functions/DialogueUtility.ts
-function getDialogue() {
-  return GameStorageManager.getVariable(GameStorageManager.keysSystem.CURRENT_DIALOGUE_MEMORY_KEY);
-}
-
-// src/decorators/CanvasElementDecorator.ts
-var registeredCanvasElement = {};
-function getCanvasElementInstanceByClassName(canvasName) {
-  try {
-    let eventType = registeredCanvasElement[canvasName];
-    if (!eventType) {
-      if (canvasName === "CanvasContainer") {
-        eventType = CanvasContainer;
-      } else if (canvasName === "CanvasImage") {
-        eventType = CanvasImage;
-      } else if (canvasName === "CanvasSprite") {
-        eventType = CanvasSprite;
-      } else if (canvasName === "CanvasText") {
-        eventType = CanvasText;
-      }
-    }
-    if (!eventType) {
-      console.error(`[Pixi'VN] CanvasElement ${canvasName} not found`);
-      return;
-    }
-    let canvasElement = new eventType();
-    return canvasElement;
-  } catch (e) {
-    console.error(`[Pixi'VN] Error while getting CanvasElement ${canvasName}`, e);
-    return;
-  }
-}
+var CLOSE_LABEL_ID = "__close-label-id__";
 
 // src/functions/CanvasUtility.ts
 function getTextureMemory(texture) {
@@ -596,29 +503,33 @@ function setMemoryText(element, memory) {
   }
 }
 
-// src/classes/ticker/TickerBase.ts
-var TickerBase = class {
-  /**
-   * @param args The arguments that you want to pass to the ticker.
-   * @param duration The duration of the ticker. If is undefined, the ticker will be called every frame.
-   * @param priority The priority of the ticker. If is undefined, the priority will be UPDATE_PRIORITY.NORMAL.
-   */
-  constructor(args, duration, priority) {
-    this.args = args;
-    this.duration = duration;
-    this.priority = priority;
-  }
-  /**
-   * The method that will be called every frame.
-   * This method should be overridden and you can use GameWindowManager.addCanvasElement() to get the canvas element of the canvas, and edit them.
-   * @param t The ticker that is calling this method
-   * @param args The arguments that you passed when you added the ticker
-   * @param tags The tags of the canvas elements that are connected to this ticker
-   */
-  fn(_t, _args, _tags) {
-    throw new Error("[Pixi'VN] The method TickerBase.fn() must be overridden");
+// src/decorators/CanvasElementDecorator.ts
+var registeredCanvasElement = {};
+function getCanvasElementInstanceByClassName(canvasName) {
+  try {
+    let eventType = registeredCanvasElement[canvasName];
+    if (!eventType) {
+      if (canvasName === "CanvasContainer") {
+        eventType = CanvasContainer;
+      } else if (canvasName === "CanvasImage") {
+        eventType = CanvasImage;
+      } else if (canvasName === "CanvasSprite") {
+        eventType = CanvasSprite;
+      } else if (canvasName === "CanvasText") {
+        eventType = CanvasText;
+      }
+    }
+    if (!eventType) {
+      console.error(`[Pixi'VN] CanvasElement ${canvasName} not found`);
+      return;
+    }
+    let canvasElement = new eventType();
+    return canvasElement;
+  } catch (e) {
+    console.error(`[Pixi'VN] Error while getting CanvasElement ${canvasName}`, e);
+    return;
   }
-};
+}
 
 // src/decorators/TickerDecorator.ts
 var registeredTickers = {};
@@ -647,7 +558,51 @@ function geTickerInstanceByClassName(tickerName, args, duration, priority) {
   }
 }
 
-// src/classes/ticker/TickerFadeAlpha.ts
+// src/types/PauseType.ts
+var PauseValueType = "pause";
+
+// src/types/RepeatType.ts
+var Repeat = "repeat";
+
+// src/decorators/LabelDecorator.ts
+var registeredLabels = {};
+function getLabelById(id) {
+  let label = registeredLabels[id];
+  if (!label) {
+    console.error(`[Pixi'VN] Label ${id} not found`);
+    return;
+  }
+  return label;
+}
+
+// src/functions/DialogueUtility.ts
+function getDialogue() {
+  return GameStorageManager.getVariable(GameStorageManager.keysSystem.CURRENT_DIALOGUE_MEMORY_KEY);
+}
+
+// src/classes/ticker/TickerBase.ts
+var TickerBase = class {
+  /**
+   * @param args The arguments that you want to pass to the ticker.
+   * @param duration The duration of the ticker. If is undefined, the ticker will be called every frame.
+   * @param priority The priority of the ticker. If is undefined, the priority will be UPDATE_PRIORITY.NORMAL.
+   */
+  constructor(args, duration, priority) {
+    this.args = args;
+    this.duration = duration;
+    this.priority = priority;
+  }
+  /**
+   * The method that will be called every frame.
+   * This method should be overridden and you can use GameWindowManager.addCanvasElement() to get the canvas element of the canvas, and edit them.
+   * @param t The ticker that is calling this method
+   * @param args The arguments that you passed when you added the ticker
+   * @param tags The tags of the canvas elements that are connected to this ticker
+   */
+  fn(_t, _args, _tags) {
+    throw new Error("[Pixi'VN] The method TickerBase.fn() must be overridden");
+  }
+};
 var TickerFadeAlpha = class extends TickerBase {
   /**
    * The method that will be called every frame to fade the alpha of the canvas element of the canvas.
@@ -1561,7 +1516,7 @@ var _GameStepManager = class _GameStepManager {
    */
   static get currentLabel() {
     if (_GameStepManager.currentLabelId) {
-      return getLabelInstanceByClassName(_GameStepManager.currentLabelId);
+      return getLabelById(_GameStepManager.currentLabelId);
     }
   }
   static get currentLabelStepIndex() {
@@ -1582,7 +1537,7 @@ var _GameStepManager = class _GameStepManager {
         return true;
       } else {
         this.openedLabels.forEach((item) => {
-          let label = getLabelInstanceByClassName(item.label);
+          let label = getLabelById(item.label);
           if (label && label.steps.length > item.currentStepIndex) {
             return false;
           }
@@ -1675,9 +1630,9 @@ var _GameStepManager = class _GameStepManager {
    * @param label The label to add to the history.
    */
   static pushNewLabel(label) {
-    let currentLabel = getLabelInstanceByClassName(label);
+    let currentLabel = getLabelById(label);
     if (!currentLabel) {
-      throw new Error("[Pixi'VN] Label not found");
+      throw new Error(`[Pixi'VN] Label ${label} not found`);
     }
     _GameStepManager._openedLabels.push({
       label,
@@ -1694,7 +1649,7 @@ var _GameStepManager = class _GameStepManager {
       return;
     }
     if (!_GameStepManager.currentLabel) {
-      console.error("[Pixi'VN] Label not found");
+      console.error("[Pixi'VN] currentLabel not found");
       return;
     }
     _GameStepManager._openedLabels.pop();
@@ -1766,7 +1721,7 @@ var _GameStepManager = class _GameStepManager {
         }
         let currentLabel = _GameStepManager.currentLabel;
         if (!currentLabel) {
-          console.error("[Pixi'VN] Label not found");
+          console.error("[Pixi'VN] currentLabel not found");
           return;
         }
         let n = currentLabel.steps.length;
@@ -1787,12 +1742,12 @@ var _GameStepManager = class _GameStepManager {
   /**
    * Execute the label and add it to the history.
    * Is a call function in Ren'Py.
-   * @param label The label to execute.
+   * @param label The label to execute or the id of the label
    * @param props The props to pass to the label.
    * @returns StepLabelResultType or undefined.
    * @example
    * ```typescript
-   * GameStepManager.callLabel(StartLabel, yourParams).then((result) => {
+   * GameStepManager.callLabel(startLabel, yourParams).then((result) => {
    *     if (result) {
    *         // your code
    *     }
@@ -1801,7 +1756,7 @@ var _GameStepManager = class _GameStepManager {
    * @example
    * ```typescript
    * // if you use it in a step label you should return the result.
-   * return GameStepManager.callLabel(StartLabel).then((result) => {
+   * return GameStepManager.callLabel(startLabel).then((result) => {
    *     return result
    * })
    * ```
@@ -1809,16 +1764,24 @@ var _GameStepManager = class _GameStepManager {
   static callLabel(label, props) {
     return __async(this, null, function* () {
       let choiseMade = void 0;
+      let labelId;
+      if (typeof label === "string") {
+        labelId = label;
+      } else {
+        labelId = label.id;
+        if (typeof label.choiseIndex === "number") {
+          choiseMade = label.choiseIndex;
+        }
+      }
       try {
-        if (label instanceof CloseLabel) {
+        if (labelId === CLOSE_LABEL_ID) {
           return _GameStepManager.runNextStep(props);
         }
-        if (label instanceof Label) {
-          choiseMade = label.choiseIndex;
-          label = label.constructor;
+        let tempLabel = getLabelById(labelId);
+        if (!tempLabel) {
+          throw new Error(`[Pixi'VN] Label ${labelId} not found`);
         }
-        let labelName = label.name;
-        _GameStepManager.pushNewLabel(labelName);
+        _GameStepManager.pushNewLabel(tempLabel.id);
       } catch (e) {
         console.error("[Pixi'VN] Error calling label", e);
         return;
@@ -1830,11 +1793,11 @@ var _GameStepManager = class _GameStepManager {
    * Execute the label, close all labels and add them to the history.
    * Is a jump function in Ren'Py.
    * @param label The label to execute.
-   * @param props The props to pass to the label.
+   * @param props The props to pass to the label or the id of the label
    * @returns StepLabelResultType or undefined.
    * @example
    * ```typescript
-   * GameStepManager.jumpLabel(StartLabel, yourParams).then((result) => {
+   * GameStepManager.jumpLabel(startLabel, yourParams).then((result) => {
    *     if (result) {
    *         // your code
    *     }
@@ -1843,7 +1806,7 @@ var _GameStepManager = class _GameStepManager {
    * @example
    * ```typescript
    * // if you use it in a step label you should return the result.
-   * return GameStepManager.jumpLabel(StartLabel).then((result) => {
+   * return GameStepManager.jumpLabel(startLabel).then((result) => {
    *     return result
    * })
    * ```
@@ -1851,15 +1814,24 @@ var _GameStepManager = class _GameStepManager {
   static jumpLabel(label, props) {
     return __async(this, null, function* () {
       _GameStepManager.closeAllLabels();
+      let labelId;
+      if (typeof label === "string") {
+        labelId = label;
+      } else {
+        labelId = label.id;
+        if (typeof label.choiseIndex === "number") {
+          label.choiseIndex;
+        }
+      }
       try {
-        if (label instanceof CloseLabel) {
+        if (labelId === CLOSE_LABEL_ID) {
           return _GameStepManager.runNextStep(props);
         }
-        if (label instanceof Label) {
-          label = label.constructor;
+        let tempLabel = getLabelById(labelId);
+        if (!tempLabel) {
+          throw new Error(`[Pixi'VN] Label ${labelId} not found`);
         }
-        let labelName = label.name;
-        _GameStepManager.pushNewLabel(labelName);
+        _GameStepManager.pushNewLabel(tempLabel.id);
       } catch (e) {
         console.error("[Pixi'VN] Error jumping label", e);
         return;
@@ -1873,14 +1845,14 @@ var _GameStepManager = class _GameStepManager {
    * @returns StepLabelResultType or undefined.
    * @example
    * ```typescript
-   * GameStepManager.exitToChoiceMenu(yourParams).then((result) => {
+   * GameStepManager.closeChoiceMenu(yourParams).then((result) => {
    *     if (result) {
    *         // your code
    *     }
    * })
    * ```
    */
-  static exitToChoiceMenu(props) {
+  static closeChoiceMenu(props) {
     return __async(this, null, function* () {
       return _GameStepManager.runNextStep(props);
     });