@drincs/pixi-vn 0.6.5 → 0.6.7

package/dist/interface/IHistoryStep.d.mts

@@ -7,9 +7,11 @@ import DialogueBaseModel from '../classes/DialogueBaseModel.mjs';
 import { LabelIdType } from '../types/LabelIdType.mjs';
 import { StepHistoryDataType } from '../types/StepHistoryDataType.mjs';
 import '../types/StorageElementType.mjs';
-import '../LabelProps-CmRpvUJm.mjs';
+import '../classes/Label.mjs';
 import '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.mjs';
+import './LabelProps.mjs';
 import '../types/CloseType.mjs';
 import '../types/LabelRunModeType.mjs';
 import './canvas/ICanvasBaseMemory.mjs';

package/dist/interface/IHistoryStep.d.ts

@@ -7,9 +7,11 @@ import DialogueBaseModel from '../classes/DialogueBaseModel.js';
 import { LabelIdType } from '../types/LabelIdType.js';
 import { StepHistoryDataType } from '../types/StepHistoryDataType.js';
 import '../types/StorageElementType.js';
-import '../LabelProps-CFV-zRjG.js';
+import '../classes/Label.js';
 import '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.js';
+import './LabelProps.js';
 import '../types/CloseType.js';
 import '../types/LabelRunModeType.js';
 import './canvas/ICanvasBaseMemory.js';

package/dist/interface/ISaveData.d.mts

@@ -14,10 +14,12 @@ import './IHistoryStep.mjs';
 import 'deep-diff';
 import '../classes/ChoiceMenuOption.mjs';
 import '../types/LabelIdType.mjs';
-import '../LabelProps-CmRpvUJm.mjs';
+import '../classes/Label.mjs';
 import '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.mjs';
 import '../types/StepHistoryDataType.mjs';
+import './LabelProps.mjs';
 import '../types/CloseType.mjs';
 import '../types/LabelRunModeType.mjs';
 import './IOpenedLabel.mjs';

package/dist/interface/ISaveData.d.ts

@@ -14,10 +14,12 @@ import './IHistoryStep.js';
 import 'deep-diff';
 import '../classes/ChoiceMenuOption.js';
 import '../types/LabelIdType.js';
-import '../LabelProps-CFV-zRjG.js';
+import '../classes/Label.js';
 import '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.js';
 import '../types/StepHistoryDataType.js';
+import './LabelProps.js';
 import '../types/CloseType.js';
 import '../types/LabelRunModeType.js';
 import './IOpenedLabel.js';

package/dist/interface/LabelProps.d.mts

@@ -1,5 +1,38 @@
-export { a as default } from '../LabelProps-CmRpvUJm.mjs';
-import '../types/LabelIdType.mjs';
-import '../types/StepLabelType.mjs';
-import '@drincs/pixi-vn/dist/override';
-import '../types/StepHistoryDataType.mjs';
+interface LabelProps<T> {
+    /**
+     * 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 stepIndex Step index
+     * @param label Label
+     * @returns
+     * @example
+     * ```typescript
+     * newLabel("id", [], {
+     *     onStepStart: async (stepIndex, label) => {
+     *         await Assets.load('path/to/image1.png')
+     *         await Assets.load('path/to/image2.png')
+     *     }
+     * })
+     * ```
+     */
+    onStepStart?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * 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.
+     * @param stepIndex Step index
+     * @param label Label
+     * @returns
+     */
+    onLoadStep?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * Is a function that will be executed when the step ends.
+     * @param stepIndex Step index
+     * @param label Label
+     * @returns
+     */
+    onStepEnd?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * Is the index of the choice that the label will perform. This variable is used in the system.
+     */
+    choiseIndex?: number;
+}
+
+export type { LabelProps as default };

package/dist/interface/LabelProps.d.ts

@@ -1,5 +1,38 @@
-export { a as default } from '../LabelProps-CFV-zRjG.js';
-import '../types/LabelIdType.js';
-import '../types/StepLabelType.js';
-import '@drincs/pixi-vn/dist/override';
-import '../types/StepHistoryDataType.js';
+interface LabelProps<T> {
+    /**
+     * 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 stepIndex Step index
+     * @param label Label
+     * @returns
+     * @example
+     * ```typescript
+     * newLabel("id", [], {
+     *     onStepStart: async (stepIndex, label) => {
+     *         await Assets.load('path/to/image1.png')
+     *         await Assets.load('path/to/image2.png')
+     *     }
+     * })
+     * ```
+     */
+    onStepStart?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * 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.
+     * @param stepIndex Step index
+     * @param label Label
+     * @returns
+     */
+    onLoadStep?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * Is a function that will be executed when the step ends.
+     * @param stepIndex Step index
+     * @param label Label
+     * @returns
+     */
+    onStepEnd?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * Is the index of the choice that the label will perform. This variable is used in the system.
+     */
+    choiseIndex?: number;
+}
+
+export type { LabelProps as default };

