@drincs/pixi-vn 0.3.3 → 0.3.5

package/dist/index.mjs

@@ -724,6 +724,11 @@ 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;
@@ -1941,15 +1946,18 @@ var _GameStepManager = class _GameStepManager {
   /* Run Methods */
   /**
    * Execute the next step and add it to the history.
-   * @returns
+   * @returns StepLabelResultType or undefined.
    * @example
    * ```typescript
    *     function nextOnClick() {
    *     setLoading(true)
    *     GameStepManager.runNextStep()
-   *         .then(() => {
+   *         .then((result) => {
    *             setUpdate((p) => p + 1)
    *             setLoading(false)
+   *             if (result) {
+   *                 // your code
+   *             }
    *         })
    *         .catch((e) => {
    *             setLoading(false)
@@ -1970,7 +1978,7 @@ var _GameStepManager = class _GameStepManager {
   }
   /**
    * Execute the current step and add it to the history.
-   * @returns 
+   * @returns StepLabelResultType or undefined.
    */
   static runCurrentStep() {
     return __async(this, null, function* () {
@@ -1988,11 +1996,12 @@ var _GameStepManager = class _GameStepManager {
         let n = currentLabel.steps.length;
         if (n > lasteStepsLength) {
           let nextStep = currentLabel.steps[lasteStepsLength];
-          yield nextStep();
+          let result = yield nextStep();
           _GameStepManager.addStepHistory(nextStep);
+          return result;
         } else if (n === lasteStepsLength) {
           _GameStepManager.closeCurrentLabel();
-          yield _GameStepManager.runNextStep();
+          return yield _GameStepManager.runNextStep();
         } else {
           console.warn("[Pixi'VN] There are no steps to run");
         }
@@ -2003,10 +2012,21 @@ 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.
-   * @returns
+   * @returns StepLabelResultType or undefined.
    * @example
    * ```typescript
-   * GameStepManager.callLabel(StartLabel)
+   * GameStepManager.callLabel(StartLabel).then((result) => {
+   *     if (result) {
+   *         // your code
+   *     }
+   * })
+   * ```
+   * @example
+   * ```typescript
+   * // if you use it in a step label you should return the result.
+   * return GameStepManager.callLabel(StartLabel).then((result) => {
+   *     return result
+   * })
    * ```
    */
   static callLabel(label) {
@@ -2027,11 +2047,22 @@ 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 
-   * @returns
+   * @param label The label to execute.
+   * @returns StepLabelResultType or undefined.
+   * @example
+   * ```typescript
+   * GameStepManager.jumpLabel(StartLabel).then((result) => {
+   *     if (result) {
+   *         // your code
+   *     }
+   * })
+   * ```
    * @example
    * ```typescript
-   * GameStepManager.jumpLabel(StartLabel)
+   * // if you use it in a step label you should return the result.
+   * return GameStepManager.jumpLabel(StartLabel).then((result) => {
+   *     return result
+   * })
    * ```
    */
   static jumpLabel(label) {
@@ -2299,6 +2330,10 @@ var StoredClassModel = class {
 
 // src/classes/CharacterBaseModel.ts
 var CharacterBaseModel2 = class extends StoredClassModel {
+  /**
+   * @param id The id of the character.
+   * @param props The properties of the character.
+   */
   constructor(id, props) {
     super(GameStorageManager.keysSystem.CHARACTER_CATEGORY_KEY, id);
     this.defaultName = "";
@@ -2308,27 +2343,45 @@ var CharacterBaseModel2 = class extends StoredClassModel {
     this._icon = props.icon;
     this._color = props.color;
   }
+  /***
+   * The name of the character.
+   * If you set undefined, it will return the default name.
+   */
   get name() {
     return this.getStorageProperty("name") || this.defaultName;
   }
   set name(value) {
     this.setStorageProperty("name", value);
   }
+  /**
+   * The surname of the character.
+   * If you set undefined, it will return the default surname.
+   */
   get surname() {
     return this.getStorageProperty("surname") || this.defaultSurname;
   }
   set surname(value) {
     this.setStorageProperty("surname", value);
   }
+  /**
+   * The age of the character.
+   * If you set undefined, it will return the default age.
+   */
   get age() {
     return this.getStorageProperty("age") || this.defaultAge;
   }
   set age(value) {
     this.setStorageProperty("age", value);
   }
+  /**
+   * The icon of the character.
+   */
   get icon() {
     return this._icon;
   }
+  /**
+   * The color of the character.
+   */
   get color() {
     return this._color;
   }
@@ -2357,17 +2410,27 @@ var ChoiceMenuOptionLabel = class {
 
 // src/classes/DialogueBaseModel.ts
 var DialogueBaseModel = class {
-  constructor(text, character) {
+  /**
+   * @param text The text of the dialogue.
+   * @param character The id of the character that is speaking. 
+   * @param oltherParams Other parameters that can be stored in the dialogue.
+   */
+  constructor(text, character, oltherParams = {}) {
     /**
      * The text of the dialogue.
      */
     this.text = "";
+    /**
+     * Other parameters that can be stored in the dialogue.
+     */
+    this.oltherParams = {};
     this.text = text;
     if (typeof character === "string") {
       this.characterId = character;
     } else {
       this.characterId = character == null ? void 0 : character.id;
     }
+    this.oltherParams = oltherParams;
   }
 };