@drincs/nqtr 0.2.0 → 0.2.1

package/dist/index.js

@@ -1084,7 +1084,7 @@ function addCommitment(commitment) {
     }
     return commitment2.id;
   }).filter((id) => id !== void 0);
-  pixiVn.GameStorageManager.setVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY, [commitmentsIds]);
+  pixiVn.GameStorageManager.setVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY, commitmentsIds);
 }
 function removeCommitment(commitment) {
   if (!Array.isArray(commitment)) {
@@ -1125,9 +1125,15 @@ var Goal = class extends pixiVn.StoredClassModel {
   get description() {
     return this._description;
   }
+  /**
+   * The number of times the goal must be completed.
+   */
   get need() {
     return this._need;
   }
+  /**
+   * The default number of times the goal has been completed.
+   */
   get defaultHave() {
     return this._defaultHave;
   }
@@ -1137,12 +1143,18 @@ var GoalStage = class extends Goal {
     super(id, props);
     this._stageId = stageId;
   }
+  /**
+   * The id of the stage that the goal belongs to.
+   */
   get stageId() {
     return this._stageId;
   }
   set stageId(value) {
     this._stageId = value;
   }
+  /**
+   * The number of times the goal has been completed.
+   */
   get have() {
     return this.getStorageProperty("have-" + this._stageId) || this.defaultHave;
   }
@@ -1153,6 +1165,9 @@ var GoalStage = class extends Goal {
     }
     this.setStorageProperty("have-" + this._stageId, value);
   }
+  /**
+   * If the goal is completed.
+   */
   get completed() {
     return this.have >= this.need;
   }
@@ -1163,6 +1178,9 @@ var GoalStage = class extends Goal {
       console.warn(`[NQTR] The goal can't be set as not completed. You must edit the have value manually.`);
     }
   }
+  /**
+   * Find the goal. It will increment the have value.
+   */
   find() {
     this.have++;
   }
@@ -1186,12 +1204,21 @@ var Stage = class extends pixiVn.StoredClassModel {
     this._onStart = props.onStart;
     this._onEnd = props.onEnd;
   }
+  /**
+   * The name of the stage.
+   */
   get name() {
     return this._name;
   }
+  /**
+   * The description of the stage.
+   */
   get description() {
     return this._description;
   }
+  /**
+   * The advice description of the stage.
+   */
   get adviceDescription() {
     return this._adviceDescription;
   }
@@ -1210,6 +1237,10 @@ var Stage = class extends pixiVn.StoredClassModel {
     }
     return (props) => render;
   }
+  /**
+   * The list of goals that the player needs to complete to finish the stage.
+   * This is the list set by the developer. if you want to get the current goals, use the goals property.
+   */
   get defaultGoals() {
     return this._defaultGoals;
   }
