@drincs/nqtr 0.2.12 → 0.2.14

package/dist/classes/quest/Quest.mjs

@@ -1,768 +0,0 @@
-import { StoredClassModel, getFlag, GameStorageManager } from '@drincs/pixi-vn';
-
-// src/classes/quest/Quest.ts
-var TIME_SETTINGS_KEY = "___nqtr-time_manager_settings___";
-var TIME_DATA_KEY = "___nqtr-time_manager_data___";
-var TimeManager = class _TimeManager {
-  constructor() {
-  }
-  static editSettings(settings) {
-    let data = {};
-    if (typeof settings.minDayHours === "number") {
-      data["minDayHours"] = settings.minDayHours;
-    }
-    if (typeof settings.maxDayHours === "number") {
-      data["maxDayHours"] = settings.maxDayHours;
-    }
-    if (typeof settings.minDayHours === "number") {
-      data["defaultTimeSpent"] = settings.defaultTimeSpent;
-    }
-    if (Array.isArray(settings.timeSlots)) {
-      data["timeSlots"] = settings.timeSlots;
-    }
-    if (typeof settings.weekLength === "number") {
-      data["weekLength"] = settings.weekLength;
-    }
-    if (typeof settings.weekendStartDay === "number") {
-      let weekLength = settings.weekLength || _TimeManager.weekLength;
-      if (settings.weekendStartDay >= weekLength) {
-        console.warn(`[NQTR] Weekend start day should be less than week length ${weekLength}`);
-      }
-      data["weekendStartDay"] = settings.weekendStartDay;
-    }
-    if (Array.isArray(settings.weekDaysNames)) {
-      let weekLength = settings.weekLength || _TimeManager.weekLength;
-      if (settings.weekDaysNames.length !== weekLength) {
-        console.warn(`[NQTR] Week days names should be equal to week length ${weekLength}`);
-      }
-      data["weekDaysNames"] = settings.weekDaysNames;
-    }
-    GameStorageManager.setVariable(TIME_SETTINGS_KEY, data);
-  }
-  /**
-   * Get time settings
-   * @default {}
-   */
-  static get settings() {
-    let settings = GameStorageManager.getVariable(TIME_SETTINGS_KEY) || {};
-    return settings;
-  }
-  /**
-   * Set time settings, Is very important to set the settings before using the nqtr library, bacause more of the features are based on the time settings.
-   */
-  static set settings(value) {
-    _TimeManager.editSettings(value);
-  }
-  static get minDayHours() {
-    let result = 0;
-    let settings = GameStorageManager.getVariable(TIME_SETTINGS_KEY);
-    if (settings && settings.hasOwnProperty("minDayHours")) {
-      result = settings.minDayHours || 0;
-    }
-    return result;
-  }
-  static get maxDayHours() {
-    let result = 24;
-    let settings = GameStorageManager.getVariable(TIME_SETTINGS_KEY);
-    if (settings && settings.hasOwnProperty("maxDayHours")) {
-      result = settings.maxDayHours || 24;
-    }
-    return result;
-  }
-  static get defaultTimeSpent() {
-    let result = 1;
-    let settings = GameStorageManager.getVariable(TIME_SETTINGS_KEY);
-    if (settings && settings.hasOwnProperty("defaultTimeSpent")) {
-      result = settings.defaultTimeSpent || 1;
-    }
-    return result;
-  }
-  static get timeSlots() {
-    let result = [];
-    let settings = GameStorageManager.getVariable(TIME_SETTINGS_KEY);
-    if (settings && settings.hasOwnProperty("timeSlots")) {
-      result = settings.timeSlots || [];
-    }
-    return result;
-  }
-  static get weekLength() {
-    let result = 7;
-    let settings = GameStorageManager.getVariable(TIME_SETTINGS_KEY);
-    if (settings && settings.hasOwnProperty("weekLength")) {
-      result = settings.weekLength || 7;
-    }
-    return result;
-  }
-  static get weekendStartDay() {
-    let result = _TimeManager.weekLength - 1;
-    let settings = GameStorageManager.getVariable(TIME_SETTINGS_KEY);
-    if (settings && settings.hasOwnProperty("weekendStartDay")) {
-      result = settings.weekendStartDay || _TimeManager.weekLength - 1;
-    }
-    return result;
-  }
-  static get weekDaysNames() {
-    let result = [];
-    let settings = GameStorageManager.getVariable(TIME_SETTINGS_KEY);
-    if (settings && settings.hasOwnProperty("weekDaysNames")) {
-      result = settings.weekDaysNames || result;
-    }
-    return result;
-  }
-  /**
-   * Get the current hour
-   */
-  static get currentHour() {
-    let data = GameStorageManager.getVariable(TIME_DATA_KEY) || {};
-    if (data.hasOwnProperty("currentHour") && typeof data.currentHour === "number") {
-      return data.currentHour;
-    }
-    return _TimeManager.minDayHours;
-  }
-  static set currentHour(value) {
-    let data = GameStorageManager.getVariable(TIME_DATA_KEY) || {};
-    if (typeof value === "number") {
-      data.currentHour = value;
-    } else {
-      delete data.currentHour;
-    }
-    GameStorageManager.setVariable(TIME_DATA_KEY, data);
-  }
-  /**
-   * Get the current day
-   */
-  static get currentDay() {
-    let data = GameStorageManager.getVariable(TIME_DATA_KEY) || {};
-    if (data.hasOwnProperty("currentDay") && typeof data.currentDay === "number") {
-      return data.currentDay;
-    }
-    return 0;
-  }
-  static set currentDay(value) {
-    let data = GameStorageManager.getVariable(TIME_DATA_KEY) || {};
-    if (typeof value === "number") {
-      data.currentDay = value;
-    } else {
-      delete data.currentDay;
-    }
-    GameStorageManager.setVariable(TIME_DATA_KEY, data);
-  }
-  /**
-   * If the current day is greater than or equal to the weekend start day, then it will return true.
-   */
-  static get isWeekend() {
-    return _TimeManager.currentWeekDayNumber >= _TimeManager.weekendStartDay;
-  }
-  /**
-   * Get the current week day number (1-TimeManager.weekLength).
-   * For example, if the week length is 7 and the current day is 10, then the result will be 4.
-   */
-  static get currentWeekDayNumber() {
-    let result = _TimeManager.currentDay % _TimeManager.weekLength;
-    return result + 1;
-  }
-  /**
-   * Get the current week day name. If the week days names are not defined, then it will return undefined.
-   * For example, if the week days names are ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'] and the current day is 10, then the result will be 'Thursday'.
-   * @default ""
-   */
-  static get currentDayName() {
-    let weekDayNumber = _TimeManager.currentWeekDayNumber - 1;
-    if (weekDayNumber >= _TimeManager.weekDaysNames.length) {
-      console.warn(`[NQTR] Week day name is not defined for day ${weekDayNumber}`, _TimeManager.weekDaysNames);
-      return "";
-    }
-    return _TimeManager.weekDaysNames[weekDayNumber];
-  }
-  /**
-   * Get the current TimeManager.timeSlots index.
-   * You can use this property to create "Image that changes based on the time period":
-   * @example
-   * ```tsx
-   * import { TimeManager } from '@drincs/nqtr';
-   * 
-   * function changeBackground() {
-   *     return (
-   *         <img src={`background-${TimeManager.currentTimeSlot}.png`} />
-   *     )
-   * }
-   */
-  static get currentTimeSlot() {
-    if (_TimeManager.timeSlots.length === 0) {
-      console.warn("[NQTR] Time slots are not defined");
-      return 0;
-    }
-    for (let index = 0; index < _TimeManager.timeSlots.length; index++) {
-      let slot = _TimeManager.timeSlots[index];
-      if (_TimeManager.timeSlots.length > index + 1) {
-        if (_TimeManager.nowIsBetween(slot.startHour, _TimeManager.timeSlots[index + 1].startHour)) {
-          return index;
-        }
-      }
-    }
-    return _TimeManager.timeSlots.length - 1;
-  }
-  /**
-   * This function will increase the current hour by the given time spent.
-   * If the new hour is greater than or equal to the max day hours, then it will increase the day and set the new hour.
-   * @param timeSpent is the time spent in hours (default: TimeManager.defaultTimeSpent)
-   * @returns TimeManager.currentHour
-   */
-  static increaseHour(timeSpent = _TimeManager.defaultTimeSpent) {
-    let newHour = _TimeManager.currentHour + timeSpent;
-    if (newHour >= _TimeManager.maxDayHours) {
-      _TimeManager.increaseDay();
-      newHour = _TimeManager.minDayHours + (newHour - _TimeManager.maxDayHours);
-    }
-    _TimeManager.currentHour = newHour;
-    return _TimeManager.currentHour;
-  }
-  /**
-   * This function will increase the current day by the given days.
-   * @param newDayHour is the hour of the new day (default: TimeManager.minDayHours)
-   * @param days is the number of days to increase (default: 1)
-   * @returns TimeManager.currentDay
-   */
-  static increaseDay(newDayHour = _TimeManager.minDayHours, days = 1) {
-    let newDay = _TimeManager.currentDay + days;
-    _TimeManager.currentDay = newDay;
-    _TimeManager.currentHour = newDayHour;
-    return _TimeManager.currentDay;
-  }
-  /**
-   * This function will check if the current hour is between the given hours.
-   * @param fromHour the starting hour. If the TimeManager.currentHour is equal to this hour, the function will return true.
-   * @param toHour the ending hour.
-   * @returns true if the current hour is between the given hours, otherwise false.
-   */
-  static nowIsBetween(fromHour, toHour) {
-    let currentHour = _TimeManager.currentHour;
-    if (fromHour < toHour) {
-      return currentHour >= fromHour && currentHour < toHour;
-    }
-    return currentHour >= fromHour || currentHour < toHour;
-  }
-};
-var GOAL_CATEGORY = "__nqtr-goal__";
-var Goal = class extends StoredClassModel {
-  constructor(id, props) {
-    super(GOAL_CATEGORY, id);
-    this._description = props.description;
-    this._need = props.need || 1;
-    this._defaultHave = props.have || 0;
-  }
-  /**
-   * The description of the goal.
-   */
-  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;
-  }
-};
-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__";
-var Stage = class extends StoredClassModel {
-  constructor(id, props) {
-    super(STAGE_CATEGORY, id);
-    this._name = props.name || "";
-    this._defaultGoals = props.goals || [];
-    this._flags = props.flags || [];
-    this._description = props.description || "";
-    this._adviceDescription = props.adviceDescription || "";
-    this._renderImage = props.renderImage;
-    this._daysRequiredToStart = props.daysRequiredToStart;
-    this._flagsRequiredToStart = props.flagsRequiredToStart || [];
-    this._questsRequiredToStart = props.questsRequiredToStart || [];
-    this._requestDescriptionToStart = props.requestDescriptionToStart || "";
-    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;
-  }
-  /**
-   * The function for rendering the image of the stage.
-   */
-  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;
-  }
-  /**
-   * 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;
-  }
-  /**
-   * The list of flags that the player must complete to finish the stage.
-   */
-  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;
-  }
-};
-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(this, 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;
-    this._onStart = props.onStart;
-    this._onNextStage = props.onNextStage;
-  }
-  /**
-   * 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;
-  }
-  /**
-   * The function that will be called when the quest starts.
-   */
-  get onStart() {
-    return this._onStart;
-  }
-  /**
-   * The function that will be called when the quest goes to the next stage.
-   */
-  get onNextStage() {
-    return this._onNextStage;
-  }
-  /**
-   * 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) {
-      this.onStart && this.onStart(this, props);
-      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 props The properties. If you not want to pass any property, you can pass an {}.
-   * @returns true if the stage was changed, false otherwise.
-   */
-  tryToGoNextStage(props) {
-    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(props);
-    }
-    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 props The properties. If you not want to pass any property, you can pass an {}.
-   * @returns true if the stage was changed, false otherwise.
-   */
-  completeCurrentStageAndGoNext(props) {
-    let currentStage = this.currentStage;
-    if (!currentStage) {
-      console.error(`[NQTR] Quest ${this.id} has no current stage`);
-      return false;
-    }
-    currentStage.completed = true;
-    return this.goNextStage(props);
-  }
-  /**
-   * 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 props The properties. If you not want to pass any property, you can pass an {}.
-   * @returns returns true if the stage was changed, false otherwise.
-   */
-  goNextStage(props) {
-    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;
-    this.onNextStage && this.onNextStage(this, props);
-    if (prevStage && prevStage.onEnd) {
-      prevStage.onEnd(prevStage, props);
-    }
-    let nextCurrentStage = this.currentStage;
-    if (nextCurrentStage) {
-      nextCurrentStage.inizialize();
-      if (this.currentStageMustStart) {
-        this.startCurrentStage(props);
-      }
-    }
-    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`);
-    }
-  }
-};
-
-export { Quest as default };
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=Quest.mjs.map