@drincs/nqtr 0.0.2 → 0.0.4

package/dist/index.d.mts

@@ -315,11 +315,17 @@ interface RoomBaseModelProps {
      * The icon element. Can be a string or an HTMLElement or a Pixi'VN CanvasItem
      */
     iconElement?: GraphicItemType;
+    /**
+     * Whether is an entrance room, so when the player enters in the location, it will be the first room to be shown.
+     */
+    isEntrance?: boolean;
 }
 declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseModel> extends StoredClassModel {
     constructor(id: string, location: TLocation, props: RoomBaseModelProps);
     private _location;
     get location(): TLocation;
+    private _isEntrance?;
+    get isEntrance(): boolean;
     private defaultName;
     get name(): string;
     set name(value: string);
@@ -370,9 +376,8 @@ interface LocationBaseModelProps {
     iconElement?: GraphicItemType;
 }
 declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extends StoredClassModel {
-    constructor(id: string, map: TMap, entrance: RoomBaseModel, props: LocationBaseModelProps);
-    private _entrance;
-    get entrance(): RoomBaseModel;
+    constructor(id: string, map: TMap, props: LocationBaseModelProps);
+    getEntrance<TRoom extends RoomBaseModel = RoomBaseModel>(): TRoom | undefined;
     private defaultName;
     get name(): string;
     set name(value: string);
@@ -574,15 +579,64 @@ declare class TimeManager {
     static get weekLength(): number;
     static get weekendStartDay(): number;
     static get weekDaysNames(): string[];
+    /**
+     * Get the current hour
+     */
     static get currentHour(): number;
     static set currentHour(value: number | undefined);
+    /**
+     * Get the current day
+     */
     static get currentDay(): number;
     static set currentDay(value: number | undefined);
+    /**
+     * If the current day is greater than or equal to the weekend start day, then it will return true.
+     */
     static get isWeekend(): boolean;
-    static get weekDayNumber(): number;
-    static get weekDayName(): string | undefined;
-    static newHour(timeSpent?: number): number;
-    static newDay(days?: number): number;
+    /**
+     * 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(): number;
+    /**
+     * 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'.
+     */
+    static get currentDayName(): string | undefined;
+    /**
+     * Get the current TimeManager.timeSlots index.
+     * You can use this property to create "Image that changes based on the time period":
+     * @example
+     * ```ts
+     * import { TimeManager } from '@drincs/nqtr';
+     *
+     * function changeBackground() {
+     *     return (
+     *         <img src={`background-${TimeManager.currentTimeSlot}.png`} />
+     *     )
+     * }
+     */
+    static get currentTimeSlots(): number;
+    /**
+     * 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?: number): number;
+    /**
+     * 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?: number, days?: number): number;
+    /**
+     * 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: number, toHour: number): boolean;
 }
 

package/dist/index.d.ts

@@ -315,11 +315,17 @@ interface RoomBaseModelProps {
      * The icon element. Can be a string or an HTMLElement or a Pixi'VN CanvasItem
      */
     iconElement?: GraphicItemType;
+    /**
+     * Whether is an entrance room, so when the player enters in the location, it will be the first room to be shown.
+     */
+    isEntrance?: boolean;
 }
 declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseModel> extends StoredClassModel {
     constructor(id: string, location: TLocation, props: RoomBaseModelProps);
     private _location;
     get location(): TLocation;
+    private _isEntrance?;
+    get isEntrance(): boolean;
     private defaultName;
     get name(): string;
     set name(value: string);
@@ -370,9 +376,8 @@ interface LocationBaseModelProps {
     iconElement?: GraphicItemType;
 }
 declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extends StoredClassModel {
-    constructor(id: string, map: TMap, entrance: RoomBaseModel, props: LocationBaseModelProps);
-    private _entrance;
-    get entrance(): RoomBaseModel;
+    constructor(id: string, map: TMap, props: LocationBaseModelProps);
+    getEntrance<TRoom extends RoomBaseModel = RoomBaseModel>(): TRoom | undefined;
     private defaultName;
     get name(): string;
     set name(value: string);
@@ -574,15 +579,64 @@ declare class TimeManager {
     static get weekLength(): number;
     static get weekendStartDay(): number;
     static get weekDaysNames(): string[];
+    /**
+     * Get the current hour
+     */
     static get currentHour(): number;
     static set currentHour(value: number | undefined);
+    /**
+     * Get the current day
+     */
     static get currentDay(): number;
     static set currentDay(value: number | undefined);
+    /**
+     * If the current day is greater than or equal to the weekend start day, then it will return true.
+     */
     static get isWeekend(): boolean;
-    static get weekDayNumber(): number;
-    static get weekDayName(): string | undefined;
-    static newHour(timeSpent?: number): number;
-    static newDay(days?: number): number;
+    /**
+     * 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(): number;
+    /**
+     * 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'.
+     */
+    static get currentDayName(): string | undefined;
+    /**
+     * Get the current TimeManager.timeSlots index.
+     * You can use this property to create "Image that changes based on the time period":
+     * @example
+     * ```ts
+     * import { TimeManager } from '@drincs/nqtr';
+     *
+     * function changeBackground() {
+     *     return (
+     *         <img src={`background-${TimeManager.currentTimeSlot}.png`} />
+     *     )
+     * }
+     */
+    static get currentTimeSlots(): number;
+    /**
+     * 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?: number): number;
+    /**
+     * 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?: number, days?: number): number;
+    /**
+     * 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: number, toHour: number): boolean;
 }
 

package/dist/index.js

@@ -177,6 +177,9 @@ var TimeManager = class _TimeManager {
     }
     return result;
   }
+  /**
+   * Get the current hour
+   */
   static get currentHour() {
     let data = import_pixi_vn.GameStorageManager.getVariable(TIME_DATA_KEY) || {};
     if (data.hasOwnProperty("currentHour") && typeof data.currentHour === "number") {
@@ -193,6 +196,9 @@ var TimeManager = class _TimeManager {
     }
     import_pixi_vn.GameStorageManager.setVariable(TIME_DATA_KEY, data);
   }
+  /**
+   * Get the current day
+   */
   static get currentDay() {
     let data = import_pixi_vn.GameStorageManager.getVariable(TIME_DATA_KEY) || {};
     if (data.hasOwnProperty("currentDay") && typeof data.currentDay === "number") {
@@ -209,35 +215,92 @@ var TimeManager = class _TimeManager {
     }
     import_pixi_vn.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.weekDayNumber >= _TimeManager.weekendStartDay;
+    return _TimeManager.currentWeekDayNumber >= _TimeManager.weekendStartDay;
   }
-  static get weekDayNumber() {
+  /**
+   * 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;
   }
-  static get weekDayName() {
-    let weekDayNumber = _TimeManager.weekDayNumber - 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'.
+   */
+  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 _TimeManager.weekDaysNames[weekDayNumber];
   }
-  static newHour(timeSpent = _TimeManager.defaultTimeSpent) {
+  /**
+   * Get the current TimeManager.timeSlots index.
+   * You can use this property to create "Image that changes based on the time period":
+   * @example
+   * ```ts
+   * import { TimeManager } from '@drincs/nqtr';
+   * 
+   * function changeBackground() {
+   *     return (
+   *         <img src={`background-${TimeManager.currentTimeSlot}.png`} />
+   *     )
+   * }
+   */
+  static get currentTimeSlots() {
+    if (_TimeManager.timeSlots.length === 0) {
+      console.warn("[NQTR] Time slots are not defined");
+      return 0;
+    }
+    _TimeManager.timeSlots.forEach((slot, index) => {
+      if (_TimeManager.timeSlots.length > index + 1) {
+        if (_TimeManager.nowIsBetween(slot.startHour, _TimeManager.timeSlots[index + 1].startHour)) {
+          return index;
+        }
+      }
+    });
+    return 0;
+  }
+  /**
+   * 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.newDay();
+      _TimeManager.increaseDay();
       newHour = _TimeManager.minDayHours + (newHour - _TimeManager.maxDayHours);
     }
     _TimeManager.currentHour = newHour;
-    return newHour;
+    return _TimeManager.currentHour;
   }
-  static newDay(days = 1) {
+  /**
+   * 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;
-    return 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) {
@@ -421,22 +484,53 @@ var ActivityModel = class {
 
 // src/classes/navigation/Location.ts
 var import_pixi_vn3 = require("@drincs/pixi-vn");
+
+// src/decorators/RoomDecorator.ts
+var registeredRooms = {};
+function saveRoom(room) {
+  if (Array.isArray(room)) {
+    room.forEach((c) => saveRoom(c));
+    return;
+  }
+  if (registeredRooms[room.id]) {
+    console.warn(`[NQTR] Room id ${room.id} already exists, it will be overwritten`);
+  }
+  registeredRooms[room.id] = room;
+}
+function getRoomById(id) {
+  try {
+    let room = registeredRooms[id];
+    if (!room) {
+      console.error(`[NQTR] Room ${id} not found`);
+      return;
+    }
+    return room;
+  } catch (e) {
+    console.error(`[NQTR] Error while getting Room ${id}`, e);
+    return;
+  }
+}
+function getRoomByLocation(location) {
+  return Object.values(registeredRooms).filter((room) => room.location === location);
+}
+
+// src/classes/navigation/Location.ts
 var LOCATION_CATEGORY = "__nqtr-location__";
 var LocationBaseModel = class extends import_pixi_vn3.StoredClassModel {
-  constructor(id, map, entrance, props) {
+  constructor(id, map, props) {
     super(LOCATION_CATEGORY, id);
-    if (entrance.location.id !== id) {
-      throw new Error(`[NQTR] Entrance room ${entrance.id} is not in location ${id}`);
-    }
-    this._entrance = entrance;
     this.defaultName = props.name || "";
     this.defaultDisabled = props.disabled || false;
     this.defaultHidden = props.hidden || false;
     this._iconElement = props.iconElement;
     this._map = map;
   }
-  get entrance() {
-    return this._entrance;
+  getEntrance() {
+    let rooms = getRoomByLocation(this);
+    if (rooms.length === 0) {
+      return;
+    }
+    return rooms.find((room) => room.isEntrance) || rooms[0];
   }
   get name() {
     return this.getStorageProperty("name") || this.defaultName;
@@ -610,32 +704,6 @@ function getTemporaryCommitments() {
   return commitments;
 }
 
-// src/decorators/RoomDecorator.ts
-var registeredRooms = {};
-function saveRoom(room) {
-  if (Array.isArray(room)) {
-    room.forEach((c) => saveRoom(c));
-    return;
-  }
-  if (registeredRooms[room.id]) {
-    console.warn(`[NQTR] Room id ${room.id} already exists, it will be overwritten`);
-  }
-  registeredRooms[room.id] = room;
-}
-function getRoomById(id) {
-  try {
-    let room = registeredRooms[id];
-    if (!room) {
-      console.error(`[NQTR] Room ${id} not found`);
-      return;
-    }
-    return room;
-  } catch (e) {
-    console.error(`[NQTR] Error while getting Room ${id}`, e);
-    return;
-  }
-}
-
 // src/functions/RoutineFunctions.ts
 function clearExpiredRoutine() {
   Object.entries(registeredCommitments).forEach(([_, commitment]) => {
@@ -745,10 +813,14 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
     this.defaultDisabled = props.disabled || false;
     this.defaultHidden = props.hidden || false;
     this._iconElement = props.iconElement;
+    this._isEntrance = props.isEntrance;
   }
   get location() {
     return this._location;
   }
+  get isEntrance() {
+    return this._isEntrance || false;
+  }
   get name() {
     return this.getStorageProperty("name") || this.defaultName;
   }