@drincs/pixi-vn 0.6.3 → 0.6.5

package/dist/classes/ChoiceMenuOption.d.mts

@@ -1,17 +1,17 @@
 import { LabelIdType } from '../types/LabelIdType.mjs';
 import { StorageObjectType } from '../types/StorageElementType.mjs';
-import Label from './Label.mjs';
+import { L as Label } from '../LabelProps-CmRpvUJm.mjs';
 import { CloseType } from '../types/CloseType.mjs';
 import LabelRunModeType from '../types/LabelRunModeType.mjs';
-import '../types/StepHistoryDataType.mjs';
 import '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../types/StepHistoryDataType.mjs';
 
 /**
  * ChoiceMenuOption is a class that contains a Label and a text that will be displayed in the menu.
  * @example
  * ```typescript
- * new ChoiceMenuOption("Hello", HelloLabel)
+ * new ChoiceMenuOption("Hello", HelloLabel, {})
  * ```
  */
 declare class ChoiceMenuOption<T extends StorageObjectType> {
@@ -28,16 +28,36 @@ declare class ChoiceMenuOption<T extends StorageObjectType> {
      */
     type: LabelRunModeType;
     /**
-     * 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>
+     * ```
      */
     props: StorageObjectType;
     /**
      * @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 props Properties to be passed to the label and olther parameters that you can use when get all the choice menu options. It be converted to a JSON string, so it cannot contain functions or classes.
      * @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: string, label: Label<T> | LabelIdType, type?: LabelRunModeType, props?: T);
+    constructor(text: string, label: Label<T> | LabelIdType, props: T, type?: LabelRunModeType);
 }
 /**
  * ChoiceMenuOptionClose is a class that contains a text that will be displayed in the menu.
@@ -65,7 +85,27 @@ declare class ChoiceMenuOptionClose<T extends {} = {}> {
      */
     type: CloseType;
     /**
-     * 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>
+     * ```
      */
     props: StorageObjectType;
     /**
@@ -88,7 +128,27 @@ type IStoratedChoiceMenuOption = {
      */
     type: LabelRunModeType;
     /**
-     * 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>
+     * ```
      */
     props: StorageObjectType;
 } | {

package/dist/classes/ChoiceMenuOption.d.ts

@@ -1,17 +1,17 @@
 import { LabelIdType } from '../types/LabelIdType.js';
 import { StorageObjectType } from '../types/StorageElementType.js';
-import Label from './Label.js';
+import { L as Label } from '../LabelProps-CFV-zRjG.js';
 import { CloseType } from '../types/CloseType.js';
 import LabelRunModeType from '../types/LabelRunModeType.js';
-import '../types/StepHistoryDataType.js';
 import '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../types/StepHistoryDataType.js';
 
 /**
  * ChoiceMenuOption is a class that contains a Label and a text that will be displayed in the menu.
  * @example
  * ```typescript
- * new ChoiceMenuOption("Hello", HelloLabel)
+ * new ChoiceMenuOption("Hello", HelloLabel, {})
  * ```
  */
 declare class ChoiceMenuOption<T extends StorageObjectType> {
@@ -28,16 +28,36 @@ declare class ChoiceMenuOption<T extends StorageObjectType> {
      */
     type: LabelRunModeType;
     /**
-     * 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>
+     * ```
      */
     props: StorageObjectType;
     /**
      * @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 props Properties to be passed to the label and olther parameters that you can use when get all the choice menu options. It be converted to a JSON string, so it cannot contain functions or classes.
      * @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: string, label: Label<T> | LabelIdType, type?: LabelRunModeType, props?: T);
+    constructor(text: string, label: Label<T> | LabelIdType, props: T, type?: LabelRunModeType);
 }
 /**
  * ChoiceMenuOptionClose is a class that contains a text that will be displayed in the menu.
@@ -65,7 +85,27 @@ declare class ChoiceMenuOptionClose<T extends {} = {}> {
      */
     type: CloseType;
     /**
-     * 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>
+     * ```
      */
     props: StorageObjectType;
     /**
@@ -88,7 +128,27 @@ type IStoratedChoiceMenuOption = {
      */
     type: LabelRunModeType;
     /**
-     * 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>
+     * ```
      */
     props: StorageObjectType;
 } | {

package/dist/classes/ChoiceMenuOption.js

@@ -135,8 +135,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);
@@ -169,6 +167,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* () {
@@ -549,14 +549,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}
@@ -593,18 +594,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
-   * @example
-   * ```typescript
-   * newLabel("id", [], () => {
-   *     Assets.load('path/to/image1.png')
-   *     Assets.load('path/to/image2.png')
-   * })
-   * ```
    */
-  get onStepRun() {
-    return this._onStepRun;
+  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
+   */
+  get onStepEnd() {
+    return this._onStepEnd;
   }
   get choiseIndex() {
     return this._choiseIndex;
@@ -614,7 +629,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/types/CloseType.ts
@@ -700,8 +717,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") {
@@ -720,22 +738,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;
@@ -748,15 +769,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") {
@@ -796,7 +815,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([
@@ -804,7 +826,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") {
@@ -832,7 +854,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([
@@ -844,15 +869,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];
@@ -919,7 +942,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);
@@ -1723,12 +1749,32 @@ 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 props Properties to be passed to the label and olther parameters that you can use when get all the choice menu options. It be converted to a JSON string, so it cannot contain functions or classes.
    * @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) {
+  constructor(text, label, props, type = "call") {
     /**
-     * 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 = {};
     if (typeof label === "string") {
@@ -1762,7 +1808,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;