@drincs/nqtr 0.1.0 → 0.1.2

package/dist/index.mjs

@@ -1,3 +1,5 @@
+import { GameStorageManager, getFlag, StoredClassModel } from '@drincs/pixi-vn';
+
 var __defProp = Object.defineProperty;
 var __getOwnPropSymbols = Object.getOwnPropertySymbols;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
@@ -14,12 +16,6 @@ var __spreadValues = (a, b) => {
     }
   return a;
 };
-
-// src/classes/Activity.ts
-import { getFlag } from "@drincs/pixi-vn";
-
-// src/managers/TimeManager.ts
-import { GameStorageManager } from "@drincs/pixi-vn";
 var TIME_SETTINGS_KEY = "___nqtr-time_manager_settings___";
 var TIME_DATA_KEY = "___nqtr-time_manager_data___";
 var TimeManager = class _TimeManager {
@@ -60,6 +56,7 @@ var TimeManager = class _TimeManager {
   }
   /**
    * Get time settings
+   * @default {}
    */
   static get settings() {
     let settings = GameStorageManager.getVariable(TIME_SETTINGS_KEY) || {};
@@ -182,12 +179,13 @@ var TimeManager = class _TimeManager {
   /**
    * 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 void 0;
+      return "";
     }
     return _TimeManager.weekDaysNames[weekDayNumber];
   }
@@ -217,7 +215,7 @@ var TimeManager = class _TimeManager {
         }
       }
     }
-    return 0;
+    return _TimeManager.timeSlots.length - 1;
   }
   /**
    * This function will increase the current hour by the given time spent.
@@ -263,6 +261,10 @@ var TimeManager = class _TimeManager {
 
 // src/classes/Activity.ts
 var ActivityStoredAbstract = class {
+  /**
+   * @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(onRun, props) {
     this.defaultName = props.name;
     this.defaultFromHour = props.fromHour;
@@ -274,36 +276,54 @@ var ActivityStoredAbstract = class {
     this._icon = props.icon;
     this._onRun = onRun;
   }
+  /**
+   * The name
+   */
   get name() {
     return this.getStorageProperty("name") || this.defaultName || "";
   }
   set name(value) {
     this.setStorageProperty("name", value);
   }
+  /**
+   * The hour when the activity starts. If the activity is not started yet, it will be hidden.
+   */
   get fromHour() {
     return this.getStorageProperty("fromHour") || this.defaultFromHour || TimeManager.minDayHours;
   }
   set fromHour(value) {
     this.setStorageProperty("fromHour", value);
   }
+  /**
+   * The hour when the activity ends. If the activity is ended yet, it will be hidden.
+   */
   get toHour() {
     return this.getStorageProperty("toHour") || this.defaultToHour || TimeManager.maxDayHours + 1;
   }
   set toHour(value) {
     this.setStorageProperty("toHour", value);
   }
+  /**
+   * The day when the activity starts. If the activity is not started yet, it will be hidden.
+   */
   get fromDay() {
     return this.getStorageProperty("fromDay") || this.defaultFromDay;
   }
   set fromDay(value) {
     this.setStorageProperty("fromDay", value);
   }
+  /**
+   * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
+   */
   get toDay() {
     return this.getStorageProperty("toDay") || this.defaultToDay;
   }
   set toDay(value) {
     this.setStorageProperty("toDay", value);
   }
+  /**
+   * Whether is disabled.
+   */
   get disabled() {
     let value = this.getStorageProperty("disabled") || this.defaultDisabled;
     if (typeof value === "string") {
@@ -314,6 +334,9 @@ var ActivityStoredAbstract = class {
   set disabled(value) {
     this.setStorageProperty("disabled", value);
   }
+  /**
+   * 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;
@@ -333,18 +356,32 @@ var ActivityStoredAbstract = class {
   set hidden(value) {
     this.setStorageProperty("hidden", value);
   }
+  /**
+   * The icon element.
+   */
   get icon() {
     return this._icon;
   }
+  /**
+   * The function that is called when the activity is runned.
+   */
   get onRun() {
     return () => this._onRun(this);
   }
+  /**
+   * Whether the activity is a deadline.
+   * @returns Whether the activity is a deadline.
+   */
   isExpired() {
     if (this.toDay && this.toDay <= TimeManager.currentDay) {
       return true;
     }
     return false;
   }
+  /**
+   * Export the activity properties.
+   * @returns The activity properties.
+   */
   export() {
     return {
       name: this.getStorageProperty("name") || this.defaultName,
@@ -359,6 +396,11 @@ var ActivityStoredAbstract = class {
   }
 };
 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;
@@ -371,30 +413,54 @@ var ActivityModel = class {
     this._icon = props.icon;
     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 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;
@@ -407,18 +473,32 @@ var ActivityModel = class {
     }
     return this._hidden;
   }
+  /**
+   * The icon element.
+   */
   get icon() {
     return this._icon;
   }
+  /**
+   * The function that is called when the activity is runned.
+   */
   get onRun() {
     return () => this._onRun(this);
   }
+  /**
+   * 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,
@@ -433,9 +513,6 @@ var ActivityModel = class {
   }
 };
 
-// src/classes/Commitment.ts
-import { getFlag as getFlag2, StoredClassModel } from "@drincs/pixi-vn";
-
 // src/enums/ExecutionTypeEnum.ts
 var ExecutionTypeEnum = /* @__PURE__ */ ((ExecutionTypeEnum2) => {
   ExecutionTypeEnum2["AUTOMATIC"] = "automatic";
@@ -553,7 +630,7 @@ var CommitmentBaseModel = class extends StoredClassModel {
   get disabled() {
     let value = this.getStorageProperty("disabled") || this.defaultDisabled;
     if (typeof value === "string") {
-      return getFlag2(value);
+      return getFlag(value);
     }
     return value;
   }
@@ -575,7 +652,7 @@ var CommitmentBaseModel = class extends StoredClassModel {
     }
     let value = this.getStorageProperty("hidden") || this.defaultHidden;
     if (typeof value === "string") {
-      return getFlag2(value);
+      return getFlag(value);
     }
     return value;
   }
@@ -594,9 +671,6 @@ var CommitmentBaseModel = class extends StoredClassModel {
   }
 };
 
-// src/classes/navigation/Location.ts
-import { getFlag as getFlag3, StoredClassModel as StoredClassModel2 } from "@drincs/pixi-vn";
-
 // src/decorators/RoomDecorator.ts
 var registeredRooms = {};
 function saveRoom(room) {
@@ -645,7 +719,7 @@ function getAllMaps() {
 
 // src/classes/navigation/Location.ts
 var LOCATION_CATEGORY = "__nqtr-location__";
-var LocationBaseModel = class extends StoredClassModel2 {
+var LocationBaseModel = class extends StoredClassModel {
   /**
    * @param id The id of the location, it must be unique.
    * @param map The map where the location is.
@@ -675,7 +749,7 @@ var LocationBaseModel = class extends StoredClassModel2 {
   get disabled() {
     let value = this.getStorageProperty("disabled") || this.defaultDisabled;
     if (typeof value === "string") {
-      return getFlag3(value);
+      return getFlag(value);
     }
     return value;
   }
@@ -688,7 +762,7 @@ var LocationBaseModel = class extends StoredClassModel2 {
   get hidden() {
     let value = this.getStorageProperty("hidden") || this.defaultHidden;
     if (typeof value === "string") {
-      return getFlag3(value);
+      return getFlag(value);
     }
     return value;
   }
@@ -737,11 +811,8 @@ var LocationBaseModel = class extends StoredClassModel2 {
     return getRoomsByLocation(this);
   }
 };
-
-// src/classes/navigation/Map.ts
-import { getFlag as getFlag4, StoredClassModel as StoredClassModel3 } from "@drincs/pixi-vn";
 var MAP_CATEGORY = "__nqtr-map__";
-var MapBaseModel = class extends StoredClassModel3 {
+var MapBaseModel = class extends StoredClassModel {
   /**
    * @param id The id of the map, it must be unique.
    * @param props The properties of the map. 
@@ -779,7 +850,7 @@ var MapBaseModel = class extends StoredClassModel3 {
   get disabled() {
     let value = this.getStorageProperty("disabled") || this.defaultDisabled;
     if (typeof value === "string") {
-      return getFlag4(value);
+      return getFlag(value);
     }
     return value;
   }
@@ -792,7 +863,7 @@ var MapBaseModel = class extends StoredClassModel3 {
   get hidden() {
     let value = this.getStorageProperty("hidden") || this.defaultHidden;
     if (typeof value === "string") {
-      return getFlag4(value);
+      return getFlag(value);
     }
     return value;
   }
@@ -801,6 +872,15 @@ var MapBaseModel = class extends StoredClassModel3 {
   }
   /**
    * The neighboring maps that are available in this map.
+   * @example
+   * ```ts
+   * {
+   *     "north": "atlanta_map_id",
+   *     "south": "miami_map_id",
+   *     "east": "new_york_map_id",
+   *     "west": "los_angeles_map_id"
+   * }
+   * ```
    */
   get neighboringMaps() {
     return this._neighboringMaps || {};
@@ -817,9 +897,6 @@ var MapBaseModel = class extends StoredClassModel3 {
   }
 };
 
-// src/classes/navigation/Room.ts
-import { getFlag as getFlag5, StoredClassModel as StoredClassModel4 } from "@drincs/pixi-vn";
-
 // src/decorators/ActivityDecorator.ts
 var registeredActivities = {};
 function saveActivity(activity) {
@@ -845,9 +922,6 @@ function getActivityById(id) {
     return;
   }
 }
-
-// src/decorators/CommitmentDecorator.ts
-import { GameStorageManager as GameStorageManager2 } from "@drincs/pixi-vn";
 var TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY = "___nqtr-temporary_commitment___";
 var registeredCommitments = {};
 var fixedCommitments = {};
@@ -896,13 +970,13 @@ function addTemporaryCommitment(commitment) {
     }
     return commitment2.id;
   }).filter((id) => id !== void 0);
-  GameStorageManager2.setVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY, [commitmentsIds]);
+  GameStorageManager.setVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY, [commitmentsIds]);
 }
 function getFixedCommitments() {
   return Object.values(fixedCommitments);
 }
 function getTemporaryCommitments() {
-  let commitmentsIds = GameStorageManager2.getVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY);
+  let commitmentsIds = GameStorageManager.getVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY);
   if (!commitmentsIds) {
     return [];
   }
@@ -1008,7 +1082,7 @@ var ActivityRoom = class extends ActivityStoredAbstract {
 
 // src/classes/navigation/Room.ts
 var ROOM_CATEGORY = "__nqtr-room__";
-var RoomBaseModel = class extends StoredClassModel4 {
+var RoomBaseModel = class extends StoredClassModel {
   /**
    * @param id The id of the room, it must be unique.
    * @param location The location where the room is.
@@ -1193,7 +1267,7 @@ var RoomBaseModel = class extends StoredClassModel4 {
   get disabled() {
     let value = this.getStorageProperty("disabled") || this.defaultDisabled;
     if (typeof value === "string") {
-      return getFlag5(value);
+      return getFlag(value);
     }
     return value;
   }
@@ -1206,7 +1280,7 @@ var RoomBaseModel = class extends StoredClassModel4 {
   get hidden() {
     let value = this.getStorageProperty("hidden") || this.defaultHidden;
     if (typeof value === "string") {
-      return getFlag5(value);
+      return getFlag(value);
     }
     return value;
   }
@@ -1253,11 +1327,8 @@ var Goal = class {
     };
   }
 };
-
-// src/classes/quest/Quest.ts
-import { StoredClassModel as StoredClassModel5 } from "@drincs/pixi-vn";
 var QUEST_CATEGORY = "__nqtr-quest__";
-var QuestBaseModel = class extends StoredClassModel5 {
+var QuestBaseModel = class extends StoredClassModel {
   constructor(id, stages, props) {
     super(QUEST_CATEGORY, id);
     this._stages = stages;
@@ -1286,11 +1357,8 @@ var QuestBaseModel = class extends StoredClassModel5 {
     return this._isInDevelopment;
   }
 };
-
-// src/classes/quest/Stage.ts
-import { StoredClassModel as StoredClassModel6 } from "@drincs/pixi-vn";
 var STAGE_CATEGORY = "__nqtr-stage__";
-var StageBaseModel = class extends StoredClassModel6 {
+var StageBaseModel = class extends StoredClassModel {
   constructor(id, props) {
     super(STAGE_CATEGORY, id);
     this._completed = false;
@@ -1355,9 +1423,6 @@ var StageBaseModel = class extends StoredClassModel6 {
     return this._onEnd;
   }
 };
-
-// src/functions/NavigationFunctions.ts
-import { GameStorageManager as GameStorageManager3 } from "@drincs/pixi-vn";
 var CURRENT_ROOM_MEMORY_KEY = "___nqtr-current_room_memory___";
 function setCurrentRoom(room) {
   if (room instanceof LocationBaseModel) {
@@ -1374,10 +1439,10 @@ function setCurrentRoom(room) {
       return;
     }
   }
-  GameStorageManager3.setVariable(CURRENT_ROOM_MEMORY_KEY, room.id);
+  GameStorageManager.setVariable(CURRENT_ROOM_MEMORY_KEY, room.id);
 }
 function getCurrentRoom() {
-  let roomId = GameStorageManager3.getVariable(CURRENT_ROOM_MEMORY_KEY);
+  let roomId = GameStorageManager.getVariable(CURRENT_ROOM_MEMORY_KEY);
   if (!roomId) {
     console.error(`[NQTR] The current room has not yet been set`);
     return;
@@ -1417,37 +1482,7 @@ function currentActivities() {
   }
   return currentRoom.activities.filter((activity) => !activity.hidden);
 }
-export {
-  ActivityModel,
-  CommitmentBaseModel,
-  ExecutionTypeEnum,
-  Goal,
-  LocationBaseModel,
-  MapBaseModel,
-  QuestBaseModel,
-  RoomBaseModel,
-  StageBaseModel,
-  TimeManager,
-  addTemporaryCommitment,
-  clearExpiredActivities,
-  clearExpiredRoutine,
-  currentActivities,
-  getActivityById,
-  getAllLocations,
-  getAllMaps,
-  getCommitmentByCharacter,
-  getCommitmentById,
-  getCueerntMap,
-  getCurrenrLocation,
-  getCurrentCommitments,
-  getCurrentRoom,
-  getFixedCommitments,
-  getRoomById,
-  getTemporaryCommitments,
-  saveActivity,
-  saveCommitment,
-  saveRoom,
-  setCurrentRoom,
-  setFixedCommitments
-};
+
+export { ActivityModel, CommitmentBaseModel, ExecutionTypeEnum, Goal, LocationBaseModel, MapBaseModel, QuestBaseModel, RoomBaseModel, StageBaseModel, TimeManager, addTemporaryCommitment, clearExpiredActivities, clearExpiredRoutine, currentActivities, getActivityById, getAllLocations, getAllMaps, getCommitmentByCharacter, getCommitmentById, getCueerntMap, getCurrenrLocation, getCurrentCommitments, getCurrentRoom, getFixedCommitments, getRoomById, getTemporaryCommitments, saveActivity, saveCommitment, saveRoom, setCurrentRoom, setFixedCommitments };
+//# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.mjs.map