@drincs/nqtr 0.2.2 → 0.2.4

package/dist/classes/index.mjs

@@ -613,6 +613,9 @@ var ActivityRoom = class extends ActivityStoredAbstract {
   get id() {
     return this._id;
   }
+  /**
+   * The room where the activity is.
+   */
   get room() {
     return this._room;
   }
@@ -919,6 +922,53 @@ var Goal = class extends StoredClassModel {
     return this._defaultHave;
   }
 };
+var GoalStage = class extends Goal {
+  constructor(id, stageId, props) {
+    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;
+  }
+  set have(value) {
+    if (!this._stageId) {
+      console.error(`[NQTR] The stage id is not set for the goal ${this.id}, so the have value can't be set.`);
+      return;
+    }
+    this.setStorageProperty("have-" + this._stageId, value);
+  }
+  /**
+   * If the goal is completed.
+   */
+  get completed() {
+    return this.have >= this.need;
+  }
+  set completed(value) {
+    if (value) {
+      this.have = this.need;
+    } else {
+      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++;
+  }
+};
 
 // src/classes/quest/Stage.ts
 var STAGE_CATEGORY = "__nqtr-stage__";
@@ -932,9 +982,9 @@ var Stage = class extends StoredClassModel {
     this._adviceDescription = props.adviceDescription || "";
     this._renderImage = props.renderImage;
     this._daysRequiredToStart = props.daysRequiredToStart;
-    this._flagsRequiredToStart = props.flagsRequired || [];
-    this._questsRequiredToStart = props.questsRequired || [];
-    this._requestDescriptionToStart = props.requestDescription || "";
+    this._flagsRequiredToStart = props.flagsRequiredToStart || [];
+    this._questsRequiredToStart = props.questsRequiredToStart || [];
+    this._requestDescriptionToStart = props.requestDescriptionToStart || "";
     this._onStart = props.onStart;
     this._onEnd = props.onEnd;
   }
@@ -1021,6 +1071,336 @@ var Stage = class extends StoredClassModel {
     return this._onEnd;
   }
 };
