@drincs/nqtr 0.2.0 → 0.2.2

package/dist/decorators/index.js

@@ -2,95 +2,7 @@
 
 var pixiVn = require('@drincs/pixi-vn');
 
-// src/decorators/ActivityDecorator.ts
-var registeredActivities = {};
-function saveActivity(activity) {
-  if (Array.isArray(activity)) {
-    activity.forEach((c) => saveActivity(c));
-    return;
-  }
-  if (registeredActivities[activity.id]) {
-    console.warn(`[NQTR] Activity id ${activity.id} already exists, it will be overwritten`);
-  }
-  registeredActivities[activity.id] = activity;
-}
-function getActivityById(id) {
-  try {
-    let activity = registeredActivities[id];
-    if (!activity) {
-      console.error(`[NQTR] Activity ${id} not found`);
-      return;
-    }
-    return activity;
-  } catch (e) {
-    console.error(`[NQTR] Error while getting Activity ${id}`, e);
-    return;
-  }
-}
-var TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY = "___nqtr-temporary_commitment___";
-var registeredCommitments = {};
-var fixedCommitments = {};
-function saveCommitment(commitment) {
-  if (Array.isArray(commitment)) {
-    commitment.forEach((c) => saveCommitment(c));
-    return;
-  }
-  if (registeredCommitments[commitment.id]) {
-    console.warn(`[NQTR] Commitment id ${commitment.id} already exists, it will be overwritten`);
-  }
-  registeredCommitments[commitment.id] = commitment;
-}
-function getCommitmentById(id) {
-  try {
-    let commitment = registeredCommitments[id];
-    if (!commitment) {
-      console.error(`[NQTR] Commitment ${id} not found`);
-      return;
-    }
-    return commitment;
-  } catch (e) {
-    console.error(`[NQTR] Error while getting Commitment ${id}`, e);
-    return;
-  }
-}
-function setFixedRoutine(commitments) {
-  if (Array.isArray(commitments)) {
-    commitments.forEach((c) => setFixedRoutine(c));
-    return;
-  }
-  if (fixedCommitments[commitments.id]) {
-    console.warn(`[NQTR] Commitment id ${commitments.id} already exists, it will be overwritten`);
-  }
-  fixedCommitments[commitments.id] = commitments;
-}
-function addCommitment(commitment) {
-  if (!Array.isArray(commitment)) {
-    commitment = [commitment];
-  }
-  let commitmentsIds = commitment.map((commitment2) => {
-    let commitmentTest = getCommitmentById(commitment2.id);
-    if (!commitmentTest) {
-      console.warn(`[NQTR] Commitment ${commitment2.id} not found, it will be ignored`);
-      return void 0;
-    }
-    return commitment2.id;
-  }).filter((id) => id !== void 0);
-  pixiVn.GameStorageManager.setVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY, [commitmentsIds]);
-}
-function removeCommitment(commitment) {
-  if (!Array.isArray(commitment)) {
-    commitment = [commitment];
-  }
-  let commitmentsIds = commitment.map((commitment2) => {
-    return commitment2.id;
-  });
-  let currentCommitments = pixiVn.GameStorageManager.getVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY);
-  if (!currentCommitments) {
-    return;
-  }
-  currentCommitments = currentCommitments.filter((id) => !commitmentsIds.includes(id));
-  pixiVn.GameStorageManager.setVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY, currentCommitments);
-}
+// src/classes/Activity.ts
 var TIME_SETTINGS_KEY = "___nqtr-time_manager_settings___";
 var TIME_DATA_KEY = "___nqtr-time_manager_data___";
 var TimeManager = class _TimeManager {
@@ -333,6 +245,225 @@ var TimeManager = class _TimeManager {
     return currentHour >= fromHour || currentHour < toHour;
   }
 };
