@drincs/nqtr 0.0.4 → 0.0.6

package/dist/index.mjs

@@ -270,7 +270,7 @@ var ActivityStoredAbstract = class {
     this.defaultToDay = props.toDay;
     this.defaultDisabled = props.disabled || false;
     this.defaultHidden = props.hidden || false;
-    this._iconElement = props.iconElement;
+    this._icon = props.icon;
     this._onRun = onRun;
   }
   get name() {
@@ -332,8 +332,8 @@ var ActivityStoredAbstract = class {
   set hidden(value) {
     this.setStorageProperty("hidden", value);
   }
-  get iconElement() {
-    return this._iconElement;
+  get icon() {
+    return this._icon;
   }
   get onRun() {
     return this._onRun;
@@ -353,7 +353,7 @@ var ActivityStoredAbstract = class {
       toDay: this.getStorageProperty("toDay") || this.defaultToDay,
       disabled: this.getStorageProperty("disabled") || this.defaultDisabled,
       hidden: this.getStorageProperty("hidden") || this.defaultHidden,
-      iconElement: this._iconElement
+      icon: this._icon
     };
   }
 };
@@ -367,7 +367,7 @@ var ActivityModel = class {
     this._toDay = props.toDay;
     this._disabled = props.disabled || false;
     this._hidden = props.hidden || false;
-    this._iconElement = props.iconElement;
+    this._icon = props.icon;
     this._onRun = onRun;
   }
   get id() {
@@ -406,8 +406,8 @@ var ActivityModel = class {
     }
     return this._hidden;
   }
-  get iconElement() {
-    return this._iconElement;
+  get icon() {
+    return this._icon;
   }
   get onRun() {
     return this._onRun;
@@ -427,14 +427,175 @@ var ActivityModel = class {
       toDay: this._toDay,
       disabled: this._disabled,
       hidden: this._hidden,
-      iconElement: this._iconElement
+      icon: this._icon
     };
   }
 };
 
-// src/classes/navigation/Location.ts
+// src/classes/Commitment.ts
 import { getFlag as getFlag2, StoredClassModel } from "@drincs/pixi-vn";
 
+// src/enums/ExecutionTypeEnum.ts
+var ExecutionTypeEnum = /* @__PURE__ */ ((ExecutionTypeEnum2) => {
+  ExecutionTypeEnum2["AUTOMATIC"] = "automatic";
+  ExecutionTypeEnum2["INTERACTION"] = "interaction";
+  return ExecutionTypeEnum2;
+})(ExecutionTypeEnum || {});
+
+// src/classes/Commitment.ts
+var COMMITMENT_CATEGORY = "__nqtr-commitment__";
+var CommitmentBaseModel = class extends StoredClassModel {
+  /**
+   * @param id The id of the commitment, it must be unique.
+   * @param character The character or characters that are in the commitment and so in the room.
+   * @param room The room where the commitment is.
+   * @param props The properties of the commitment.
+   */
+  constructor(id, character, room, props) {
+    super(COMMITMENT_CATEGORY, id);
+    this._characters = character ? Array.isArray(character) ? character : [character] : [];
+    this._room = room;
+    this._name = props.name || "";
+    this.defaultFromHour = props.fromHour;
+    this.defaultToHour = props.toHour;
+    this.defaultFromDay = props.fromDay;
+    this.defaultToDay = props.toDay;
+    this._image = props.image;
+    this._executionType = props.executionType || "interaction" /* INTERACTION */;
+    this._onRun = props.onRun;
+    this.defaultDisabled = props.disabled || false;
+    this.defaultHidden = props.hidden || false;
+  }
+  /**
+   * The character or characters that are in the commitment and so in the room.
+   */
+  get characters() {
+    return this._characters;
+  }
+  /**
+   * The room where the commitment is.
+   */
+  get room() {
+    return this._room;
+  }
+  /**
+   * The name
+   */
+  get name() {
+    return this._name;
+  }
+  /**
+   * The hour when the commitment starts. If the commitment is not started yet, it will be hidden.
+   * If you set undefined, it will return the initial value of fromHour.
+   */
+  get fromHour() {
+    return this.getStorageProperty("fromHour") || this.defaultFromHour || TimeManager.minDayHours;
+  }
+  set fromHour(value) {
+    this.setStorageProperty("fromHour", value);
+  }
+  /**
+   * The hour when the commitment ends. If the commitment is ended yet, it will be hidden.
+   * If you set undefined, it will return the initial value of toHour.
+   */
+  get toHour() {
+    return this.getStorageProperty("toHour") || this.defaultToHour || TimeManager.maxDayHours + 1;
+  }
+  set toHour(value) {
+    this.setStorageProperty("toHour", value);
+  }
+  /**
+   * The day when the commitment starts. If the commitment is not started yet, it will be hidden.
+   * If you set undefined, it will return the initial value of fromDay.
+   */
+  get fromDay() {
+    return this.getStorageProperty("fromDay") || this.defaultFromDay;
+  }
+  set fromDay(value) {
+    this.setStorageProperty("fromDay", value);
+  }
+  /**
+   * The day when the commitment ends. If the commitment is ended yet, it will be deleted or hidden.
+   * If you set undefined, it will return the initial value of toDay.
+   */
+  get toDay() {
+    return this.getStorageProperty("toDay") || this.defaultToDay;
+  }
+  set toDay(value) {
+    this.setStorageProperty("toDay", value);
+  }
+  /**
+   * The image. It can be a string, an Element or a Pixi'VN Canvas Item.
+   */
+  get image() {
+    return this._image;
+  }
+  /**
+   * Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
+   */
+  get executionType() {
+    return this._executionType;
+  }
+  /**
+   * Is a function that is called when the player interacts with the character.
+   */
+  onRun() {
+    if (!this._onRun) {
+      console.warn("[NQTR] onRun() is not defined for commitmen, so it will not run.", this);
+    } else {
+      this._onRun(this);
+    }
+  }
+  /**
+   * Whether is disabled. You can also pass a Pixi'VN flag name.
+   */
+  get disabled() {
+    let value = this.getStorageProperty("disabled") || this.defaultDisabled;
+    if (typeof value === "string") {
+      return getFlag2(value);
+    }
+    return value;
+  }
+  set disabled(value) {
+    this.setStorageProperty("disabled", value);
+  }
+  /**
+   * Whether is hidden. You can also pass a Pixi'VN flag name.
+   */
+  get hidden() {
+    if (this.fromDay && this.fromDay > TimeManager.currentDay) {
+      return true;
+    }
+    if (!TimeManager.nowIsBetween(this.fromHour, this.toHour)) {
+      return true;
+    }
+    if (!this.isExpired) {
+      return true;
+    }
+    let value = this.getStorageProperty("hidden") || this.defaultHidden;
+    if (typeof value === "string") {
+      return getFlag2(value);
+    }
+    return value;
+  }
+  set hidden(value) {
+    this.setStorageProperty("hidden", value);
+  }
+  /**
+   * Whether the commitment is expired.
+   * @returns Whether the commitment is expired.
+   */
+  isExpired() {
+    if (this.toDay && this.toDay <= TimeManager.currentDay) {
+      return true;
+    }
+    return false;
+  }
+};
+
+// 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) {
@@ -460,109 +621,203 @@ function getRoomById(id) {
     return;
   }
 }
-function getRoomByLocation(location) {
-  return Object.values(registeredRooms).filter((room) => room.location === location);
+function getRoomsByLocation(location) {
+  return Object.values(registeredRooms).filter((room) => room.location.id === location.id);
+}
+function getAllLocations() {
+  let result = {};
+  Object.values(registeredRooms).forEach((room) => {
+    result[room.location.id] = room.location;
+  });
+  return Object.values(result);
+}
+function getLocationsByMap(map) {
+  return getAllLocations().filter((location) => location.map.id === map.id);
+}
+function getAllMaps() {
+  let result = {};
+  Object.values(registeredRooms).forEach((room) => {
+    result[room.location.map.id] = room.location.map;
+  });
+  return Object.values(result);
 }
 
 // src/classes/navigation/Location.ts
 var LOCATION_CATEGORY = "__nqtr-location__";
-var LocationBaseModel = class extends StoredClassModel {
-  constructor(id, map, props) {
+var LocationBaseModel = class extends StoredClassModel2 {
+  /**
+   * @param id The id of the location, it must be unique.
+   * @param map The map where the location is.
+   * @param props The properties of the location.
+   */
+  constructor(id, map, props = {}) {
     super(LOCATION_CATEGORY, id);
     this.defaultName = props.name || "";
     this.defaultDisabled = props.disabled || false;
     this.defaultHidden = props.hidden || false;
-    this._iconElement = props.iconElement;
+    this._icon = props.icon;
     this._map = map;
   }
-  getEntrance() {
-    let rooms = getRoomByLocation(this);
-    if (rooms.length === 0) {
-      return;
-    }
-    return rooms.find((room) => room.isEntrance) || rooms[0];
-  }
+  /**
+   * The name of the location.
+   * If you set undefined, it will return the initial value of name.
+   */
   get name() {
     return this.getStorageProperty("name") || this.defaultName;
   }
   set name(value) {
     this.setStorageProperty("name", value);
   }
+  /**
+   * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
+   */
   get disabled() {
     let value = this.getStorageProperty("disabled") || this.defaultDisabled;
     if (typeof value === "string") {
-      return getFlag2(value);
+      return getFlag3(value);
     }
     return value;
   }
   set disabled(value) {
     this.setStorageProperty("disabled", value);
   }
+  /**
+   * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
+   */
   get hidden() {
     let value = this.getStorageProperty("hidden") || this.defaultHidden;
     if (typeof value === "string") {
-      return getFlag2(value);
+      return getFlag3(value);
     }
     return value;
   }
   set hidden(value) {
     this.setStorageProperty("hidden", value);
   }
-  get iconElement() {
-    return this._iconElement;
+  /**
+   * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
+   */
+  get icon() {
+    return this._icon;
   }
+  /**
+   * The map where the location is.
+   */
   get map() {
     return this._map;
   }
+  /**
+   * Get the entrance room of the location.
+   * You can cast the room to a specific type that extends RoomBaseModel.
+   * @returns The entrance room or the first room if there is no entrance.
+   * @example
+   * ```typescript
+   * const entranceHome = new RoomBaseModel("entrance-home", home, { isEntrance: true })
+   * saveRoom(entranceHome)
+   * const home = new LocationBaseModel("home", map, { name: "Home" })
+   * 
+   * const entrance = home.getEntrance() // entrance === entranceHome
+   * ```
+   */
+  getEntrance() {
+    let rooms = this.getRooms();
+    if (rooms.length === 0) {
+      console.error(`[NQTR] The location ${this.id} has no rooms`);
+      return;
+    }
+    return rooms.find((room) => room.isEntrance) || rooms[0];
+  }
+  /**
+   * Get all rooms in the location.
+   * You can cast the rooms to a specific type that extends RoomBaseModel.
+   * @returns The rooms in the location.
+   */
+  getRooms() {
+    return getRoomsByLocation(this);
+  }
 };
 
 // src/classes/navigation/Map.ts
-import { getFlag as getFlag3, StoredClassModel as StoredClassModel2 } from "@drincs/pixi-vn";
+import { getFlag as getFlag4, StoredClassModel as StoredClassModel3 } from "@drincs/pixi-vn";
 var MAP_CATEGORY = "__nqtr-map__";
-var MapBaseModel = class extends StoredClassModel2 {
-  constructor(id, props) {
+var MapBaseModel = class extends StoredClassModel3 {
+  /**
+   * @param id The id of the map, it must be unique.
+   * @param props The properties of the map. 
+   */
+  constructor(id, props = {}) {
     super(MAP_CATEGORY, id);
     this.defaultName = props.name || "";
     this.defaultImage = props.image;
     this.defaultDisabled = props.disabled || false;
     this.defaultHidden = props.hidden || false;
   }
+  /**
+   * The name of the map.
+   * If you set undefined, it will return the initial value of name.
+   */
   get name() {
     return this.getStorageProperty("name") || this.defaultName;
   }
   set name(value) {
     this.setStorageProperty("name", value);
   }
+  /**
+   * The image of the map. It can be a string, an Element or a Pixi'VN Canvas Item.
+   * If you set undefined, it will return the initial value of image.
+   */
   get image() {
     return this.getStorageProperty("image") || this.defaultImage;
   }
   set image(value) {
     this.setStorageProperty("image", value);
   }
+  /**
+   * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
+   */
   get disabled() {
     let value = this.getStorageProperty("disabled") || this.defaultDisabled;
     if (typeof value === "string") {
-      return getFlag3(value);
+      return getFlag4(value);
     }
     return value;
   }
   set disabled(value) {
     this.setStorageProperty("disabled", value);
   }
+  /**
+   * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
+   */
   get hidden() {
     let value = this.getStorageProperty("hidden") || this.defaultHidden;
     if (typeof value === "string") {
-      return getFlag3(value);
+      return getFlag4(value);
     }
     return value;
   }
   set hidden(value) {
     this.setStorageProperty("hidden", value);
   }
+  /**
+   * The neighboring maps that are available in this map.
+   */
+  get neighboringMaps() {
+    return this._neighboringMaps || {};
+  }
+  set neighboringMaps(value) {
+    this._neighboringMaps = value;
+  }
+  /**
+   * Get all locations in the map.
+   * @returns The locations in the map.
+   */
+  getLocations() {
+    return getLocationsByMap(this);
+  }
 };
 
 // src/classes/navigation/Room.ts
-import { getFlag as getFlag4, StoredClassModel as StoredClassModel3 } from "@drincs/pixi-vn";
+import { getFlag as getFlag5, StoredClassModel as StoredClassModel4 } from "@drincs/pixi-vn";
 
 // src/decorators/ActivityDecorator.ts
 var registeredActivities = {};
@@ -752,8 +1007,13 @@ var ActivityRoom = class extends ActivityStoredAbstract {
 
 // src/classes/navigation/Room.ts
 var ROOM_CATEGORY = "__nqtr-room__";
-var RoomBaseModel = class extends StoredClassModel3 {
-  constructor(id, location, props) {
+var RoomBaseModel = class extends StoredClassModel4 {
+  /**
+   * @param id The id of the room, it must be unique.
+   * @param location The location where the room is.
+   * @param props The properties of the room.
+   */
+  constructor(id, location, props = {}) {
     var _a;
     super(ROOM_CATEGORY, id);
     this._location = location;
@@ -762,27 +1022,44 @@ var RoomBaseModel = class extends StoredClassModel3 {
     this.defaultActivityIds = ((_a = props.defaultActivities) == null ? void 0 : _a.map((activity) => activity.id)) || [];
     this.defaultDisabled = props.disabled || false;
     this.defaultHidden = props.hidden || false;
-    this._iconElement = props.iconElement;
+    this._icon = props.icon;
     this._isEntrance = props.isEntrance;
   }
+  /**
+   * The location where the room is.
+   */
   get location() {
     return this._location;
   }
+  /**
+   * Whether is an entrance room, so when the player enters in the location, it will be the first room to be shown.
+   */
   get isEntrance() {
     return this._isEntrance || false;
   }
+  /**
+   * The name.
+   * If you set undefined, it will return the initial value of name.
+   */
   get name() {
     return this.getStorageProperty("name") || this.defaultName;
   }
   set name(value) {
     this.setStorageProperty("name", value);
   }
+  /**
+   * The image. It can be a string, an Element or a Pixi'VN Canvas Item.
+   * If you set undefined, it will return the initial value of image.
+   */
   get image() {
     return this.getStorageProperty("image") || this.defaultImage;
   }
   set image(value) {
     this.setStorageProperty("image", value);
   }
+  /**
+   * The activities that are available in this room.
+   */
   get defaultActivities() {
     let roomMemories = this.getStorageProperty("activities_memory") || {};
     let activities = this.defaultActivityIds.map((id) => {
@@ -803,17 +1080,30 @@ var RoomBaseModel = class extends StoredClassModel3 {
     let addedActivityIds = this.getStorageProperty(`addedActivityIds`) || [];
     return this.defaultActivityIds.concat(addedActivityIds);
   }
+  /**
+   * The activities that are available in this room.
+   */
   get activities() {
     let activities = this.activityIds.map((id) => {
       return this.getActivity(id);
     }).filter((activity) => activity !== void 0);
     return activities;
   }
+  /**
+   * Get the memory of an activity. This function can be used into olther libraries to get the memory of the activity.
+   * @param id The id of the activity.
+   * @returns The memory of the activity.
+   */
   getActivityMemory(id) {
     let roomMemories = this.getStorageProperty("activities_memory") || {};
     let roomMemory = roomMemories[id] || {};
     return roomMemory;
   }
+  /**
+   * Get the activity by id.
+   * @param id The id of the activity.
+   * @returns The room activity.
+   */
   getActivity(id) {
     if (!this.activityIds.includes(id)) {
       console.error(`[NQTR] Activity with id ${id} not found in room ${this.id}`);
@@ -829,11 +1119,20 @@ var RoomBaseModel = class extends StoredClassModel3 {
     roomMemory = __spreadValues(__spreadValues({}, activity.export()), roomMemory);
     return new ActivityRoom(id, this, activity.onRun, roomMemory);
   }
+  /**
+   * Set the memory of an activity. This function can be used into olther libraries to set the memory of the activity.
+   * @param id The id of the activity.
+   * @param memory The memory of the activity.
+   */
   setActivity(activity) {
     let roomMemories = this.getStorageProperty("activities_memory") || {};
     roomMemories[activity.id] = activity.export();
     this.setStorageProperty("activities_memory", roomMemories);
   }
+  /**
+   * Add an activity to the room.
+   * @param activity The activity to add.
+   */
   addActivity(activity) {
     if (this.activityIds.includes(activity.id)) {
       let currentActivity = this.getActivity(activity.id);
@@ -849,6 +1148,10 @@ var RoomBaseModel = class extends StoredClassModel3 {
     addedActivityIds.push(activity.id);
     this.setStorageProperty("addedActivityIds", addedActivityIds);
   }
+  /**
+   * Remove an activity from the room.
+   * @param activity The activity to remove.
+   */
   removeActivity(activity) {
     let activityId = typeof activity === "string" ? activity : activity.id;
     if (this.defaultActivityIds.includes(activityId)) {
@@ -873,6 +1176,9 @@ var RoomBaseModel = class extends StoredClassModel3 {
     delete roomMemories[activityId];
     this.setStorageProperty("activities_memory", roomMemories);
   }
+  /**
+   * Clear all expired activities.
+   */
   clearExpiredActivities() {
     this.activities.forEach((activity) => {
       if (activity.isExpired()) {
@@ -880,29 +1186,39 @@ var RoomBaseModel = class extends StoredClassModel3 {
       }
     });
   }
+  /**
+   * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
+   */
   get disabled() {
     let value = this.getStorageProperty("disabled") || this.defaultDisabled;
     if (typeof value === "string") {
-      return getFlag4(value);
+      return getFlag5(value);
     }
     return value;
   }
   set disabled(value) {
     this.setStorageProperty("disabled", value);
   }
+  /**
+   * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
+   */
   get hidden() {
     let value = this.getStorageProperty("hidden") || this.defaultHidden;
     if (typeof value === "string") {
-      return getFlag4(value);
+      return getFlag5(value);
     }
     return value;
   }
   set hidden(value) {
     this.setStorageProperty("hidden", value);
   }
-  get iconElement() {
-    return this._iconElement;
+  get icon() {
+    return this._icon;
   }
+  /**
+   * Get the character commitments of the room.
+   * @returns The character commitments of the room.
+   */
   getRoutine() {
     let commitments = getCurrentCommitments();
     return commitments.filter((c) => c.room.id === this.id);
@@ -938,9 +1254,9 @@ var Goal = class {
 };
 
 // src/classes/quest/Quest.ts
-import { StoredClassModel as StoredClassModel4 } from "@drincs/pixi-vn";
+import { StoredClassModel as StoredClassModel5 } from "@drincs/pixi-vn";
 var QUEST_CATEGORY = "__nqtr-quest__";
-var QuestBaseModel = class extends StoredClassModel4 {
+var QuestBaseModel = class extends StoredClassModel5 {
   constructor(id, stages, props) {
     super(QUEST_CATEGORY, id);
     this._stages = stages;
@@ -971,9 +1287,9 @@ var QuestBaseModel = class extends StoredClassModel4 {
 };
 
 // src/classes/quest/Stage.ts
-import { StoredClassModel as StoredClassModel5 } from "@drincs/pixi-vn";
+import { StoredClassModel as StoredClassModel6 } from "@drincs/pixi-vn";
 var STAGE_CATEGORY = "__nqtr-stage__";
-var StageBaseModel = class extends StoredClassModel5 {
+var StageBaseModel = class extends StoredClassModel6 {
   constructor(id, props) {
     super(STAGE_CATEGORY, id);
     this._completed = false;
@@ -1039,21 +1355,23 @@ var StageBaseModel = class extends StoredClassModel5 {
   }
 };
 
-// src/enums/ExecutionTypeEnum.ts
-var ExecutionTypeEnum = /* @__PURE__ */ ((ExecutionTypeEnum2) => {
-  ExecutionTypeEnum2["AUTOMATIC"] = "automatic";
-  ExecutionTypeEnum2["INTERACTION"] = "interaction";
-  return ExecutionTypeEnum2;
-})(ExecutionTypeEnum || {});
-
 // src/functions/NavigationFunctions.ts
 import { GameStorageManager as GameStorageManager3 } from "@drincs/pixi-vn";
 var CURRENT_ROOM_MEMORY_KEY = "___nqtr-current_room_memory___";
 function setCurrentRoom(room) {
-  let roomRegistrated = getRoomById(room.id);
-  if (!roomRegistrated) {
-    console.error(`[NQTR] The room ${room.id} is not registered, so it can't be set as current room`);
-    return;
+  if (room instanceof LocationBaseModel) {
+    let entrance = room.getEntrance();
+    if (!entrance) {
+      console.error(`[NQTR] The location ${room.id} has no entrance room`);
+      return;
+    }
+    room = entrance;
+  } else {
+    let roomRegistrated = getRoomById(room.id);
+    if (!roomRegistrated) {
+      console.error(`[NQTR] The room ${room.id} is not registered, so it can't be set as current room`);
+      return;
+    }
   }
   localStorage.setItem(CURRENT_ROOM_MEMORY_KEY, room.id);
 }
@@ -1100,6 +1418,7 @@ function currentActivities() {
 }
 export {
   ActivityModel,
+  CommitmentBaseModel,
   ExecutionTypeEnum,
   Goal,
   LocationBaseModel,
@@ -1113,6 +1432,8 @@ export {
   clearExpiredRoutine,
   currentActivities,
   getActivityById,
+  getAllLocations,
+  getAllMaps,
   getCommitmentByCharacter,
   getCommitmentById,
   getCueerntMap,