@drincs/nqtr 0.0.4 → 0.0.5

package/dist/index.js

@@ -48,6 +48,8 @@ __export(src_exports, {
   clearExpiredRoutine: () => clearExpiredRoutine,
   currentActivities: () => currentActivities,
   getActivityById: () => getActivityById,
+  getAllLocations: () => getAllLocations,
+  getAllMaps: () => getAllMaps,
   getCommitmentByCharacter: () => getCommitmentByCharacter,
   getCommitmentById: () => getCommitmentById,
   getCueerntMap: () => getCueerntMap,
@@ -320,7 +322,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() {
@@ -382,8 +384,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;
@@ -403,7 +405,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
     };
   }
 };
@@ -417,7 +419,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() {
@@ -456,8 +458,8 @@ var ActivityModel = class {
     }
     return this._hidden;
   }
-  get iconElement() {
-    return this._iconElement;
+  get icon() {
+    return this._icon;
   }
   get onRun() {
     return this._onRun;
@@ -477,7 +479,7 @@ var ActivityModel = class {
       toDay: this._toDay,
       disabled: this._disabled,
       hidden: this._hidden,
-      iconElement: this._iconElement
+      icon: this._icon
     };
   }
 };
@@ -510,34 +512,56 @@ 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 import_pixi_vn3.StoredClassModel {
-  constructor(id, map, props) {
+  /**
+   * @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 default 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") {
@@ -548,6 +572,9 @@ var LocationBaseModel = class extends import_pixi_vn3.StoredClassModel {
   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") {
@@ -558,37 +585,87 @@ var LocationBaseModel = class extends import_pixi_vn3.StoredClassModel {
   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
 var import_pixi_vn4 = require("@drincs/pixi-vn");
 var MAP_CATEGORY = "__nqtr-map__";
 var MapBaseModel = class extends import_pixi_vn4.StoredClassModel {
-  constructor(id, props) {
+  /**
+   * @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 default 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 default 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") {
@@ -599,6 +676,9 @@ var MapBaseModel = class extends import_pixi_vn4.StoredClassModel {
   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") {
@@ -609,6 +689,13 @@ var MapBaseModel = class extends import_pixi_vn4.StoredClassModel {
   set hidden(value) {
     this.setStorageProperty("hidden", value);
   }
+  /**
+   * Get all locations in the map.
+   * @returns The locations in the map.
+   */
+  getLocations() {
+    return getLocationsByMap(this);
+  }
 };
 
 // src/classes/navigation/Room.ts
@@ -803,7 +890,12 @@ var ActivityRoom = class extends ActivityStoredAbstract {
 // src/classes/navigation/Room.ts
 var ROOM_CATEGORY = "__nqtr-room__";
 var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
-  constructor(id, location, props) {
+  /**
+   * @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;
@@ -812,27 +904,44 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
     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 default 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 default 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) => {
@@ -853,17 +962,30 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
     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}`);
@@ -879,11 +1001,20 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
     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);
@@ -899,6 +1030,10 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
     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)) {
@@ -923,6 +1058,9 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
     delete roomMemories[activityId];
     this.setStorageProperty("activities_memory", roomMemories);
   }
+  /**
+   * Clear all expired activities.
+   */
   clearExpiredActivities() {
     this.activities.forEach((activity) => {
       if (activity.isExpired()) {
@@ -930,6 +1068,9 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
       }
     });
   }
+  /**
+   * 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") {
@@ -940,6 +1081,9 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
   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") {
@@ -950,9 +1094,13 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
   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);
@@ -1100,10 +1248,19 @@ var ExecutionTypeEnum = /* @__PURE__ */ ((ExecutionTypeEnum2) => {
 var import_pixi_vn9 = require("@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);
 }
@@ -1164,6 +1321,8 @@ function currentActivities() {
   clearExpiredRoutine,
   currentActivities,
   getActivityById,
+  getAllLocations,
+  getAllMaps,
   getCommitmentByCharacter,
   getCommitmentById,
   getCueerntMap,