@@ -1219,21 +1250,39 @@ var Stage = class extends pixiVn.StoredClassModel {
   get flags() {
     return this._flags;
   }
+  /**
+   * The number of days required to start the stage.
+   */
   get daysRequiredToStart() {
     return this._daysRequiredToStart || 0;
   }
+  /**
+   * The list of flags required to start the stage.
+   */
   get flagsRequiredToStart() {
     return this._flagsRequiredToStart;
   }
+  /**
+   * The list of quests required to start the stage.
+   */
   get questsRequiredToStart() {
     return this._questsRequiredToStart || [];
   }
+  /**
+   * The description of the request to start the stage.
+   */
   get requestDescriptionToStart() {
     return this._requestDescriptionToStart;
   }
+  /**
+   * The function that will be called when the stage starts.
+   */
   get onStart() {
     return this._onStart;
   }
+  /**
+   * The function that will be called when the stage ends.
+   */
   get onEnd() {
     return this._onEnd;
   }
@@ -1242,6 +1291,10 @@ var StageQuest = class extends Stage {
   constructor(id, props) {
     super(id, props);
   }
+  /**
+   * Check if the flag and goals are completed.
+   * You can force the completion of the stage by setting the completed property to true.
+   */
   get completed() {
     let storedCompleted = this.getStorageProperty("completed");
     if (storedCompleted) {
@@ -1272,6 +1325,9 @@ var StageQuest = class extends Stage {
   set prevStageEndDay(value) {
     this.setStorageProperty("prevStageEndDay", value);
   }
+  /**
+   * The day when the stage starts.
+   */
   get startDay() {
     let prevStageEndDay = this.prevStageEndDay;
     if (prevStageEndDay === void 0) {
@@ -1279,6 +1335,9 @@ var StageQuest = class extends Stage {
     }
     return prevStageEndDay + this.daysRequiredToStart;
   }
+  /**
+   * Check if the stage can start.
+   */
   get canStart() {
     let daysRequired = this.daysRequiredToStart;
     if (daysRequired > 0) {
@@ -1300,6 +1359,9 @@ var StageQuest = class extends Stage {
     }
     return true;
   }
+  /**
+   * The function that will be called when the stage starts.
+   */
   get onStart() {
     if (this.daysRequiredToStart > 0) {
       this.prevStageEndDay = TimeManager.currentDay;
@@ -1320,14 +1382,23 @@ var Quest = class extends pixiVn.StoredClassModel {
     this._renderImage = props.renderImage;
     this._isInDevelopment = props.isInDevelopment || false;
   }
+  /**
+   * The stages of the quest.
+   */
   get stages() {
     return this._stages.map((stage, index) => {
       return new StageQuest(stage.id, stage);
     });
   }
+  /**
+   * The name of the quest.
+   */
   get name() {
     return this._name;
   }
+  /**
+   * The description of the quest.
+   */
   get description() {
     return this._description;
   }
@@ -1361,15 +1432,24 @@ var Quest = class extends pixiVn.StoredClassModel {
     }
     return (props) => render;
   }
+  /**
+   * If the quest is in development.
+   */
   get isInDevelopment() {
     return this._isInDevelopment;
   }
+  /**
+   * The index of the current stage.
+   */
   get currentStageIndex() {
     return this.getStorageProperty("currentStageIndex");
   }
   set currentStageIndex(value) {
     this.setStorageProperty("currentStageIndex", value);
   }
+  /**
+   * The current stage.
+   */
   get currentStage() {
     let index = this.currentStageIndex;
     if (index === void 0 || index >= this.stages.length) {
@@ -1377,12 +1457,23 @@ var Quest = class extends pixiVn.StoredClassModel {
     }
     return this.stages[index];
   }
+  /**
+   * If the quest is started.
+   */
   get started() {
     return this.currentStageIndex !== void 0;
   }
+  /**
+   * If the quest is completed.
+   */
   get completed() {
     return this.currentStageIndex === this.stages.length;
   }
+  /**
+   * Start the quest.
+   * @param props The properties for the start stage. If you not want to pass any property, you can pass an {}.
+   * @returns 
+   */
   start(props) {
     if (this.started) {
       console.warn(`[NQTR] Quest ${this.id} is already started`);
@@ -1400,18 +1491,24 @@ var Quest = class extends pixiVn.StoredClassModel {
       console.error(`[NQTR] Quest ${this.id} has no start stage`);
     }
   }
+  /**
+   * Try to go to the next stage.
+   * @param startProps The properties for the start stage. If you not want to pass any property, you can pass an {}.
+   * @param endProps The properties for the end stage. If you not want to pass any property, you can pass an {}.
+   * @returns true if the stage was changed, false otherwise.
+   */
   tryToGoNextStage(startProps, endProps) {
     if (!this.started) {
-      return;
+      return false;
     }
     if (this.completed) {
-      return;
+      return false;
     }
     let currentStage = this.currentStage;
     let currentStageIndex = this.currentStageIndex;
     if (!currentStage || currentStageIndex === void 0) {
       console.error(`[NQTR] Quest ${this.id} has no current stage`);
-      return;
+      return false;
     }
     if (currentStage.completed) {
       let nextStageIndex = currentStageIndex + 1;
@@ -1421,9 +1518,11 @@ var Quest = class extends pixiVn.StoredClassModel {
         currentStage.onEnd(endProps);
       }
       if (nextStage && nextStage.onStart) {
-        return nextStage.onStart(startProps);
+        nextStage.onStart(startProps);
       }
+      return true;
     }
+    return false;
   }
 };