+
+// src/classes/Activity.ts
+var ActivityModel = class {
+  /**
+   * @param id The activity id, that must be unique.
+   * @param onRun The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function.
+   * @param props The activity properties.
+   */
+  constructor(id, onRun, props) {
+    this._id = id;
+    this._name = props.name;
+    this._fromHour = props.fromHour;
+    this._toHour = props.toHour;
+    this._fromDay = props.fromDay;
+    this._toDay = props.toDay;
+    this._disabled = props.disabled || false;
+    this._hidden = props.hidden || false;
+    this._renderIcon = props.renderIcon;
+    this._onRun = onRun;
+  }
+  /**
+   * The activity id, that is unique.
+   */
+  get id() {
+    return this._id;
+  }
+  /**
+   * The name
+   */
+  get name() {
+    return this._name;
+  }
+  /**
+   * The hour when the activity starts. If the activity is not started yet, it will be hidden.
+   */
+  get fromHour() {
+    return this._fromHour;
+  }
+  /**
+   * The hour when the activity ends. If the activity is ended yet, it will be hidden.
+   */
+  get toHour() {
+    return this._toHour;
+  }
+  /**
+   * The day when the activity starts. If the activity is not started yet, it will be hidden.
+   */
+  get fromDay() {
+    return this._fromDay;
+  }
+  /**
+   * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
+   */
+  get toDay() {
+    return this._toDay;
+  }
+  /**
+   * Whether is disabled.
+   */
+  get disabled() {
+    if (typeof this._disabled === "string") {
+      return pixiVn.getFlag(this._disabled);
+    }
+    return this._disabled;
+  }
+  /**
+   * Whether is hidden. If the activity is not started yet, it will be hidden.
+   */
+  get hidden() {
+    if (this.fromDay && this.fromDay > TimeManager.currentDay) {
+      return true;
+    }
+    if (!this.isDeadline) {
+      return true;
+    }
+    if (typeof this._hidden === "string") {
+      return pixiVn.getFlag(this._hidden);
+    }
+    return this._hidden;
+  }
+  /**
+   * The function for rendering the icon of the activity.
+   */
+  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;
+  }
+  get _initialOnRun() {
+    return this._onRun;
+  }
+  /**
+   * The function that is called when the activity is runned.
+   */
+  get run() {
+    return (props) => this._onRun(this, props);
+  }
+  /**
+   * Whether the activity is a deadline.
+   * @returns Whether the activity is a deadline.
+   */
+  isDeadline() {
+    if (this.toDay && this.toDay <= TimeManager.currentDay) {
+      return true;
+    }
+    return false;
+  }
+  /**
+   * Export the activity properties.
+   * @returns The activity properties.
+   */
+  export() {
+    return {
+      name: this._name,
+      fromHour: this._fromHour,
+      toHour: this._toHour,
+      fromDay: this._fromDay,
+      toDay: this._toDay,
+      disabled: this._disabled,
+      hidden: this._hidden,
+      renderIcon: this._renderIcon
+    };
+  }
+};
+
+// src/decorators/ActivityDecorator.ts
+var registeredActivities = {};
+function newActivity(id, onRun, props) {
+  if (registeredActivities[id]) {
+    console.warn(`[NQTR] Activity ${id} already exists, it will be overwritten`);
+  }
+  let activity = new ActivityModel(id, onRun, props);
+  registeredActivities[id] = activity;
+  return activity;
+}
+function getActivityById(id) {
+  try {
+    let activity = registeredActivities[id];
+    if (!activity) {
+      console.error(`[NQTR] Activity ${id} not found`);
+      return;
+    }
+    return activity;
+  } catch (e) {
+    console.error(`[NQTR] Error while getting Activity ${id}`, e);
+    return;
+  }
+}
+var TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY = "___nqtr-temporary_commitment___";
+var registeredCommitments = {};
+var fixedCommitments = {};
+function saveCommitment(commitment) {
+  if (Array.isArray(commitment)) {
+    commitment.forEach((c) => saveCommitment(c));
+    return;
+  }
+  if (registeredCommitments[commitment.id]) {
+    console.warn(`[NQTR] Commitment id ${commitment.id} already exists, it will be overwritten`);
+  }
+  registeredCommitments[commitment.id] = commitment;
+}
+function getCommitmentById(id) {
+  try {
+    let commitment = registeredCommitments[id];
+    if (!commitment) {
+      console.error(`[NQTR] Commitment ${id} not found`);
+      return;
+    }
+    return commitment;
+  } catch (e) {
+    console.error(`[NQTR] Error while getting Commitment ${id}`, e);
+    return;
+  }
+}
+function setFixedRoutine(commitments) {
+  if (Array.isArray(commitments)) {
+    commitments.forEach((c) => setFixedRoutine(c));
+    return;
+  }
+  if (fixedCommitments[commitments.id]) {
+    console.warn(`[NQTR] Commitment id ${commitments.id} already exists, it will be overwritten`);
+  }
+  fixedCommitments[commitments.id] = commitments;
+}
+function addCommitment(commitment) {
+  if (!Array.isArray(commitment)) {
+    commitment = [commitment];
+  }
+  let commitmentsIds = commitment.map((commitment2) => {
+    let commitmentTest = getCommitmentById(commitment2.id);
+    if (!commitmentTest) {
+      console.warn(`[NQTR] Commitment ${commitment2.id} not found, it will be ignored`);
+      return void 0;
+    }
+    return commitment2.id;
+  }).filter((id) => id !== void 0);
+  pixiVn.GameStorageManager.setVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY, commitmentsIds);
+}
+function removeCommitment(commitment) {
+  if (!Array.isArray(commitment)) {
+    commitment = [commitment];
+  }
+  let commitmentsIds = commitment.map((commitment2) => {
+    return commitment2.id;
+  });
+  let currentCommitments = pixiVn.GameStorageManager.getVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY);
+  if (!currentCommitments) {
+    return;
+  }
+  currentCommitments = currentCommitments.filter((id) => !commitmentsIds.includes(id));
+  pixiVn.GameStorageManager.setVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY, currentCommitments);
+}
 var GOAL_CATEGORY = "__nqtr-goal__";
 var Goal = class extends pixiVn.StoredClassModel {
   constructor(id, props) {
@@ -347,9 +478,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;
   }
@@ -359,12 +496,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;
   }
