@drincs/nqtr 0.1.0 → 0.1.1

package/dist/index.js

@@ -113,6 +113,7 @@ var TimeManager = class _TimeManager {
   }
   /**
    * Get time settings
+   * @default {}
    */
   static get settings() {
     let settings = import_pixi_vn.GameStorageManager.getVariable(TIME_SETTINGS_KEY) || {};
@@ -235,12 +236,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];
   }
@@ -270,7 +272,7 @@ var TimeManager = class _TimeManager {
         }
       }
     }
-    return 0;
+    return _TimeManager.timeSlots.length - 1;
   }
   /**
    * This function will increase the current hour by the given time spent.
@@ -316,6 +318,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;
@@ -327,36 +333,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") {
@@ -367,6 +391,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;
@@ -386,18 +413,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,
@@ -412,6 +453,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;
@@ -424,30 +470,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 (0, import_pixi_vn2.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;
@@ -460,18 +530,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,