@drincs/nqtr 0.0.5 → 0.0.6

package/dist/index.js

@@ -35,6 +35,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   ActivityModel: () => ActivityModel,
+  CommitmentBaseModel: () => CommitmentBaseModel,
   ExecutionTypeEnum: () => ExecutionTypeEnum,
   Goal: () => Goal,
   LocationBaseModel: () => LocationBaseModel,
@@ -484,9 +485,170 @@ var ActivityModel = class {
   }
 };
 
-// src/classes/navigation/Location.ts
+// src/classes/Commitment.ts
 var import_pixi_vn3 = require("@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 import_pixi_vn3.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 (0, import_pixi_vn3.getFlag)(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 (0, import_pixi_vn3.getFlag)(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
+var import_pixi_vn4 = require("@drincs/pixi-vn");
+
 // src/decorators/RoomDecorator.ts
 var registeredRooms = {};
 function saveRoom(room) {
@@ -535,7 +697,7 @@ function getAllMaps() {
 
 // src/classes/navigation/Location.ts
 var LOCATION_CATEGORY = "__nqtr-location__";
-var LocationBaseModel = class extends import_pixi_vn3.StoredClassModel {
+var LocationBaseModel = class extends import_pixi_vn4.StoredClassModel {
   /**
    * @param id The id of the location, it must be unique.
    * @param map The map where the location is.
@@ -551,7 +713,7 @@ var LocationBaseModel = class extends import_pixi_vn3.StoredClassModel {
   }
   /**
    * The name of the location.
-   * If you set undefined, it will return the default name.
+   * If you set undefined, it will return the initial value of name.
    */
   get name() {
     return this.getStorageProperty("name") || this.defaultName;
@@ -565,7 +727,7 @@ var LocationBaseModel = class extends import_pixi_vn3.StoredClassModel {
   get disabled() {
     let value = this.getStorageProperty("disabled") || this.defaultDisabled;
     if (typeof value === "string") {
-      return (0, import_pixi_vn3.getFlag)(value);
+      return (0, import_pixi_vn4.getFlag)(value);
     }
     return value;
   }
@@ -578,7 +740,7 @@ var LocationBaseModel = class extends import_pixi_vn3.StoredClassModel {
   get hidden() {
     let value = this.getStorageProperty("hidden") || this.defaultHidden;
     if (typeof value === "string") {
-      return (0, import_pixi_vn3.getFlag)(value);
+      return (0, import_pixi_vn4.getFlag)(value);
     }
     return value;
   }
@@ -629,9 +791,9 @@ var LocationBaseModel = class extends import_pixi_vn3.StoredClassModel {
 };
 
 // src/classes/navigation/Map.ts
-var import_pixi_vn4 = require("@drincs/pixi-vn");
+var import_pixi_vn5 = require("@drincs/pixi-vn");
 var MAP_CATEGORY = "__nqtr-map__";
-var MapBaseModel = class extends import_pixi_vn4.StoredClassModel {
+var MapBaseModel = class extends import_pixi_vn5.StoredClassModel {
   /**
    * @param id The id of the map, it must be unique.
    * @param props The properties of the map. 
@@ -645,7 +807,7 @@ var MapBaseModel = class extends import_pixi_vn4.StoredClassModel {
   }
   /**
    * The name of the map.
-   * If you set undefined, it will return the default name.
+   * If you set undefined, it will return the initial value of name.
    */
   get name() {
     return this.getStorageProperty("name") || this.defaultName;
@@ -655,7 +817,7 @@ var MapBaseModel = class extends import_pixi_vn4.StoredClassModel {
   }
   /**
    * 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.
+   * If you set undefined, it will return the initial value of image.
    */
   get image() {
     return this.getStorageProperty("image") || this.defaultImage;
@@ -669,7 +831,7 @@ var MapBaseModel = class extends import_pixi_vn4.StoredClassModel {
   get disabled() {
     let value = this.getStorageProperty("disabled") || this.defaultDisabled;
     if (typeof value === "string") {
-      return (0, import_pixi_vn4.getFlag)(value);
+      return (0, import_pixi_vn5.getFlag)(value);
     }
     return value;
   }
@@ -682,13 +844,22 @@ var MapBaseModel = class extends import_pixi_vn4.StoredClassModel {
   get hidden() {
     let value = this.getStorageProperty("hidden") || this.defaultHidden;
     if (typeof value === "string") {
-      return (0, import_pixi_vn4.getFlag)(value);
+      return (0, import_pixi_vn5.getFlag)(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.
@@ -699,7 +870,7 @@ var MapBaseModel = class extends import_pixi_vn4.StoredClassModel {
 };
 
 // src/classes/navigation/Room.ts
-var import_pixi_vn6 = require("@drincs/pixi-vn");
+var import_pixi_vn7 = require("@drincs/pixi-vn");
 
 // src/decorators/ActivityDecorator.ts
 var registeredActivities = {};
@@ -728,7 +899,7 @@ function getActivityById(id) {
 }
 
 // src/decorators/CommitmentDecorator.ts
-var import_pixi_vn5 = require("@drincs/pixi-vn");
+var import_pixi_vn6 = require("@drincs/pixi-vn");
 var TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY = "___nqtr-temporary_commitment___";
 var registeredCommitments = {};
 var fixedCommitments = {};
@@ -777,13 +948,13 @@ function addTemporaryCommitment(commitment) {
     }
     return commitment2.id;
   }).filter((id) => id !== void 0);
-  import_pixi_vn5.GameStorageManager.setVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY, [commitmentsIds]);
+  import_pixi_vn6.GameStorageManager.setVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY, [commitmentsIds]);
 }
 function getFixedCommitments() {
   return Object.values(fixedCommitments);
 }
 function getTemporaryCommitments() {
-  let commitmentsIds = import_pixi_vn5.GameStorageManager.getVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY);
+  let commitmentsIds = import_pixi_vn6.GameStorageManager.getVariable(TEMPORARY_COMMITMENT_CATEGORY_MEMORY_KEY);
   if (!commitmentsIds) {
     return [];
   }
@@ -889,7 +1060,7 @@ var ActivityRoom = class extends ActivityStoredAbstract {
 
 // src/classes/navigation/Room.ts
 var ROOM_CATEGORY = "__nqtr-room__";
-var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
+var RoomBaseModel = class extends import_pixi_vn7.StoredClassModel {
   /**
    * @param id The id of the room, it must be unique.
    * @param location The location where the room is.
@@ -921,7 +1092,7 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
   }
   /**
    * The name.
-   * If you set undefined, it will return the default name.
+   * If you set undefined, it will return the initial value of name.
    */
   get name() {
     return this.getStorageProperty("name") || this.defaultName;
@@ -931,7 +1102,7 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
   }
   /**
    * 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.
+   * If you set undefined, it will return the initial value of image.
    */
   get image() {
     return this.getStorageProperty("image") || this.defaultImage;
@@ -1074,7 +1245,7 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
   get disabled() {
     let value = this.getStorageProperty("disabled") || this.defaultDisabled;
     if (typeof value === "string") {
-      return (0, import_pixi_vn6.getFlag)(value);
+      return (0, import_pixi_vn7.getFlag)(value);
     }
     return value;
   }
@@ -1087,7 +1258,7 @@ var RoomBaseModel = class extends import_pixi_vn6.StoredClassModel {
   get hidden() {
     let value = this.getStorageProperty("hidden") || this.defaultHidden;
     if (typeof value === "string") {
-      return (0, import_pixi_vn6.getFlag)(value);
+      return (0, import_pixi_vn7.getFlag)(value);
     }
     return value;
   }
@@ -1136,9 +1307,9 @@ var Goal = class {
 };
 
 // src/classes/quest/Quest.ts
-var import_pixi_vn7 = require("@drincs/pixi-vn");
+var import_pixi_vn8 = require("@drincs/pixi-vn");
 var QUEST_CATEGORY = "__nqtr-quest__";
-var QuestBaseModel = class extends import_pixi_vn7.StoredClassModel {
+var QuestBaseModel = class extends import_pixi_vn8.StoredClassModel {
   constructor(id, stages, props) {
     super(QUEST_CATEGORY, id);
     this._stages = stages;
@@ -1169,9 +1340,9 @@ var QuestBaseModel = class extends import_pixi_vn7.StoredClassModel {
 };
 
 // src/classes/quest/Stage.ts
-var import_pixi_vn8 = require("@drincs/pixi-vn");
+var import_pixi_vn9 = require("@drincs/pixi-vn");
 var STAGE_CATEGORY = "__nqtr-stage__";
-var StageBaseModel = class extends import_pixi_vn8.StoredClassModel {
+var StageBaseModel = class extends import_pixi_vn9.StoredClassModel {
   constructor(id, props) {
     super(STAGE_CATEGORY, id);
     this._completed = false;
@@ -1237,15 +1408,8 @@ var StageBaseModel = class extends import_pixi_vn8.StoredClassModel {
   }
 };
 
-// src/enums/ExecutionTypeEnum.ts
-var ExecutionTypeEnum = /* @__PURE__ */ ((ExecutionTypeEnum2) => {
-  ExecutionTypeEnum2["AUTOMATIC"] = "automatic";
-  ExecutionTypeEnum2["INTERACTION"] = "interaction";
-  return ExecutionTypeEnum2;
-})(ExecutionTypeEnum || {});
-
 // src/functions/NavigationFunctions.ts
-var import_pixi_vn9 = require("@drincs/pixi-vn");
+var import_pixi_vn10 = require("@drincs/pixi-vn");
 var CURRENT_ROOM_MEMORY_KEY = "___nqtr-current_room_memory___";
 function setCurrentRoom(room) {
   if (room instanceof LocationBaseModel) {
@@ -1265,7 +1429,7 @@ function setCurrentRoom(room) {
   localStorage.setItem(CURRENT_ROOM_MEMORY_KEY, room.id);
 }
 function getCurrentRoom() {
-  let roomId = import_pixi_vn9.GameStorageManager.getVariable(CURRENT_ROOM_MEMORY_KEY);
+  let roomId = import_pixi_vn10.GameStorageManager.getVariable(CURRENT_ROOM_MEMORY_KEY);
   if (!roomId) {
     console.error(`[NQTR] The current room has not yet been set`);
     return;
@@ -1308,6 +1472,7 @@ function currentActivities() {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ActivityModel,
+  CommitmentBaseModel,
   ExecutionTypeEnum,
   Goal,
   LocationBaseModel,