@@ -375,6 +518,9 @@ var GoalStage = class extends Goal {
     }
     this.setStorageProperty("have-" + this._stageId, value);
   }
+  /**
+   * If the goal is completed.
+   */
   get completed() {
     return this.have >= this.need;
   }
@@ -385,6 +531,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++;
   }
@@ -408,12 +557,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;
   }
@@ -432,6 +590,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;
   }
@@ -441,21 +603,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;
   }
@@ -464,22 +644,38 @@ 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.every((flag) => pixiVn.getFlag(flag.flag))) {
-      return false;
-    }
-    if (!this.goals.every((goal) => goal.completed)) {
-      return false;
+    if (this.flags.length > 0 && this.goals.length > 0) {
+      if (!this.flags.every((flag) => pixiVn.getFlag(flag.flag))) {
+        return false;
+      }
+      if (!this.goals.every((goal) => goal.completed)) {
+        return false;
+      }
+      return true;
     }
-    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.
    */
@@ -494,6 +690,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) {
@@ -501,6 +700,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) {
@@ -522,11 +724,27 @@ var StageQuest = class extends Stage {
     }
     return true;
   }
-  get onStart() {
+  /**
+   * 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`);
     }
-    return super.onStart;
   }
 };
 
@@ -542,14 +760,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;
   }
@@ -583,15 +810,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) {
@@ -599,12 +835,26 @@ 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;
+    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`);
@@ -616,35 +866,97 @@ var Quest = class extends pixiVn.StoredClassModel {
     }
     this.currentStageIndex = 0;
     let currentStage = this.currentStage;
-    if (currentStage && currentStage.onStart) {
-      return currentStage.onStart(props);
+    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;
+      return false;
     }
     if (this.completed) {
-      return;
+      return false;
     }
     let currentStage = this.currentStage;
-    let currentStageIndex = this.currentStageIndex;
-    if (!currentStage || currentStageIndex === void 0) {
+    if (!currentStage) {
       console.error(`[NQTR] Quest ${this.id} has no current stage`);
-      return;
+      return false;
     }
     if (currentStage.completed) {
-      let nextStageIndex = currentStageIndex + 1;
-      currentStageIndex = nextStageIndex;
-      let nextStage = this.currentStage;
-      if (currentStage && currentStage.onEnd) {
-        currentStage.onEnd(endProps);
-      }
-      if (nextStage && nextStage.onStart) {
-        return nextStage.onStart(startProps);
-      }
+      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();
+    }
+    return true;
+  }
+  get currentStageMustStart() {
+    let currentStage = this.currentStage;
+    if (!currentStage) {
+      return false;
+    }
+    return !currentStage.started && currentStage.canStart && !currentStage.completed;
+  }
+  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`);
     }
   }
 };
@@ -720,9 +1032,9 @@ exports.getAllMaps = getAllMaps;
 exports.getCommitmentById = getCommitmentById;
 exports.getQuestById = getQuestById;
 exports.getRoomById = getRoomById;
+exports.newActivity = newActivity;
 exports.newQuest = newQuest;
 exports.removeCommitment = removeCommitment;
-exports.saveActivity = saveActivity;
 exports.saveCommitment = saveCommitment;
 exports.saveRoom = saveRoom;
 exports.setFixedRoutine = setFixedRoutine;