package/dist/interface/export/ExportedStep.d.mts

@@ -14,10 +14,12 @@ import '../TickerHistory.mjs';
 import 'deep-diff';
 import '../../classes/ChoiceMenuOption.mjs';
 import '../../types/LabelIdType.mjs';
-import '../../LabelProps-CmRpvUJm.mjs';
+import '../../classes/Label.mjs';
 import '../../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../../classes/LabelAbstract.mjs';
 import '../../types/StepHistoryDataType.mjs';
+import '../LabelProps.mjs';
 import '../../types/CloseType.mjs';
 import '../../types/LabelRunModeType.mjs';
 import '../../classes/DialogueBaseModel.mjs';

package/dist/interface/export/ExportedStep.d.ts

@@ -14,10 +14,12 @@ import '../TickerHistory.js';
 import 'deep-diff';
 import '../../classes/ChoiceMenuOption.js';
 import '../../types/LabelIdType.js';
-import '../../LabelProps-CFV-zRjG.js';
+import '../../classes/Label.js';
 import '../../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../../classes/LabelAbstract.js';
 import '../../types/StepHistoryDataType.js';
+import '../LabelProps.js';
 import '../../types/CloseType.js';
 import '../../types/LabelRunModeType.js';
 import '../../classes/DialogueBaseModel.js';

package/dist/interface/export/index.d.mts

@@ -14,10 +14,12 @@ import '../IHistoryStep.mjs';
 import 'deep-diff';
 import '../../classes/ChoiceMenuOption.mjs';
 import '../../types/LabelIdType.mjs';
-import '../../LabelProps-CmRpvUJm.mjs';
+import '../../classes/Label.mjs';
 import '../../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../../classes/LabelAbstract.mjs';
 import '../../types/StepHistoryDataType.mjs';
+import '../LabelProps.mjs';
 import '../../types/CloseType.mjs';
 import '../../types/LabelRunModeType.mjs';
 import '../IOpenedLabel.mjs';

package/dist/interface/export/index.d.ts

@@ -14,10 +14,12 @@ import '../IHistoryStep.js';
 import 'deep-diff';
 import '../../classes/ChoiceMenuOption.js';
 import '../../types/LabelIdType.js';
-import '../../LabelProps-CFV-zRjG.js';
+import '../../classes/Label.js';
 import '../../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../../classes/LabelAbstract.js';
 import '../../types/StepHistoryDataType.js';
+import '../LabelProps.js';
 import '../../types/CloseType.js';
 import '../../types/LabelRunModeType.js';
 import '../IOpenedLabel.js';

package/dist/interface/index.d.mts

@@ -5,7 +5,7 @@ export { default as IOpenedLabel } from './IOpenedLabel.mjs';
 export { default as ISaveData } from './ISaveData.mjs';
 export { I as ITicker } from '../TickerBase-DKYzbzro.mjs';
 export { default as ITickersSteps } from './ITickersSteps.mjs';
-export { a as LabelProps } from '../LabelProps-CmRpvUJm.mjs';
+export { default as LabelProps } from './LabelProps.mjs';
 export { default as TickerHistory, TickerHistoryForExport } from './TickerHistory.mjs';
 export { TickerProgrationType } from './TickerProgrationType.mjs';
 export { default as TickerTimeoutHistory } from './TickerTimeoutHistory.mjs';
@@ -19,14 +19,16 @@ import '../types/StorageElementType.mjs';
 import 'deep-diff';
 import '../classes/ChoiceMenuOption.mjs';
 import '../types/LabelIdType.mjs';
+import '../classes/Label.mjs';
+import '../types/StepLabelType.mjs';
+import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.mjs';
+import '../types/StepHistoryDataType.mjs';
 import './export/ExportedCanvas.mjs';
 import './canvas/ICanvasBaseMemory.mjs';
 import './export/ExportedStorage.mjs';
-import '../types/StepHistoryDataType.mjs';
 import './export/ExportedStep.mjs';
 import 'pixi.js';
 import '../types/TickerIdType.mjs';
 import '../types/PauseType.mjs';
 import '../types/RepeatType.mjs';
-import '../types/StepLabelType.mjs';
-import '@drincs/pixi-vn/dist/override';

package/dist/interface/index.d.ts

@@ -5,7 +5,7 @@ export { default as IOpenedLabel } from './IOpenedLabel.js';
 export { default as ISaveData } from './ISaveData.js';
 export { I as ITicker } from '../TickerBase-3rLpDpmb.js';
 export { default as ITickersSteps } from './ITickersSteps.js';
-export { a as LabelProps } from '../LabelProps-CFV-zRjG.js';
+export { default as LabelProps } from './LabelProps.js';
 export { default as TickerHistory, TickerHistoryForExport } from './TickerHistory.js';
 export { TickerProgrationType } from './TickerProgrationType.js';
 export { default as TickerTimeoutHistory } from './TickerTimeoutHistory.js';
