@drincs/pixi-vn 0.5.2 → 0.5.4

package/dist/classes/index.d.mts

@@ -1,6 +1,6 @@
 export { default as CanvasEvent } from './CanvasEvent.mjs';
 export { default as CharacterBaseModel, CharacterBaseModelProps } from './CharacterBaseModel.mjs';
-export { default as ChoiceMenuOption } from './ChoiceMenuOption.mjs';
+export { default as ChoiceMenuOption, HistoryChoiceMenuOption } from './ChoiceMenuOption.mjs';
 export { default as DialogueBaseModel } from './DialogueBaseModel.mjs';
 export { default as Label } from './Label.mjs';
 export { default as StoredClassModel } from './StoredClassModel.mjs';
@@ -9,6 +9,6 @@ import '../types/CloseType.mjs';
 import '../types/LabelRunModeType.mjs';
 import '../types/StorageElementType.mjs';
 import '../types/LabelIdType.mjs';
+import '../types/StepHistoryDataType.mjs';
 import '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
-import '../types/StepHistoryDataType.mjs';

package/dist/classes/index.d.ts

@@ -1,6 +1,6 @@
 export { default as CanvasEvent } from './CanvasEvent.js';
 export { default as CharacterBaseModel, CharacterBaseModelProps } from './CharacterBaseModel.js';
-export { default as ChoiceMenuOption } from './ChoiceMenuOption.js';
+export { default as ChoiceMenuOption, HistoryChoiceMenuOption } from './ChoiceMenuOption.js';
 export { default as DialogueBaseModel } from './DialogueBaseModel.js';
 export { default as Label } from './Label.js';
 export { default as StoredClassModel } from './StoredClassModel.js';
@@ -9,6 +9,6 @@ import '../types/CloseType.js';
 import '../types/LabelRunModeType.js';
 import '../types/StorageElementType.js';
 import '../types/LabelIdType.js';
+import '../types/StepHistoryDataType.js';
 import '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
-import '../types/StepHistoryDataType.js';

package/dist/classes/index.js

@@ -66,13 +66,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
@@ -91,62 +109,34 @@ var Label = class {
     });
     return res;
   }
-};
-
-// src/types/PauseType.ts
-var PauseValueType = "pause";
-
-// src/types/RepeatType.ts
-var Repeat = "repeat";
-
-// src/classes/ChoiceMenuOption.ts
-var ChoiceMenuOption = class {
   /**
-   * @param text Text to be displayed in the menu
-   * @param label Label to be opened when the option is selected
-   * @param type Type of the label to be opened
-   * @param props Properties to be passed to the label, when the label is called. it cannot contain functions or classes.
+   * 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')
+   * })
+   * ```
    */
-  constructor(text, label, type = "call", props) {
-    /**
-     * Properties to be passed to the label
-     */
-    this.props = {};
-    this.text = text;
-    this.label = new label();
-    this.type = type;
-    if (props) {
-      this.props = props;
-    }
+  get onStepRun() {
+    return this._onStepRun;
+  }
+  get choiseIndex() {
+    return this._choiseIndex;
   }
 };
 
-// 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);
+// 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/CanvasUtility.ts
@@ -584,29 +574,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 = {};
@@ -635,7 +629,65 @@ 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/classes/ChoiceMenuOption.ts
+var ChoiceMenuOption = class {
+  /**
+   * @param text Text to be displayed in the menu
+   * @param label Label to be opened when the option is selected or the id of the label
+   * @param type Type of the label to be opened. @default "call"
+   * @param props Properties to be passed to the label, when the label is called. it cannot contain functions or classes. @default {}
+   */
+  constructor(text, label, type = "call", props) {
+    /**
+     * Properties to be passed to the label
+     */
+    this.props = {};
+    if (typeof label === "string") {
+      let tLabel = getLabelById(label);
+      if (!tLabel) {
+        throw new Error(`[Pixi'VN] Label ${label} not found`);
+      } else {
+        label = tLabel;
+      }
+    }
+    this.text = text;
+    this.label = label;
+    this.type = type;
+    if (props) {
+      this.props = props;
+    }
+  }
+};
+
+// 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.