@drincs/pixi-vn 0.5.3 → 0.5.5

package/dist/functions/StepLabelUtility.d.mts

@@ -1,7 +1,6 @@
 import { StepHistoryDataType } from '../types/StepHistoryDataType.mjs';
 import { StepLabelType } from '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
-import '../types/StorageElementType.mjs';
 
 /**
  * Convert StepLabel to StepHistoryData

package/dist/functions/StepLabelUtility.d.ts

@@ -1,7 +1,6 @@
 import { StepHistoryDataType } from '../types/StepHistoryDataType.js';
 import { StepLabelType } from '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
-import '../types/StorageElementType.js';
 
 /**
  * Convert StepLabel to StepHistoryData

package/dist/functions/index.d.mts

@@ -9,15 +9,15 @@ import '../classes/StoredClassModel.mjs';
 import '../types/ChoiceMenuOptionsType.mjs';
 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/StorageElementType.mjs';
-import '../types/StepHistoryDataType.mjs';
 import '../types/CloseType.mjs';
 import '../types/LabelRunModeType.mjs';
-import '../types/LabelIdType.mjs';
+import '../types/StorageElementType.mjs';
 import '../classes/DialogueBaseModel.mjs';
-import '../interface/IDialogueHistory.mjs';
+import '../interface/DialogueHistory.mjs';
 import 'pixi.js';
 import '../classes/canvas/CanvasBase.mjs';
 import '../interface/canvas/ICanvasBaseMemory.mjs';

package/dist/functions/index.d.ts

@@ -9,15 +9,15 @@ import '../classes/StoredClassModel.js';
 import '../types/ChoiceMenuOptionsType.js';
 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/StorageElementType.js';
-import '../types/StepHistoryDataType.js';
 import '../types/CloseType.js';
 import '../types/LabelRunModeType.js';
-import '../types/LabelIdType.js';
+import '../types/StorageElementType.js';
 import '../classes/DialogueBaseModel.js';
-import '../interface/IDialogueHistory.js';
+import '../interface/DialogueHistory.js';
 import 'pixi.js';
 import '../classes/canvas/CanvasBase.js';
 import '../interface/canvas/ICanvasBaseMemory.js';

package/dist/functions/index.js

@@ -67,13 +67,31 @@ function checkIfStepsIsEqual(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() {
-    throw new Error("[Pixi'VN] The method Label.steps must be overridden");
+    return this._steps;
   }
   /**
    * Get the corresponding steps number
@@ -92,45 +110,40 @@ 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
+   * @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 CloseLabel = class extends Label {
-};
+var CLOSE_LABEL_ID = "__close-label-id__";
+function newCloseLabel(choiseIndex) {
+  return new Label(CLOSE_LABEL_ID, [], void 0, choiseIndex);
+}
 
 // src/decorators/LabelDecorator.ts
 var registeredLabels = {};
-function getLabelTypeByClassName(labelName) {
-  try {
-    let labelType = registeredLabels[labelName];
-    if (!labelType) {
-      console.error(`[Pixi'VN] Label ${labelName} not found`);
-      return;
-    }
-    new labelType();
-    return labelType;
-  } catch (e) {
-    console.error(`[Pixi'VN] Error while getting Label ${labelName}`, e);
-    return;
-  }
-}
-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);
+function getLabelById(id) {
+  let label = registeredLabels[id];
+  if (!label) {
+    console.error(`[Pixi'VN] Label ${id} not found`);
     return;
   }
+  return label;
 }
 
 // src/functions/ExportUtility.ts
@@ -1402,7 +1415,7 @@ var _GameStepManager = class _GameStepManager {
    */
   static get currentLabel() {
     if (_GameStepManager.currentLabelId) {
-      return getLabelInstanceByClassName(_GameStepManager.currentLabelId);
+      return getLabelById(_GameStepManager.currentLabelId);
     }
   }
   static get currentLabelStepIndex() {
@@ -1423,7 +1436,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;
           }
