@drincs/nqtr 0.0.1 → 0.0.2

package/README.md

@@ -1 +1,11 @@
-# nqtr-pixi-vn
+# Navigation Quest Time Routine for Pixi'VN
+
+The Navigation Quest Time Routine (NQTR) is a library that introduces a navigation, quest, and time system to the Pixi'VN visual novel engine.
+
+## Get Started
+
+### Installation
+
+```bash
+npm install @drincs/nqtr
+```

package/dist/index.d.mts

@@ -507,14 +507,49 @@ declare function clearExpiredRoutine(): void;
 declare function getCurrentCommitments<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
 declare function getCommitmentByCharacter<TCommitment extends CommitmentBaseModel = CommitmentBaseModel, TCharacter extends CharacterBaseModel = CharacterBaseModel>(character: TCharacter): TCommitment | undefined;
 
-interface ITimeSettings {
-    minDayHour?: number;
-    maxDayHour?: number;
+/**
+ * Time Settings, which can be set using `TimeManager.editSettings`
+ */
+interface TimeSettings {
+    /**
+     * Minimum hour of the day (default: 0)
+     */
+    minDayHours?: number;
+    /**
+     * Maximum hour of the day (default: 24)
+     */
+    maxDayHours?: number;
+    /**
+     * Default time spent (default: 1)
+     */
     defaultTimeSpent?: number;
+    /**
+     * Time slots (default: [])
+     * @example
+     * ```ts
+     * [
+     *   { name: 'Morning', startHour: 5 },
+     *   { name: 'Afternoon', startHour: 12 },
+     *   { name: 'Evening', startHour: 18 },
+     *   { name: 'Night', startHour: 22 }
+     * ]
+     */
     timeSlots?: ITimeStlot[];
+    /**
+     * Week length (default: 7)
+     */
     weekLength?: number;
-    newDayHour?: number;
+    /**
+     * Weekend start day. For example, if the real life weekend starts on Saturday, then the value should be 6 (default: weekLength - 1)
+     */
     weekendStartDay?: number;
+    /**
+     * Week days names (default: [])
+     * @example
+     * ```ts
+     * ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
+     * ```
+     */
     weekDaysNames?: string[];
 }
 interface ITimeStlot {
@@ -523,11 +558,18 @@ interface ITimeStlot {
 }
 declare class TimeManager {
     private constructor();
-    static set editSettings(value: ITimeSettings);
-    static get minDayHour(): number;
-    static get maxDayHour(): number;
+    private static editSettings;
+    /**
+     * Get time settings
+     */
+    static get settings(): TimeSettings;
+    /**
+     * 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: TimeSettings);
+    static get minDayHours(): number;
+    static get maxDayHours(): number;
     static get defaultTimeSpent(): number;
-    static get newDayHour(): number;
     static get timeSlots(): ITimeStlot[];
     static get weekLength(): number;
     static get weekendStartDay(): number;
@@ -544,4 +586,4 @@ declare class TimeManager {
     static nowIsBetween(fromHour: number, toHour: number): boolean;
 }
 
-export { ActivityModel, type ActivityProps, ExecutionTypeEnum, TimeManager as GameStepManager, Goal, type GoalProps, type ITimeSettings, LocationBaseModel, type LocationBaseModelProps, MapBaseModel, type MapBaseModelProps, QuestBaseModel, type QuestBaseModelProps, type QuestsRequiredType, RoomBaseModel, type RoomBaseModelProps, StageBaseModel, type StageBaseModelProps, addTemporaryCommitment, clearExpiredActivities, clearExpiredRoutine, currentActivities, getActivityById, getCommitmentByCharacter, getCommitmentById, getCueerntMap, getCurrenrLocation, getCurrentCommitments, getCurrentRoom, getFixedCommitments, getRoomById, getTemporaryCommitments, saveActivity, saveCommitment, saveRoom, setCurrentRoom, setFixedCommitments };
+export { ActivityModel, type ActivityProps, ExecutionTypeEnum, Goal, type GoalProps, LocationBaseModel, type LocationBaseModelProps, MapBaseModel, type MapBaseModelProps, QuestBaseModel, type QuestBaseModelProps, type QuestsRequiredType, RoomBaseModel, type RoomBaseModelProps, StageBaseModel, type StageBaseModelProps, TimeManager, type TimeSettings, addTemporaryCommitment, clearExpiredActivities, clearExpiredRoutine, currentActivities, getActivityById, getCommitmentByCharacter, getCommitmentById, getCueerntMap, getCurrenrLocation, getCurrentCommitments, getCurrentRoom, getFixedCommitments, getRoomById, getTemporaryCommitments, saveActivity, saveCommitment, saveRoom, setCurrentRoom, setFixedCommitments };

package/dist/index.d.ts

@@ -507,14 +507,49 @@ declare function clearExpiredRoutine(): void;
 declare function getCurrentCommitments<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
 declare function getCommitmentByCharacter<TCommitment extends CommitmentBaseModel = CommitmentBaseModel, TCharacter extends CharacterBaseModel = CharacterBaseModel>(character: TCharacter): TCommitment | undefined;
 
-interface ITimeSettings {
-    minDayHour?: number;
-    maxDayHour?: number;
+/**
+ * Time Settings, which can be set using `TimeManager.editSettings`
+ */
+interface TimeSettings {
+    /**
+     * Minimum hour of the day (default: 0)
+     */
+    minDayHours?: number;
+    /**
+     * Maximum hour of the day (default: 24)
+     */
+    maxDayHours?: number;
+    /**
+     * Default time spent (default: 1)
+     */
     defaultTimeSpent?: number;
+    /**
+     * Time slots (default: [])
+     * @example
+     * ```ts
+     * [
+     *   { name: 'Morning', startHour: 5 },
+     *   { name: 'Afternoon', startHour: 12 },
+     *   { name: 'Evening', startHour: 18 },
+     *   { name: 'Night', startHour: 22 }
+     * ]
+     */
     timeSlots?: ITimeStlot[];
+    /**
+     * Week length (default: 7)
+     */
     weekLength?: number;
-    newDayHour?: number;
+    /**
+     * Weekend start day. For example, if the real life weekend starts on Saturday, then the value should be 6 (default: weekLength - 1)
+     */
     weekendStartDay?: number;
+    /**
+     * Week days names (default: [])
+     * @example
+     * ```ts
+     * ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
+     * ```
+     */
     weekDaysNames?: string[];
 }
 interface ITimeStlot {
@@ -523,11 +558,18 @@ interface ITimeStlot {
 }
 declare class TimeManager {
     private constructor();
-    static set editSettings(value: ITimeSettings);
-    static get minDayHour(): number;
-    static get maxDayHour(): number;
+    private static editSettings;
+    /**
+     * Get time settings
+     */
+    static get settings(): TimeSettings;
+    /**
+     * 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: TimeSettings);
+    static get minDayHours(): number;
+    static get maxDayHours(): number;
     static get defaultTimeSpent(): number;
-    static get newDayHour(): number;
     static get timeSlots(): ITimeStlot[];
     static get weekLength(): number;
     static get weekendStartDay(): number;
@@ -544,4 +586,4 @@ declare class TimeManager {
     static nowIsBetween(fromHour: number, toHour: number): boolean;
 }
 
-export { ActivityModel, type ActivityProps, ExecutionTypeEnum, TimeManager as GameStepManager, Goal, type GoalProps, type ITimeSettings, LocationBaseModel, type LocationBaseModelProps, MapBaseModel, type MapBaseModelProps, QuestBaseModel, type QuestBaseModelProps, type QuestsRequiredType, RoomBaseModel, type RoomBaseModelProps, StageBaseModel, type StageBaseModelProps, addTemporaryCommitment, clearExpiredActivities, clearExpiredRoutine, currentActivities, getActivityById, getCommitmentByCharacter, getCommitmentById, getCueerntMap, getCurrenrLocation, getCurrentCommitments, getCurrentRoom, getFixedCommitments, getRoomById, getTemporaryCommitments, saveActivity, saveCommitment, saveRoom, setCurrentRoom, setFixedCommitments };
+export { ActivityModel, type ActivityProps, ExecutionTypeEnum, Goal, type GoalProps, LocationBaseModel, type LocationBaseModelProps, MapBaseModel, type MapBaseModelProps, QuestBaseModel, type QuestBaseModelProps, type QuestsRequiredType, RoomBaseModel, type RoomBaseModelProps, StageBaseModel, type StageBaseModelProps, TimeManager, type TimeSettings, addTemporaryCommitment, clearExpiredActivities, clearExpiredRoutine, currentActivities, getActivityById, getCommitmentByCharacter, getCommitmentById, getCueerntMap, getCurrenrLocation, getCurrentCommitments, getCurrentRoom, getFixedCommitments, getRoomById, getTemporaryCommitments, saveActivity, saveCommitment, saveRoom, setCurrentRoom, setFixedCommitments };

package/dist/index.js

@@ -36,13 +36,13 @@ var src_exports = {};
 __export(src_exports, {
   ActivityModel: () => ActivityModel,
   ExecutionTypeEnum: () => ExecutionTypeEnum,
-  GameStepManager: () => TimeManager,
   Goal: () => Goal,
   LocationBaseModel: () => LocationBaseModel,
   MapBaseModel: () => MapBaseModel,
   QuestBaseModel: () => QuestBaseModel,
   RoomBaseModel: () => RoomBaseModel,
   StageBaseModel: () => StageBaseModel,
+  TimeManager: () => TimeManager,
   addTemporaryCommitment: () => addTemporaryCommitment,
   clearExpiredActivities: () => clearExpiredActivities,
   clearExpiredRoutine: () => clearExpiredRoutine,
@@ -75,55 +75,65 @@ var TIME_DATA_KEY = "___nqtr-time_manager_data___";
 var TimeManager = class _TimeManager {
   constructor() {
   }
-  static set editSettings(value) {
-    let settings = {};
-    if (typeof value.minDayHour === "number") {
-      settings["minDayHour"] = value.minDayHour;
+  static editSettings(settings) {
+    let data = {};
+    if (typeof settings.minDayHours === "number") {
+      data["minDayHours"] = settings.minDayHours;
     }
-    if (typeof value.maxDayHour === "number") {
-      settings["maxDayHour"] = value.maxDayHour;
+    if (typeof settings.maxDayHours === "number") {
+      data["maxDayHours"] = settings.maxDayHours;
     }
-    if (typeof value.minDayHour === "number") {
-      settings["defaultTimeSpent"] = value.defaultTimeSpent;
+    if (typeof settings.minDayHours === "number") {
+      data["defaultTimeSpent"] = settings.defaultTimeSpent;
     }
-    if (Array.isArray(value.timeSlots)) {
-      settings["timeSlots"] = value.timeSlots;
+    if (Array.isArray(settings.timeSlots)) {
+      data["timeSlots"] = settings.timeSlots;
     }
-    if (typeof value.weekLength === "number") {
-      settings["weekLength"] = value.weekLength;
+    if (typeof settings.weekLength === "number") {
+      data["weekLength"] = settings.weekLength;
     }
-    if (typeof value.newDayHour === "number") {
-      settings["newDayHour"] = value.newDayHour;
-    }
-    if (typeof value.weekendStartDay === "number") {
-      let weekLength = value.weekLength || _TimeManager.weekLength;
-      if (value.weekendStartDay >= 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}`);
       }
-      settings["weekendStartDay"] = value.weekendStartDay;
+      data["weekendStartDay"] = settings.weekendStartDay;
     }
-    if (Array.isArray(value.weekDaysNames)) {
-      let weekLength = value.weekLength || _TimeManager.weekLength;
-      if (value.weekDaysNames.length !== weekLength) {
+    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}`);
       }
-      settings["weekDaysNames"] = value.weekDaysNames;
+      data["weekDaysNames"] = settings.weekDaysNames;
     }
-    import_pixi_vn.GameStorageManager.setVariable(TIME_SETTINGS_KEY, settings);
-  }
-  static get minDayHour() {
+    import_pixi_vn.GameStorageManager.setVariable(TIME_SETTINGS_KEY, data);
+  }
+  /**
+   * Get time settings
+   */
+  static get settings() {
+    let settings = import_pixi_vn.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 = import_pixi_vn.GameStorageManager.getVariable(TIME_SETTINGS_KEY);
-    if (settings && settings.hasOwnProperty("minDayHour")) {
-      result = settings.minDayHour || 0;
+    if (settings && settings.hasOwnProperty("minDayHours")) {
+      result = settings.minDayHours || 0;
     }
     return result;
   }
-  static get maxDayHour() {
+  static get maxDayHours() {
     let result = 24;
     let settings = import_pixi_vn.GameStorageManager.getVariable(TIME_SETTINGS_KEY);
-    if (settings && settings.hasOwnProperty("maxDayHour")) {
-      result = settings.maxDayHour || 24;
+    if (settings && settings.hasOwnProperty("maxDayHours")) {
+      result = settings.maxDayHours || 24;
     }
     return result;
   }
@@ -135,14 +145,6 @@ var TimeManager = class _TimeManager {
     }
     return result;
   }
-  static get newDayHour() {
-    let result = 0;
-    let settings = import_pixi_vn.GameStorageManager.getVariable(TIME_SETTINGS_KEY);
-    if (settings && settings.hasOwnProperty("newDayHour")) {
-      result = settings.newDayHour || 0;
-    }
-    return result;
-  }
   static get timeSlots() {
     let result = [];
     let settings = import_pixi_vn.GameStorageManager.getVariable(TIME_SETTINGS_KEY);
@@ -180,7 +182,7 @@ var TimeManager = class _TimeManager {
     if (data.hasOwnProperty("currentHour") && typeof data.currentHour === "number") {
       return data.currentHour;
     }
-    return _TimeManager.minDayHour;
+    return _TimeManager.minDayHours;
   }
   static set currentHour(value) {
     let data = import_pixi_vn.GameStorageManager.getVariable(TIME_DATA_KEY) || {};
@@ -224,9 +226,9 @@ var TimeManager = class _TimeManager {
   }
   static newHour(timeSpent = _TimeManager.defaultTimeSpent) {
     let newHour = _TimeManager.currentHour + timeSpent;
-    if (newHour >= _TimeManager.maxDayHour) {
+    if (newHour >= _TimeManager.maxDayHours) {
       _TimeManager.newDay();
-      newHour = _TimeManager.minDayHour + (newHour - _TimeManager.maxDayHour);
+      newHour = _TimeManager.minDayHours + (newHour - _TimeManager.maxDayHours);
     }
     _TimeManager.currentHour = newHour;
     return newHour;
@@ -265,13 +267,13 @@ var ActivityStoredAbstract = class {
     this.setStorageProperty("name", value);
   }
   get fromHour() {
-    return this.getStorageProperty("fromHour") || this.defaultFromHour || TimeManager.minDayHour;
+    return this.getStorageProperty("fromHour") || this.defaultFromHour || TimeManager.minDayHours;
   }
   set fromHour(value) {
     this.setStorageProperty("fromHour", value);
   }
   get toHour() {
-    return this.getStorageProperty("toHour") || this.defaultToHour || TimeManager.maxDayHour + 1;
+    return this.getStorageProperty("toHour") || this.defaultToHour || TimeManager.maxDayHours + 1;
   }
   set toHour(value) {
     this.setStorageProperty("toHour", value);
@@ -1078,13 +1080,13 @@ function currentActivities() {
 0 && (module.exports = {
   ActivityModel,
   ExecutionTypeEnum,
-  GameStepManager,
   Goal,
   LocationBaseModel,
   MapBaseModel,
   QuestBaseModel,
   RoomBaseModel,
   StageBaseModel,
+  TimeManager,
   addTemporaryCommitment,
   clearExpiredActivities,
   clearExpiredRoutine,