@drincs/nqtr 0.2.1 → 0.2.3

package/dist/index.js

@@ -261,136 +261,7 @@ var TimeManager = class _TimeManager {
   }
 };
 
-// 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/classes/Commitment.ts
 var COMMITMENT_CATEGORY = "__nqtr-commitment__";
 var CommitmentBaseModel = class extends pixiVn.StoredClassModel {
   /**
@@ -744,6 +615,9 @@ var ActivityRoom = class extends ActivityStoredAbstract {
   get id() {
     return this._id;
   }
+  /**
+   * The room where the activity is.
+   */
   get room() {
     return this._room;
   }
@@ -1010,18 +884,145 @@ var MapBaseModel = class extends pixiVn.StoredClassModel {
     return getLocationsByMap(this);
   }
 };
+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 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`);
+function newActivity(id, onRun, props) {
+  if (registeredActivities[id]) {
+    console.warn(`[NQTR] Activity ${id} already exists, it will be overwritten`);
   }
-  registeredActivities[activity.id] = activity;
+  let activity = new ActivityModel(id, onRun, props);
+  registeredActivities[id] = activity;
+  return activity;
 }
 function getActivityById(id) {
   try {
@@ -1300,17 +1301,29 @@ var StageQuest = class extends Stage {
     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.
    */
@@ -1360,13 +1373,26 @@ var StageQuest = class extends Stage {
     return true;
   }
   /**
-   * The function that will be called when the stage starts.
+   * Inizialize the stage. **This function should be called only by the Quest class.**
    */
-  get onStart() {
+  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;
   }
 };
 
@@ -1467,7 +1493,10 @@ var Quest = class extends pixiVn.StoredClassModel {
    * 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.
@@ -1485,14 +1514,15 @@ 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`);
     }
   }
   /**
-   * Try to go to the next 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.
@@ -1505,25 +1535,88 @@ var Quest = class extends pixiVn.StoredClassModel {
       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 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) {
-        nextStage.onStart(startProps);
-      }
-      return true;
+      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/decorators/QuestDecorator.ts
@@ -1549,6 +1642,54 @@ function getQuestById(id) {
     return;
   }
 }
+function getAllStartedQuests() {
+  return Object.values(registeredQuests).filter((quest) => quest.started);
+}
+var CURRENT_ROOM_MEMORY_KEY = "___nqtr-current_room_memory___";
+function setCurrentRoom(room) {
+  if (room instanceof LocationBaseModel) {
+    let entrance = room.getEntrance();
+    if (!entrance) {
+      console.error(`[NQTR] The location ${room.id} has no entrance room`);
+      return;
+    }
+    room = entrance;
+  } else {
+    let roomRegistrated = getRoomById(room.id);
+    if (!roomRegistrated) {
+      console.error(`[NQTR] The room ${room.id} is not registered, so it can't be set as current room`);
+      return;
+    }
+  }
+  pixiVn.GameStorageManager.setVariable(CURRENT_ROOM_MEMORY_KEY, room.id);
+}
+function getCurrentRoom() {
+  let roomId = pixiVn.GameStorageManager.getVariable(CURRENT_ROOM_MEMORY_KEY);
+  if (!roomId) {
+    console.error(`[NQTR] The current room has not yet been set`);
+    return;
+  }
+  let room = getRoomById(roomId);
+  if (!room) {
+    console.error(`[NQTR] Current room ${roomId} not found`);
+    return;
+  }
+  return room;
+}
+function getCurrenrLocation() {
+  let room = getCurrentRoom();
+  if (!room) {
+    return;
+  }
+  return room.location;
+}
+function getCurrentMap() {
+  let location = getCurrenrLocation();
+  if (!location) {
+    return;
+  }
+  return location.map;
+}
 
 // src/functions/RoutineFunctions.ts
 function clearExpiredRoutine() {
@@ -1590,6 +1731,13 @@ function getCurrentRoutine() {
   });
   return Object.values(character_commitments);
 }
+function getCurrentRoomRoutine() {
+  let room = getCurrentRoom();
+  if (!room) {
+    return [];
+  }
+  return room.getRoutine();
+}
 function getCommitmentByCharacter(character) {
   getCurrentRoutine().forEach((c) => {
     if (c.characters.map((ch) => ch.id).includes(character.id)) {
@@ -1601,7 +1749,7 @@ function getCommitmentByCharacter(character) {
 
 // src/classes/navigation/Room.ts
 var ROOM_CATEGORY = "__nqtr-room__";
-var RoomBaseModel = class extends pixiVn.StoredClassModel {
+var RoomBaseModel2 = class extends pixiVn.StoredClassModel {
   /**
    * @param id The id of the room, it must be unique.
    * @param location The location where the room is.
@@ -1835,51 +1983,6 @@ var RoomBaseModel = class extends pixiVn.StoredClassModel {
     return commitments.filter((c) => c.room.id === this.id);
   }
 };
-var CURRENT_ROOM_MEMORY_KEY = "___nqtr-current_room_memory___";
-function setCurrentRoom(room) {
-  if (room instanceof LocationBaseModel) {
-    let entrance = room.getEntrance();
-    if (!entrance) {
-      console.error(`[NQTR] The location ${room.id} has no entrance room`);
-      return;
-    }
-    room = entrance;
-  } else {
-    let roomRegistrated = getRoomById(room.id);
-    if (!roomRegistrated) {
-      console.error(`[NQTR] The room ${room.id} is not registered, so it can't be set as current room`);
-      return;
-    }
-  }
-  pixiVn.GameStorageManager.setVariable(CURRENT_ROOM_MEMORY_KEY, room.id);
-}
-function getCurrentRoom() {
-  let roomId = pixiVn.GameStorageManager.getVariable(CURRENT_ROOM_MEMORY_KEY);
-  if (!roomId) {
-    console.error(`[NQTR] The current room has not yet been set`);
-    return;
-  }
-  let room = getRoomById(roomId);
-  if (!room) {
-    console.error(`[NQTR] Current room ${roomId} not found`);
-    return;
-  }
-  return room;
-}
-function getCurrenrLocation() {
-  let room = getCurrentRoom();
-  if (!room) {
-    return;
-  }
-  return room.location;
-}
-function getCueerntMap() {
-  let location = getCurrenrLocation();
-  if (!location) {
-    return;
-  }
-  return location.map;
-}
 
 // src/functions/ActivityFunctions.ts
 function clearExpiredActivities() {
@@ -1895,13 +1998,22 @@ function currentActivities() {
   return currentRoom.activities.filter((activity) => !activity.hidden);
 }
 
-exports.ActivityModel = ActivityModel;
+// src/functions/QuestFunctions.ts
+function startMustStartStageQuests(props) {
+  Object.entries(registeredQuests).forEach(([_, quest]) => {
+    if (quest.currentStageMustStart) {
+      quest.startCurrentStage(props);
+    }
+  });
+}
+
 exports.ActivityRoom = ActivityRoom;
 exports.CommitmentBaseModel = CommitmentBaseModel;
 exports.Goal = Goal;
 exports.LocationBaseModel = LocationBaseModel;
 exports.MapBaseModel = MapBaseModel;
-exports.RoomBaseModel = RoomBaseModel;
+exports.Quest = Quest;
+exports.RoomBaseModel = RoomBaseModel2;
 exports.Stage = Stage;
 exports.TimeManager = TimeManager;
 exports.addCommitment = addCommitment;
@@ -1911,20 +2023,23 @@ exports.currentActivities = currentActivities;
 exports.getActivityById = getActivityById;
 exports.getAllLocations = getAllLocations;
 exports.getAllMaps = getAllMaps;
+exports.getAllStartedQuests = getAllStartedQuests;
 exports.getCommitmentByCharacter = getCommitmentByCharacter;
 exports.getCommitmentById = getCommitmentById;
-exports.getCueerntMap = getCueerntMap;
 exports.getCurrenrLocation = getCurrenrLocation;
+exports.getCurrentMap = getCurrentMap;
 exports.getCurrentRoom = getCurrentRoom;
+exports.getCurrentRoomRoutine = getCurrentRoomRoutine;
 exports.getCurrentRoutine = getCurrentRoutine;
 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.setCurrentRoom = setCurrentRoom;
 exports.setFixedRoutine = setFixedRoutine;
+exports.startMustStartStageQuests = startMustStartStageQuests;
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.js.map