@@ -1516,9 +1529,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,
@@ -1535,7 +1548,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();
@@ -1607,7 +1620,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;
@@ -1628,12 +1641,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
    *     }
@@ -1642,7 +1655,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
    * })
    * ```
@@ -1650,16 +1663,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;
@@ -1671,11 +1692,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
    *     }
@@ -1684,7 +1705,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
    * })
    * ```
@@ -1692,15 +1713,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;
@@ -1930,7 +1960,7 @@ var ChoiceMenuOptionClose = class {
     /**
      * Label to be opened when the option is selected
      */
-    this.label = new CloseLabel();
+    this.label = newCloseLabel();
     /**
      * Type of the label to be opened
      */
@@ -1944,7 +1974,7 @@ var ChoiceMenuOptionClose = class {
 };
 
 // src/classes/DialogueBaseModel.ts
-var DialogueBaseModel2 = class {
+var DialogueBaseModel = class {
   /**
    * @param text The text of the dialogue.
    * @param character The id of the character that is speaking. 
@@ -1996,8 +2026,8 @@ function setDialogue(props) {
   let dialogue;
   if (typeof props === "string") {
     text = props;
-    dialogue = new DialogueBaseModel2(text, characterId);
-  } else if (!(props instanceof DialogueBaseModel2)) {
+    dialogue = new DialogueBaseModel(text, characterId);
+  } else if (!(props instanceof DialogueBaseModel)) {
     text = props.text;
     if (props.character) {
       if (typeof props.character === "string") {
@@ -2006,7 +2036,7 @@ function setDialogue(props) {
         characterId = props.character.id;
       }
     }
-    dialogue = new DialogueBaseModel2(text, characterId);
+    dialogue = new DialogueBaseModel(text, characterId);
   } else {
     dialogue = props;
   }
@@ -2028,7 +2058,7 @@ function setChoiceMenuOptions(options) {
       };
     }
     return __spreadProps(__spreadValues({}, option), {
-      label: option.label.constructor.name
+      label: option.label.id
     });
   });
   GameStorageManager.setVariable(GameStorageManager.keysSystem.CURRENT_MENU_OPTIONS_MEMORY_KEY, value);
@@ -2040,8 +2070,7 @@ function getChoiceMenuOptions() {
     let options = [];
     d.forEach((option, index) => {
       if (option.type === Close) {
-        let itemLabel = new CloseLabel();
-        itemLabel.choiseIndex = index;
+        let itemLabel = newCloseLabel(index);
         options.push({
           text: option.text,
           label: itemLabel,
@@ -2050,10 +2079,9 @@ function getChoiceMenuOptions() {
         });
         return;
       }
-      let label = getLabelTypeByClassName(option.label);
+      let label = getLabelById(option.label);
       if (label) {
-        let itemLabel = new label();
-        itemLabel.choiseIndex = index;
+        let itemLabel = new Label(label.id, label.steps, label.onStepRun, index);
         options.push(__spreadProps(__spreadValues({}, option), {
           label: itemLabel
         }));
@@ -2076,7 +2104,7 @@ function getDialogueHistory() {
       if (oldChoices) {
         let choiceMade = false;
         if (step.choiceIndexMade !== void 0 && oldChoices.length > step.choiceIndexMade) {
-          oldChoices[step.choiceIndexMade].isMadeChoice = true;
+          oldChoices[step.choiceIndexMade].isResponse = true;
           choiceMade = true;
         }
         list[list.length - 1].playerMadeChoice = choiceMade;
@@ -2088,7 +2116,7 @@ function getDialogueHistory() {
         return {
           text: choice.text,
           type: choice.type,
-          isMadeChoice: false
+          isResponse: false
         };
       });
       list.push({
@@ -2350,7 +2378,7 @@ function showWithDissolveTransition(tag, image, speed, priority) {
 }
 
 // src/constants.ts
-var PIXIVN_VERSION = "0.5.3";
+var PIXIVN_VERSION = "0.5.5";
 
 // src/functions/SavesUtility.ts
 function getSaveData() {