@@ -19,14 +19,16 @@ import '../types/StorageElementType.js';
 import 'deep-diff';
 import '../classes/ChoiceMenuOption.js';
 import '../types/LabelIdType.js';
+import '../classes/Label.js';
+import '../types/StepLabelType.js';
+import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.js';
+import '../types/StepHistoryDataType.js';
 import './export/ExportedCanvas.js';
 import './canvas/ICanvasBaseMemory.js';
 import './export/ExportedStorage.js';
-import '../types/StepHistoryDataType.js';
 import './export/ExportedStep.js';
 import 'pixi.js';
 import '../types/TickerIdType.js';
 import '../types/PauseType.js';
 import '../types/RepeatType.js';
-import '../types/StepLabelType.js';
-import '@drincs/pixi-vn/dist/override';

package/dist/labels/BaseCanvasElementTestLabel.d.mts

@@ -1,8 +1,10 @@
-import { L as Label } from '../LabelProps-CmRpvUJm.mjs';
+import Label from '../classes/Label.mjs';
 import '../types/LabelIdType.mjs';
 import '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.mjs';
 import '../types/StepHistoryDataType.mjs';
+import '../interface/LabelProps.mjs';
 
 declare const baseCanvasElementTestLabel: Label<{}>;
 

package/dist/labels/BaseCanvasElementTestLabel.d.ts

@@ -1,8 +1,10 @@
-import { L as Label } from '../LabelProps-CFV-zRjG.js';
+import Label from '../classes/Label.js';
 import '../types/LabelIdType.js';
 import '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.js';
 import '../types/StepHistoryDataType.js';
+import '../interface/LabelProps.js';
 
 declare const baseCanvasElementTestLabel: Label<{}>;
 

package/dist/labels/BaseCanvasElementTestLabel.js

@@ -559,16 +559,14 @@ 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 props is the properties of the label
    */
-  constructor(id, steps, props) {
+  constructor(id, props) {
     this._id = id;
-    this._steps = steps;
     this._onStepStart = props == null ? void 0 : props.onStepStart;
     this._onLoadStep = props == null ? void 0 : props.onLoadStep;
     this._onStepEnd = props == null ? void 0 : props.onStepEnd;
@@ -580,17 +578,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
@@ -641,6 +628,28 @@ var Label = class {
   }
 };
 
+// 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/classes/CloseLabel.ts
 var CLOSE_LABEL_ID = "__close-label-id__";
 function newCloseLabel(choiseIndex) {
@@ -652,6 +661,106 @@ function newCloseLabel(choiseIndex) {
 // src/types/CloseType.ts
 var Close = "close";
 
+// 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 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"
+   */
+  constructor(text, label, props, type = "call") {
+    /**
+     * 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;
+    this._label = label;
+    this.type = type;
+    if (props) {
+      this.props = props;
+    }
+  }
+  /**
+   * Label to be opened when the option is selected
+   */
+  get label() {
+    let label = this._label;
+    if (typeof label === "string") {
+      let res = getLabelById(label);
+      if (res) {
+        label = res;
+      } else {
+        console.error(`Label ${label} not found, so it will be closed`);
+        label = newCloseLabel();
+      }
+    }
+    return label;
+  }
+};
+var ChoiceMenuOptionClose = class {
+  /**
+   * @param text Text to be displayed in the menu
+   * @param closeCurrentLabel If true, the current label will be closed. @default false
+   */
+  constructor(text, closeCurrentLabel = false) {
+    /**
+     * Label to be opened when the option is selected
+     */
+    this.label = newCloseLabel();
+    /**
+     * Type of the label to be opened
+     */
+    this.type = Close;
+    /**
+     * 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;
+    this.closeCurrentLabel = closeCurrentLabel;
+  }
+};
+
 // src/functions/DialogueUtility.ts
 function setDialogue(props) {
   let text = "";
@@ -686,13 +795,9 @@ function getChoiceMenuOptions() {
     d.forEach((option, index) => {
       if (option.type === Close) {
         let itemLabel = newCloseLabel(index);
-        options.push({
-          text: option.text,
-          label: itemLabel,
-          type: Close,
-          closeCurrentLabel: option.closeCurrentLabel,
-          props: {}
-        });
+        let choice = new ChoiceMenuOptionClose(option.text, option.closeCurrentLabel);
+        choice.label = itemLabel;
+        options.push(choice);
         return;
       }
       let label = getLabelById(option.label);
@@ -701,9 +806,7 @@ function getChoiceMenuOptions() {
           onStepStart: label.onStepStart,
           choiseIndex: index
         });
-        options.push(__spreadProps(__spreadValues({}, option), {
-          label: itemLabel
-        }));
+        options.push(new ChoiceMenuOption(option.text, itemLabel, option.props, option.type));
       }
     });
     return options;