@drincs/pixi-vn 0.6.4 → 0.6.6

package/dist/decorators/LabelDecorator.d.ts

@@ -1,26 +1,40 @@
 import { LabelIdType } from '../types/LabelIdType.js';
 import Label from '../classes/Label.js';
 import { StepLabelType } from '../types/StepLabelType.js';
-import '../types/StepHistoryDataType.js';
+import LabelProps from '../interface/LabelProps.js';
+import LabelJson from '../classes/LabelJson.js';
+import LabelAbstract from '../classes/LabelAbstract.js';
 import '@drincs/pixi-vn/dist/override';
+import '../types/StepLabelJsonType.js';
+import '../types/ChoiceMenuOptionsType.js';
+import '../classes/ChoiceMenuOption.js';
+import '../types/StorageElementType.js';
+import '../types/CloseType.js';
+import '../types/LabelRunModeType.js';
+import '../types/StepHistoryDataType.js';
 
 declare const registeredLabels: {
-    [key: LabelIdType]: Label<any>;
+    [key: LabelIdType]: (LabelAbstract<any> | Label<any> | LabelJson<any>);
 };
 /**
  * Creates a new label and registers it in the system.
  * **This function must be called at least once at system startup to register the label, otherwise the system cannot be used.**
  * @param id The id of the label, it must be unique
  * @param steps The steps of the label
- * @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 props The properties of the label
  * @returns The created label
  */
-declare function newLabel<T extends {} = {}>(id: LabelIdType, steps: StepLabelType<T>[] | (() => StepLabelType<T>[]), onStepRun?: () => void | Promise<void>): Label<T>;
+declare function newLabel<T extends {} = {}>(id: LabelIdType, steps: StepLabelType<T>[] | (() => StepLabelType<T>[]), props?: Omit<LabelProps<Label<T>>, "choiseIndex">): Label<T>;
 /**
  * Gets a label by its id
  * @param id The id of the label
  * @returns The label or undefined if it does not exist
  */
 declare function getLabelById<T = Label<any>>(id: LabelIdType): T | undefined;
+/**
+ * Saves a label in the system
+ * @param label The label to be saved
+ */
+declare function saveLabel<T extends LabelAbstract<any>>(label: T): void;
 
-export { getLabelById, newLabel, registeredLabels };
+export { getLabelById, newLabel, registeredLabels, saveLabel };

package/dist/decorators/LabelDecorator.js

@@ -60,19 +60,18 @@ function checkIfStepsIsEqual(step1, step2) {
   return step1 === step2;
 }
 
-// src/classes/Label.ts
-var Label = class {
+// src/classes/LabelAbstract.ts
+var LabelAbstract = 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, 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}
@@ -80,17 +79,6 @@ var Label = class {
   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() {
-    if (typeof this._steps === "function") {
-      return this._steps();
-    }
-    return this._steps;
-  }
   /**
    * Get the corresponding steps number
    * @param externalSteps
@@ -109,24 +97,60 @@ 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;
   }
 };
 
+// src/classes/Label.ts
+var Label = class extends LabelAbstract {
+  /**
+   * @param id is the id of the label
+   * @param steps is the list of steps that the label will perform
+   * @param props is the properties of the label
+   */
+  constructor(id, steps, props) {
+    super(id, props);
+    this._steps = steps;
+  }
+  /**
+   * Get the steps of the label.
+   */
+  get steps() {
+    if (typeof this._steps === "function") {
+      return this._steps();
+    }
+    return this._steps;
+  }
+};
+
 // src/functions/CanvasUtility.ts
 function getTextureMemory(texture) {
   let sourceTexture = texture.source;
@@ -203,8 +227,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);
@@ -237,6 +259,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* () {
@@ -717,8 +741,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") {
@@ -737,22 +762,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;
@@ -765,15 +793,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") {
@@ -813,7 +839,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([
@@ -821,7 +850,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") {
@@ -849,7 +878,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([
@@ -861,15 +893,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];
@@ -936,7 +966,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);
@@ -1698,11 +1731,11 @@ var GameWindowManager = _GameWindowManager;
 
 // src/decorators/LabelDecorator.ts
 var registeredLabels = {};
-function newLabel(id, steps, onStepRun) {
+function newLabel(id, steps, props) {
   if (registeredLabels[id]) {
     console.info(`[Pixi'VN] Label ${id} already exists, it will be overwritten`);
   }
-  let label = new Label(id, steps, onStepRun);
+  let label = new Label(id, steps, props);
   registeredLabels[id] = label;
   return label;
 }
@@ -1714,9 +1747,13 @@ function getLabelById(id) {
   }
   return label;
 }
+function saveLabel(label) {
+  registeredLabels[label.id] = label;
+}
 
 exports.getLabelById = getLabelById;
 exports.newLabel = newLabel;
 exports.registeredLabels = registeredLabels;
+exports.saveLabel = saveLabel;
 //# sourceMappingURL=LabelDecorator.js.map
 //# sourceMappingURL=LabelDecorator.js.map