+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) {
+      return storedCompleted;
+    }
+    if (this.flags.length > 0 && this.goals.length > 0) {
+      if (!this.flags.every((flag) => getFlag(flag.flag))) {
+        return false;
+      }
+      if (!this.goals.every((goal) => goal.completed)) {
+        return false;
+      }
+      return true;
+    }
+    return false;
+  }
+  set completed(value) {
+    this.setStorageProperty("completed", value);
+  }
+  /**
+   * If the stage is started.
+   */
+  get started() {
+    return this.getStorageProperty("started") || false;
+  }
+  set started(value) {
+    this.setStorageProperty("started", value);
+  }
+  /**
+   * The list of goals that the player needs to complete to finish the stage.
+   */
+  get goals() {
+    return this.defaultGoals.map((goal) => {
+      return new GoalStage(goal.id, this.id, goal);
+    });
+  }
+  get prevStageEndDay() {
+    return this.getStorageProperty("prevStageEndDay");
+  }
+  set prevStageEndDay(value) {
+    this.setStorageProperty("prevStageEndDay", value);
+  }
+  /**
+   * The day when the stage starts.
+   */
+  get startDay() {
+    let prevStageEndDay = this.prevStageEndDay;
+    if (prevStageEndDay === void 0) {
+      return void 0;
+    }
+    return prevStageEndDay + this.daysRequiredToStart;
+  }
+  /**
+   * Check if the stage can start.
+   */
+  get canStart() {
+    let daysRequired = this.daysRequiredToStart;
+    if (daysRequired > 0) {
+      let prevStageEndDay = this.prevStageEndDay;
+      if (prevStageEndDay === void 0) {
+        return false;
+      }
+      if (prevStageEndDay + daysRequired > TimeManager.currentDay) {
+        return false;
+      }
+    }
+    if (this.flagsRequiredToStart.length > 0 && !this.flagsRequiredToStart.every((flag) => getFlag(flag.flag))) {
+      return false;
+    }
+    if (this.questsRequiredToStart.length > 0 && !this.questsRequiredToStart.every(
+      (q) => q.quest.currentStageIndex && q.quest.currentStageIndex >= q.stageNumber
+    )) {
+      return false;
+    }
+    return true;
+  }
+  /**
+   * Inizialize the stage. **This function should be called only by the Quest class.**
+   */
+  inizialize() {
+    if (this.daysRequiredToStart > 0) {
+      this.prevStageEndDay = TimeManager.currentDay;
+      console.log(`[NQTR] Stage ${this.id} will start on day ${this.startDay}`);
+    }
+  }
+  /**
+   * The function that will be called when the stage starts.
+   */
+  start(props) {
+    if (this.canStart) {
+      this.started = true;
+      if (this.onStart) {
+        this.onStart(props);
+      }
+    } else {
+      console.warn(`[NQTR] Stage ${this.id} can't start`);
+    }
+  }
+};
+
+// src/classes/quest/Quest.ts
+var QUEST_CATEGORY = "__nqtr-quest__";
+var Quest = class extends StoredClassModel {
+  constructor(id, stages, props) {
+    super(QUEST_CATEGORY, id);
+    this._stages = stages;
+    this._name = props.name || "";
+    this._description = props.description || "";
+    this._renderIcon = props.renderIcon;
+    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;
+  }
+  /**
+   * The function for rendering the icon of the quest.
+   */
+  get renderIcon() {
+    let render = this._renderIcon;
+    if (render === void 0) {
+      return void 0;
+    }
+    if (typeof render === "function") {
+      return (props) => {
+        return render(this, props);
+      };
+    }
+    return (props) => render;
+  }
+  /**
+   * The function for rendering the image of the quest.
+   */
+  get renderImage() {
+    let render = this._renderImage;
+    if (render === void 0) {
+      return void 0;
+    }
+    if (typeof render === "function") {
+      return (props) => {
+        return render(this, props);
+      };
+    }
+    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) {
+      return void 0;
+    }
+    return this.stages[index];
+  }
+  /**
+   * If the quest is started.
+   */
+  get started() {
+    return this.currentStageIndex !== void 0;
+  }
+  /**
+   * If the quest is completed.
+   */
+  get completed() {
+    if (this.currentStageIndex === void 0) {
+      return false;
+    }
+    return this.currentStageIndex > this.stages.length - 1;
+  }
+  /**
+   * 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`);
+      return;
+    }
+    if (this.stages.length === 0) {
+      console.error(`[NQTR] Quest ${this.id} has no stages`);
+      return;
+    }
+    this.currentStageIndex = 0;
+    let currentStage = this.currentStage;
+    if (currentStage && currentStage.start) {
+      return currentStage.start(props);
+    } else {
+      console.error(`[NQTR] Quest ${this.id} has no start stage`);
+    }
+  }
+  /**
+   * Go to the next stage if the current stage is completed.
+   * If you want to force the change of stage, use goNextStage.
+   * @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 false;
+    }
+    if (this.completed) {
+      return false;
+    }
+    let currentStage = this.currentStage;
+    if (!currentStage) {
+      console.error(`[NQTR] Quest ${this.id} has no current stage`);
+      return false;
+    }
+    if (currentStage.completed) {
+      return this.goNextStage(startProps, endProps);
+    }
+    return false;
+  }
+  /**
+   * Complete the current stage and go to the next stage.
+   * If you want to go to the next stage only if the current stage is completed, use tryToGoNextStage.
+   * @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.
+   */
+  completeCurrentStageAndGoNext(startProps, endProps) {
+    let currentStage = this.currentStage;
+    if (!currentStage) {
+      console.error(`[NQTR] Quest ${this.id} has no current stage`);
+      return false;
+    }
+    currentStage.completed = true;
+    return this.goNextStage(startProps, endProps);
+  }
+  /**
+   * Go to the next stage without checking if the current stage is completed.
+   * If you want to go to the next stage only if the current stage is completed, use tryToGoNextStage.
+   * @param startProps 
+   * @param endProps 
+   * @returns returns true if the stage was changed, false otherwise.
+   */
+  goNextStage(startProps, endProps) {
+    if (!this.started) {
+      console.warn(`[NQTR] Quest ${this.id} is not started`);
+      return false;
+    }
+    if (this.completed) {
+      console.warn(`[NQTR] Quest ${this.id} is already completed`);
+      return false;
+    }
+    let prevStage = this.currentStage;
+    let currentStageIndex = this.currentStageIndex;
+    if (!prevStage || currentStageIndex === void 0) {
+      console.error(`[NQTR] Quest ${this.id} has no current stage`);
+      return false;
+    }
+    this.currentStageIndex = currentStageIndex + 1;
+    if (prevStage && prevStage.onEnd) {
+      prevStage.onEnd(endProps);
+    }
+    let nextCurrentStage = this.currentStage;
+    if (nextCurrentStage) {
+      nextCurrentStage.inizialize();
+      if (this.currentStageMustStart) {
+        this.startCurrentStage(startProps);
+      }
+    }
+    return true;
+  }
+  /**
+   * If the current stage must start. It is true if the current stage is not started, can start and not completed.
+   */
+  get currentStageMustStart() {
+    let currentStage = this.currentStage;
+    if (!currentStage) {
+      return false;
+    }
+    return !currentStage.started && currentStage.canStart && !currentStage.completed;
+  }
+  /**
+   * Start the current stage.
+   * @param props The properties for the start stage. If you not want to pass any property, you can pass an {}.
+   */
+  startCurrentStage(props) {
+    let newCurrentStage = this.currentStage;
+    if (newCurrentStage && this.currentStageMustStart) {
+      newCurrentStage.start(props);
+    } else {
+      console.warn(`[NQTR] Quest ${this.id} can't start the current stage`);
+    }
+  }
+};
 
 // src/functions/RoutineFunctions.ts
 function getCurrentRoutine() {
@@ -1058,7 +1438,7 @@ function getCurrentRoutine() {
 
 // src/classes/navigation/Room.ts
 var ROOM_CATEGORY = "__nqtr-room__";
-var RoomBaseModel = class extends StoredClassModel {
+var RoomBaseModel2 = class extends StoredClassModel {
   /**
    * @param id The id of the room, it must be unique.
    * @param location The location where the room is.
@@ -1293,6 +1673,6 @@ var RoomBaseModel = class extends StoredClassModel {
   }
 };
 
-export { ActivityRoom, CommitmentBaseModel, Goal, LocationBaseModel, MapBaseModel, RoomBaseModel, Stage };
+export { ActivityRoom, CommitmentBaseModel, Goal, LocationBaseModel, MapBaseModel, Quest, RoomBaseModel2 as RoomBaseModel, Stage };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.mjs.map