@drincs/nqtr 0.7.1 → 0.8.0

package/README.md

@@ -1,5 +1,15 @@
 # Navigation Quest Time Routine (NQTR)
 
+![cover](https://github.com/user-attachments/assets/9b514c5c-8243-4cdd-9129-ca5e45caec62)
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@drincs/nqtr" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/v/@drincs/nqtr?label=version" alt="npm version"></a>
+  <a href="https://www.npmjs.com/package/@drincs/nqtr" rel="noopener noreferrer nofollow"><img src="https://img.shields.io/npm/dm/@drincs/nqtr" alt="npm downloads per month"></a>
+  <a target="_blank" href="https://www.jsdelivr.com/package/npm/@drincs/nqtr" rel="noopener noreferrer nofollow"><img alt="jsDelivr hits (npm)" src="https://img.shields.io/jsdelivr/npm/hm/@drincs/nqtr?logo=jsdeliver"></a>
+  <a href="https://www.npmjs.com/package/@drincs/nqtr" rel="noopener noreferrer nofollow"><img alt="NPM License" src="https://img.shields.io/npm/l/@drincs/nqtr"></a>
+  <a target="_blank" href="https://discord.gg/E95FZWakzp" rel="noopener noreferrer nofollow"><img alt="Discord" src="https://img.shields.io/discord/1263071210011496501?color=7289da&label=discord"></a>
+</p>
+
 **What is NQTR?** NQTR (Navigation Quest Time Routine) is an extension for Pixi'VN that adds advanced systems for navigation, quests, time management, and game state handling. It is fully customizable and extensible, enabling developers to implement complex game mechanics with ease.
 
 ## Installation

package/dist/handlers.cjs

@@ -1 +1 @@
-'use strict';var registries=require('@drincs/nqtr/registries'),storage=require('@drincs/pixi-vn/storage');var C=Object.defineProperty;var N=(a,e,t)=>e in a?C(a,e,{enumerable:true,configurable:true,writable:true,value:t}):a[e]=t;var u=(a,e,t)=>N(a,typeof e!="symbol"?e+"":e,t);var f="___nqtr-time_manager_data___",T="___nqtr-current_room_memory___",D="___nqtr-last_event_memory___";function l(a){storage.storage.set(D,a);}var c;(i=>(i.log=(m,...s)=>console.log(`[NQTR] ${m}`,...s),i.warn=(m,...s)=>console.warn(`[NQTR] ${m}`,...s),i.error=(m,...s)=>console.error(`[NQTR] ${m}`,...s),i.info=(m,...s)=>console.info(`[NQTR] ${m}`,...s)))(c||(c={}));var p=class{get rooms(){return registries.RegisteredRooms.values()}get locations(){return registries.RegisteredLocations.values()}get maps(){return registries.RegisteredMaps.values()}get currentRoomId(){return storage.storage.get(T)}get currentRoom(){let e=this.currentRoomId;if(!e){c.error("The current room has not yet been set");return}let t=registries.RegisteredRooms.get(e);if(!t){c.error(`Current room ${e} not found`);return}return t}set currentRoom(e){if(typeof e!="string"&&(e=e.id),!registries.RegisteredRooms.get(e)){c.error(`The room ${e} is not registered, so it can't be set as current room`);return}let r=storage.storage.get(T);r!==e&&(l({type:"editroom",prev:r,value:e}),storage.storage.set(T,e));}get currentLocation(){return this.currentRoom?.location}get currentMap(){return this.currentRoom?.location.map}clearExpiredActivities(){registries.RegisteredRooms.values().forEach(e=>{e.clearExpiredActivities();});}};var g=class{get quests(){return registries.RegisteredQuests.values()}get startedQuests(){return this.quests.filter(e=>e.started)}get inProgressQuests(){return this.quests.filter(e=>e.inProgress)}get completedQuests(){return this.quests.filter(e=>e.completed)}get failedQuests(){return this.quests.filter(e=>e.failed)}get notStartedQuests(){return this.quests.filter(e=>!e.started)}find(e){return registries.RegisteredQuests.get(e)}async startsStageMustBeStarted(e){let t=this.quests.map(r=>r.currentStageMustStart?r.startCurrentStage(e):Promise.resolve());await Promise.all(t);}};var I="___nqtr-temporary_commitment___",y=class{get fixedRoutine(){return [...registries.fixedCommitments.values()]}set fixedRoutine(e){e.forEach(t=>{registries.fixedCommitments.has(t.id)&&console.warn(`[NQTR] Commitment id ${t.id} already exists, it will be overwritten`),registries.fixedCommitments.set(t.id,t);});}get temporaryRoutine(){let e=storage.storage.get(I);return e?e.map(r=>registries.RegisteredCommitments.get(r)).filter(r=>r!==void 0):[]}get allRoutine(){return [...this.fixedRoutine,...this.temporaryRoutine]}add(e){Array.isArray(e)||(e=[e]);let t=e.map(r=>{if(!registries.RegisteredCommitments.get(r.id)){console.warn(`[NQTR] Commitment ${r.id} not found, it will be ignored`);return}return r.id}).filter(r=>r!==void 0);storage.storage.set(I,t);}find(e){return registries.RegisteredCommitments.get(e)}remove(e){Array.isArray(e)||(e=[e]);let t=e.map(i=>i.id),r=storage.storage.get(I);r&&(r=r.filter(i=>!t.includes(i)),storage.storage.set(I,r));}clearExpiredRoutine(){registries.RegisteredCommitments.values().forEach(e=>{e.expired&&registries.registeredCommitments.delete(e.id);});}get currentRoutine(){let e={};return [...this.fixedRoutine,...this.temporaryRoutine].forEach(t=>{t.isActive&&(t.characters.length>0?t.characters.every(i=>!e[i.id]||t.priority>e[i.id].priority)&&t.characters.forEach(i=>{e[i.id]=t;}):c.error(`The commitment ${t.id} has no characters assigned`));}),Object.values(e)}getCommitmentByCharacter(e){this.currentRoutine.forEach(t=>{if(t.characters.map(r=>r.id).includes(e.id))return t});}};var o=class o{};u(o,"dayStartTime",0),u(o,"dayEndTime",24),u(o,"defaultTimeSpent",1),u(o,"timeSlots",[]),u(o,"weekLength",7),u(o,"weekendStartDay",o.weekLength-1),u(o,"getDayName");var n=o;var h=class{initialize(e){let{dayStartTime:t=0,dayEndTime:r=24,defaultTimeSpent:i=1,timeSlots:m=[],weekLength:s=7,weekendStartDay:w=s-1,getDayName:x}=e;n.dayStartTime=t,n.dayEndTime=r,n.defaultTimeSpent=i,n.timeSlots=m,n.weekLength=s,w>=n.weekLength?console.warn(`[NQTR] Weekend start day should be less than week length ${s}, so will be ignored`):n.weekendStartDay=w,n.getDayName=x;}get dayStartTime(){return n.dayStartTime}get dayEndTime(){return n.dayEndTime}get defaultTimeSpent(){return n.defaultTimeSpent}get timeSlots(){return n.timeSlots}get weekLength(){return n.weekLength}get weekendStartDay(){return n.weekendStartDay}get getDayName(){return n.getDayName}get currentTime(){let e=storage.storage.get(f)||{};return e.hasOwnProperty("currentTime")&&typeof e.currentTime=="number"?e.currentTime:this.dayStartTime}set currentTime(e){let t=storage.storage.get(f)||{},r={...t};typeof e=="number"?r.currentTime=e:delete r.currentTime,l({type:"edittime",prev:t,value:r}),storage.storage.set(f,r);}get currentDate(){let e=storage.storage.get(f)||{};return e.hasOwnProperty("currentDate")&&typeof e.currentDate=="number"?e.currentDate:0}set currentDate(e){let t=storage.storage.get(f)||{},r={...t};typeof e=="number"?r.currentDate=e:delete r.currentDate,l({type:"edittime",prev:t,value:r}),storage.storage.set(f,r);}get isWeekend(){return this.currentWeekDayNumber>=this.weekendStartDay}get currentWeekDayNumber(){return this.currentDate%this.weekLength+1}get currentDayName(){return this.getDayName?this.getDayName(this.currentWeekDayNumber-1):(console.warn("[NQTR] Week days names are not defined, so currentDayName will be empty"),"")}get currentTimeSlot(){if(this.timeSlots.length===0)return console.warn("[NQTR] Time slots are not defined"),0;for(let e=0;e<this.timeSlots.length;e++){let t=this.timeSlots[e];if(this.timeSlots.length>e+1&&this.nowIsBetween(t.startTime,this.timeSlots[e+1].startTime))return e}return this.timeSlots.length-1}increaseTime(e=this.defaultTimeSpent){let t=this.currentTime+e;return t>=this.dayEndTime&&(this.increaseDate(),t=this.dayStartTime+(t-this.dayEndTime)),this.currentTime=t,this.currentTime}increaseDate(e=1,t=this.dayStartTime){let r=this.currentDate+e;return this.currentDate=r,this.currentTime=t,this.currentDate}nowIsBetween(e,t){e===void 0&&(e=this.dayStartTime-1),t===void 0&&(t=this.dayEndTime+1);let r=this.currentTime;return e<t?r>=e&&r<t:r>=e||r<t}};var ce=new h,fe=new p,de=new y,le=new g;exports.navigator=fe;exports.questsNotebook=le;exports.routine=de;exports.timeTracker=ce;
+'use strict';var registries=require('@drincs/nqtr/registries'),storage=require('@drincs/pixi-vn/storage'),core=require('@drincs/pixi-vn/core');var N=Object.defineProperty;var k=(o,e,t)=>e in o?N(o,e,{enumerable:true,configurable:true,writable:true,value:t}):o[e]=t;var c=(o,e,t)=>k(o,typeof e!="symbol"?e+"":e,t);var d="___nqtr-time_manager_data___",I="___nqtr-current_room_memory___",v="___nqtr-last_event_memory___";function p(o){storage.storage.set(v,o);}var m;(i=>(i.log=(a,...s)=>console.log(`[NQTR] ${a}`,...s),i.warn=(a,...s)=>console.warn(`[NQTR] ${a}`,...s),i.error=(a,...s)=>console.error(`[NQTR] ${a}`,...s),i.info=(a,...s)=>console.info(`[NQTR] ${a}`,...s)))(m||(m={}));var g=class{get rooms(){return registries.RegisteredRooms.values()}get locations(){return registries.RegisteredLocations.values()}get maps(){return registries.RegisteredMaps.values()}get currentRoomId(){return storage.storage.get(I)}get currentRoom(){let e=this.currentRoomId;if(!e){m.error("The current room has not yet been set");return}let t=registries.RegisteredRooms.get(e);if(!t){m.error(`Current room ${e} not found`);return}return t}set currentRoom(e){if(typeof e!="string"&&(e=e.id),!registries.RegisteredRooms.get(e)){m.error(`The room ${e} is not registered, so it can't be set as current room`);return}let r=storage.storage.get(I);r!==e&&(p({type:"editroom",prev:r,value:e}),storage.storage.set(I,e));}get currentLocation(){return this.currentRoom?.location}get currentMap(){return this.currentRoom?.location.map}clearExpiredActivities(){registries.RegisteredRooms.values().forEach(e=>{e.clearExpiredActivities();});}};var y=class{get quests(){return registries.RegisteredQuests.values()}get startedQuests(){return this.quests.filter(e=>e.started)}get inProgressQuests(){return this.quests.filter(e=>e.inProgress)}get completedQuests(){return this.quests.filter(e=>e.completed)}get failedQuests(){return this.quests.filter(e=>e.failed)}get notStartedQuests(){return this.quests.filter(e=>!e.started)}find(e){return registries.RegisteredQuests.get(e)}async startsStageMustBeStarted(e){let t=this.quests.map(r=>r.currentStageMustStart?r.startCurrentStage(e):Promise.resolve());await Promise.all(t);}};var w="___nqtr-temporary_commitment___",T=class{get temporaryRoutine(){let e=storage.storage.get(w);if(e){if(Array.isArray(e))throw new core.PixiError("obsolete_save","The save you loaded is not compatible with the current version of NQTR. Please delete the save and start a new game.")}else return {};return e}get commitmentsIds(){return [...registries.fixedCommitments.keys(),...Object.keys(this.temporaryRoutine)]}add(e,t,r={}){Array.isArray(e)||(e=[e]);let i=this.temporaryRoutine;e.forEach(a=>{registries.RegisteredCommitments.get(a.id)&&m.warn(`The commitment ${a.id} is already registered, it will be overwritten`),registries.RegisteredCommitments.add(a),i[a.id]={id:a.id,roomId:t,...r};}),storage.storage.set(w,i);}find(e){return registries.RegisteredCommitments.get(e)}remove(e,t){typeof e!="string"&&(e=e.id);let r=this.temporaryRoutine;r[e]?(!t||r[e].roomId===t)&&delete r[e]:m.warn(`The commitment ${e} was not found in the temporary routine, so it will be ignored. If you want to remove a fixed commitment, you can add it to the temporary routine with a same character.`),storage.storage.set(w,r);}clearExpiredRoutine(){registries.RegisteredCommitments.values().forEach(e=>{e.expired&&this.remove(e);});}get characterCommitments(){let e=this.temporaryRoutine;return this.commitmentsIds.reduce((t,r)=>{let i=registries.RegisteredCommitments.get(r),a=e[r],s=a?.roomId||registries.fixedCommitments.get(r)?.[1];return s&&i&&i.isActive(a)&&(i.characters.length>0?i.characters.every(f=>!t[f.id]||i.priority>t[f.id][0].priority)&&i.characters.forEach(f=>{t[f.id]=[i,s];}):m.error(`The commitment ${i.id} has no characters assigned`)),t},{})}get currentRoutine(){return Object.values(this.characterCommitments).map(([e])=>e)}get roomCommitments(){return Object.values(this.characterCommitments).reduce((e,t)=>{let r=t[1];return e[r]||(e[r]=[]),e[r].push(t[0]),e},{})}getCommitmentByCharacter(e){return this.currentRoutine.find(t=>{if(t.characters.map(r=>r.id).includes(e.id))return t})}};var u=class u{};c(u,"dayStartTime",0),c(u,"dayEndTime",24),c(u,"defaultTimeSpent",1),c(u,"timeSlots",[]),c(u,"weekLength",7),c(u,"weekendStartDay",u.weekLength-1),c(u,"getDayName");var n=u;var _=class{initialize(e){let{dayStartTime:t=0,dayEndTime:r=24,defaultTimeSpent:i=1,timeSlots:a=[],weekLength:s=7,weekendStartDay:E=s-1,getDayName:f}=e;n.dayStartTime=t,n.dayEndTime=r,n.defaultTimeSpent=i,n.timeSlots=a,n.weekLength=s,E>=n.weekLength?console.warn(`[NQTR] Weekend start day should be less than week length ${s}, so will be ignored`):n.weekendStartDay=E,n.getDayName=f;}get dayStartTime(){return n.dayStartTime}get dayEndTime(){return n.dayEndTime}get defaultTimeSpent(){return n.defaultTimeSpent}get timeSlots(){return n.timeSlots}get weekLength(){return n.weekLength}get weekendStartDay(){return n.weekendStartDay}get getDayName(){return n.getDayName}get currentTime(){let e=storage.storage.get(d)||{};return e.hasOwnProperty("currentTime")&&typeof e.currentTime=="number"?e.currentTime:this.dayStartTime}set currentTime(e){let t=storage.storage.get(d)||{},r={...t};typeof e=="number"?r.currentTime=e:delete r.currentTime,p({type:"edittime",prev:t,value:r}),storage.storage.set(d,r);}get currentDate(){let e=storage.storage.get(d)||{};return e.hasOwnProperty("currentDate")&&typeof e.currentDate=="number"?e.currentDate:0}set currentDate(e){let t=storage.storage.get(d)||{},r={...t};typeof e=="number"?r.currentDate=e:delete r.currentDate,p({type:"edittime",prev:t,value:r}),storage.storage.set(d,r);}get isWeekend(){return this.currentWeekDayNumber>=this.weekendStartDay}get currentWeekDayNumber(){return this.currentDate%this.weekLength+1}get currentDayName(){return this.getDayName?this.getDayName(this.currentWeekDayNumber-1):(console.warn("[NQTR] Week days names are not defined, so currentDayName will be empty"),"")}get currentTimeSlot(){if(this.timeSlots.length===0)return console.warn("[NQTR] Time slots are not defined"),0;for(let e=0;e<this.timeSlots.length;e++){let t=this.timeSlots[e];if(this.timeSlots.length>e+1&&this.nowIsBetween(t.startTime,this.timeSlots[e+1].startTime))return e}return this.timeSlots.length-1}increaseTime(e=this.defaultTimeSpent){let t=this.currentTime+e;return t>=this.dayEndTime&&(this.increaseDate(),t=this.dayStartTime+(t-this.dayEndTime)),this.currentTime=t,this.currentTime}increaseDate(e=1,t=this.dayStartTime){let r=this.currentDate+e;return this.currentDate=r,this.currentTime=t,this.currentDate}nowIsBetween(e,t){e===void 0&&(e=this.dayStartTime-1),t===void 0&&(t=this.dayEndTime+1);let r=this.currentTime;return e<t?r>=e&&r<t:r>=e||r<t}};var de=new _,fe=new g,le=new T,pe=new y;exports.navigator=fe;exports.questsNotebook=pe;exports.routine=le;exports.timeTracker=de;

package/dist/handlers.d.mts

@@ -2,6 +2,45 @@ import { OnRunProps as OnRunProps$1, ActivityInterface as ActivityInterface$1, C
 import { StoredClassModel } from '@drincs/pixi-vn/storage';
 import { CharacterInterface } from '@drincs/pixi-vn';
 
+interface DateSchedulingInterface {
+    /**
+     * The start date. If the item hasn't started yet, it will be hidden.
+     * If you set it to 3, the item will be hidden on dates 1 and 2 and will be shown starting on date 3.
+     */
+    from: number;
+    /**
+     * The date when the item ends. If the item is ended yet, it will be deleted or hidden.
+     * If you set { from: 0, to: 3 }, the item will be shown into dates 1 and 2 and will be deleted or hidden from date 3.
+     * @default undefined
+     */
+    to?: number;
+}
+
+interface TimeSchedulingInterface {
+    /**
+     * The time when the item starts. If the item is not started yet, it will be hidden.
+     * If you set 3, the item will be hidden into times 1 and 2, and will be shown from time 3.
+     */
+    from: number;
+    /**
+     * The time when the item ends. If the item is ended yet, it will be hidden.
+     * If you set 3, the item will be shown into times 1 and 2 and will be hidden from time 3.
+     * @default timeTracker.dayEndTime + 1
+     */
+    to?: number;
+}
+
+interface ActiveScheduling {
+    /**
+     * Time slot in which activity/commitment will be active.
+     */
+    readonly timeSlot?: TimeSchedulingInterface[] | TimeSchedulingInterface;
+    /**
+     * Used to schedule what date it will be added and removed.
+     */
+    readonly dateScheduling?: DateSchedulingInterface;
+}
+
 type ExecutionType = "automatic" | "interaction";
 
 type OnRunProps = OnRunProps$1;
@@ -77,49 +116,13 @@ type TimeSettings = {
     getDayName?: (weekDayNumber: number) => string;
 };
 
-interface DateSchedulingInterface {
-    /**
-     * The start date. If the item hasn't started yet, it will be hidden.
-     * If you set it to 3, the item will be hidden on dates 1 and 2 and will be shown starting on date 3.
-     */
-    from: number;
-    /**
-     * The date when the item ends. If the item is ended yet, it will be deleted or hidden.
-     * If you set { from: 0, to: 3 }, the item will be shown into dates 1 and 2 and will be deleted or hidden from date 3.
-     * @default undefined
-     */
-    to?: number;
-}
-
-interface TimeSchedulingInterface {
-    /**
-     * The time when the item starts. If the item is not started yet, it will be hidden.
-     * If you set 3, the item will be hidden into times 1 and 2, and will be shown from time 3.
-     */
-    from: number;
-    /**
-     * The time when the item ends. If the item is ended yet, it will be hidden.
-     * If you set 3, the item will be shown into times 1 and 2 and will be hidden from time 3.
-     * @default timeTracker.dayEndTime + 1
-     */
-    to?: number;
-}
-
 interface ActivityInterface extends ActivityBaseInternalInterface, ActivityInterface$1 {
 }
-interface ActivityBaseInternalInterface {
+interface ActivityBaseInternalInterface extends ActiveScheduling {
     /**
      * The id of the activity/commitment.
      */
     readonly id: string;
-    /**
-     * Time slot in which activity/commitment will be active.
-     */
-    readonly timeSlot: TimeSchedulingInterface | undefined;
-    /**
-     * Used to schedule what date it will be added and removed.
-     */
-    readonly dateScheduling: DateSchedulingInterface | undefined;
     /**
      * The function that is called when the activity/commitment is runned.
      */
@@ -131,9 +134,10 @@ interface ActivityBaseInternalInterface {
      */
     readonly expired: boolean;
     /**
-     * Whether the activity/commitment is active.
+     * Whether the activity/commitment is active, so it will be shown in the routine and can be runned.
+     * @param options The options to check if the activity/commitment is active.
      */
-    readonly isActive: boolean;
+    isActive(options?: ActiveScheduling): boolean;
 }
 
 interface CommitmentInterface extends CommitmentBaseInternalInterface, CommitmentInterface$1 {
@@ -143,10 +147,6 @@ interface CommitmentBaseInternalInterface extends ActivityBaseInternalInterface
      * The character or characters that are in the commitment and so in the room.
      */
     readonly characters: CharacterInterface[];
-    /**
-     * The room where the commitment is.
-     */
-    readonly room: RoomInterface;
     /**
      * 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.
      * If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.
@@ -166,22 +166,13 @@ interface NavigationAbstractInterface extends StoredClassModel {
      * @param options
      * @returns
      */
-    addActivity(activity: ActivityInterface, options?: {
-        /**
-         * Time slot in which activity will be active.
-         */
-        timeSlot?: TimeSchedulingInterface;
-        /**
-         * Used to schedule what date it will be added and removed.
-         */
-        dateScheduling?: DateSchedulingInterface;
-    }): void;
+    addActivity(activity: ActivityInterface, options?: ActiveScheduling): void;
     /**
      * Disconnects the activity from the class.
      * @param activity The activity to disconnect from the class.
      * @param options
      */
-    removeActivity(activity: ActivityInterface | string, options?: Pick<DateSchedulingInterface, "to">): void;
+    removeActivity(activity: ActivityInterface | string): void;
     /**
      * Removes the useless activities.
      */
@@ -239,6 +230,19 @@ interface RoomBaseInternalInterface extends NavigationAbstractInterface {
      * The location where the room is.
      */
     readonly location: LocationInterface;
+    /**
+     * Connects the commitment to the class.
+     * @param commitment The commitment to connect to the class.
+     * @param options
+     * @returns
+     */
+    addCommitment(commitment: CommitmentInterface, options?: ActiveScheduling): void;
+    /**
+     * Disconnects the commitment from the class.
+     * @param commitment The commitment to disconnect from the class.
+     * @param options
+     */
+    removeCommitment(commitment: CommitmentInterface | string): void;
     /**
      * Get the character commitments of the room.
      */
@@ -464,22 +468,18 @@ declare class QuestHandler {
 }
 
 declare class RoutineHandler {
-    get fixedRoutine(): CommitmentInterface[];
-    /**
-     * Set a commitment as fixed, it will be always available. They cannot be deleted or edit during the game session.
-     */
-    set fixedRoutine(commitments: CommitmentInterface[]);
     /**
      * Get the temporary commitments by its id.
      * @returns The temporary commitments.
      */
-    get temporaryRoutine(): CommitmentInterface[];
-    get allRoutine(): CommitmentInterface[];
+    private get temporaryRoutine();
+    get commitmentsIds(): string[];
     /**
      * This feature adds the commitments during the game session.
      * @param commitment The commitment or commitments to add.
+     * @param roomId The id of the room where the commitment is.
      */
-    add(commitment: CommitmentInterface[] | CommitmentInterface): void;
+    add(commitment: CommitmentInterface[] | CommitmentInterface, roomId: string, options?: ActiveScheduling): void;
     /**
      * Get the commitments added during the game session.
      * @param id The id of the commitment.
@@ -488,13 +488,17 @@ declare class RoutineHandler {
     find(id: string): CommitmentInterface | undefined;
     /**
      * Remove the commitments added during the game session.
-     * @param commitment The commitment or commitments to remove.
+     * @param commitment The commitment or commitment id to remove.
+     * @param roomId The id of the room where the commitment is.
      */
-    remove(commitment: CommitmentInterface[] | CommitmentInterface): void;
+    remove(commitment: CommitmentInterface | string, roomId?: string): void;
     /**
      * Clear all the expired commitments.
      */
     clearExpiredRoutine(): void;
+    get characterCommitments(): {
+        [character: string]: [CommitmentInterface, string];
+    };
     /**
      * Get the current commitments. The hidden commitments are not included.
      * In case there is a character who has two or more commitments at the same time, will be selected the commitment with the highest priority.
@@ -505,6 +509,9 @@ declare class RoutineHandler {
      * @returns The current commitments.
      */
     get currentRoutine(): CommitmentInterface[];
+    get roomCommitments(): {
+        [roomId: string]: CommitmentInterface[];
+    };
     /**
      * Get the character commitment.
      * @param character The character.

package/dist/handlers.d.ts

@@ -2,6 +2,45 @@ import { OnRunProps as OnRunProps$1, ActivityInterface as ActivityInterface$1, C
 import { StoredClassModel } from '@drincs/pixi-vn/storage';
 import { CharacterInterface } from '@drincs/pixi-vn';
 
+interface DateSchedulingInterface {
+    /**
+     * The start date. If the item hasn't started yet, it will be hidden.
+     * If you set it to 3, the item will be hidden on dates 1 and 2 and will be shown starting on date 3.
+     */
+    from: number;
+    /**
+     * The date when the item ends. If the item is ended yet, it will be deleted or hidden.
+     * If you set { from: 0, to: 3 }, the item will be shown into dates 1 and 2 and will be deleted or hidden from date 3.
+     * @default undefined
+     */
+    to?: number;
+}
+
+interface TimeSchedulingInterface {
+    /**
+     * The time when the item starts. If the item is not started yet, it will be hidden.
+     * If you set 3, the item will be hidden into times 1 and 2, and will be shown from time 3.
+     */
+    from: number;
+    /**
+     * The time when the item ends. If the item is ended yet, it will be hidden.
+     * If you set 3, the item will be shown into times 1 and 2 and will be hidden from time 3.
+     * @default timeTracker.dayEndTime + 1
+     */
+    to?: number;
+}
+
+interface ActiveScheduling {
+    /**
+     * Time slot in which activity/commitment will be active.
+     */
+    readonly timeSlot?: TimeSchedulingInterface[] | TimeSchedulingInterface;
+    /**
+     * Used to schedule what date it will be added and removed.
+     */
+    readonly dateScheduling?: DateSchedulingInterface;
+}
+
 type ExecutionType = "automatic" | "interaction";
 
 type OnRunProps = OnRunProps$1;
@@ -77,49 +116,13 @@ type TimeSettings = {
     getDayName?: (weekDayNumber: number) => string;
 };
 
-interface DateSchedulingInterface {
-    /**
-     * The start date. If the item hasn't started yet, it will be hidden.
-     * If you set it to 3, the item will be hidden on dates 1 and 2 and will be shown starting on date 3.
-     */
-    from: number;
-    /**
-     * The date when the item ends. If the item is ended yet, it will be deleted or hidden.
-     * If you set { from: 0, to: 3 }, the item will be shown into dates 1 and 2 and will be deleted or hidden from date 3.
-     * @default undefined
-     */
-    to?: number;
-}
-
-interface TimeSchedulingInterface {
-    /**
-     * The time when the item starts. If the item is not started yet, it will be hidden.
-     * If you set 3, the item will be hidden into times 1 and 2, and will be shown from time 3.
-     */
-    from: number;
-    /**
-     * The time when the item ends. If the item is ended yet, it will be hidden.
-     * If you set 3, the item will be shown into times 1 and 2 and will be hidden from time 3.
-     * @default timeTracker.dayEndTime + 1
-     */
-    to?: number;
-}
-
 interface ActivityInterface extends ActivityBaseInternalInterface, ActivityInterface$1 {
 }
-interface ActivityBaseInternalInterface {
+interface ActivityBaseInternalInterface extends ActiveScheduling {
     /**
      * The id of the activity/commitment.
      */
     readonly id: string;
-    /**
-     * Time slot in which activity/commitment will be active.
-     */
-    readonly timeSlot: TimeSchedulingInterface | undefined;
-    /**
-     * Used to schedule what date it will be added and removed.
-     */
-    readonly dateScheduling: DateSchedulingInterface | undefined;
     /**
      * The function that is called when the activity/commitment is runned.
      */
@@ -131,9 +134,10 @@ interface ActivityBaseInternalInterface {
      */
     readonly expired: boolean;
     /**
-     * Whether the activity/commitment is active.
+     * Whether the activity/commitment is active, so it will be shown in the routine and can be runned.
+     * @param options The options to check if the activity/commitment is active.
      */
-    readonly isActive: boolean;
+    isActive(options?: ActiveScheduling): boolean;
 }
 
 interface CommitmentInterface extends CommitmentBaseInternalInterface, CommitmentInterface$1 {
@@ -143,10 +147,6 @@ interface CommitmentBaseInternalInterface extends ActivityBaseInternalInterface
      * The character or characters that are in the commitment and so in the room.
      */
     readonly characters: CharacterInterface[];
-    /**
-     * The room where the commitment is.
-     */
-    readonly room: RoomInterface;
     /**
      * 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.
      * If you set "automatic" remember to remove the commitment when it is no longer needed, because otherwise it repeats itself every time.
@@ -166,22 +166,13 @@ interface NavigationAbstractInterface extends StoredClassModel {
      * @param options
      * @returns
      */
-    addActivity(activity: ActivityInterface, options?: {
-        /**
-         * Time slot in which activity will be active.
-         */
-        timeSlot?: TimeSchedulingInterface;
-        /**
-         * Used to schedule what date it will be added and removed.
-         */
-        dateScheduling?: DateSchedulingInterface;
-    }): void;
+    addActivity(activity: ActivityInterface, options?: ActiveScheduling): void;
     /**
      * Disconnects the activity from the class.
      * @param activity The activity to disconnect from the class.
      * @param options
      */
-    removeActivity(activity: ActivityInterface | string, options?: Pick<DateSchedulingInterface, "to">): void;
+    removeActivity(activity: ActivityInterface | string): void;
     /**
      * Removes the useless activities.
      */
@@ -239,6 +230,19 @@ interface RoomBaseInternalInterface extends NavigationAbstractInterface {
      * The location where the room is.
      */
     readonly location: LocationInterface;
+    /**
+     * Connects the commitment to the class.
+     * @param commitment The commitment to connect to the class.
+     * @param options
+     * @returns
+     */
+    addCommitment(commitment: CommitmentInterface, options?: ActiveScheduling): void;
+    /**
+     * Disconnects the commitment from the class.
+     * @param commitment The commitment to disconnect from the class.
+     * @param options
+     */
+    removeCommitment(commitment: CommitmentInterface | string): void;
     /**
      * Get the character commitments of the room.
      */
@@ -464,22 +468,18 @@ declare class QuestHandler {
 }
 
 declare class RoutineHandler {
-    get fixedRoutine(): CommitmentInterface[];
-    /**
-     * Set a commitment as fixed, it will be always available. They cannot be deleted or edit during the game session.
-     */
-    set fixedRoutine(commitments: CommitmentInterface[]);
     /**
      * Get the temporary commitments by its id.
      * @returns The temporary commitments.
      */
-    get temporaryRoutine(): CommitmentInterface[];
-    get allRoutine(): CommitmentInterface[];
+    private get temporaryRoutine();
+    get commitmentsIds(): string[];
     /**
      * This feature adds the commitments during the game session.
      * @param commitment The commitment or commitments to add.
+     * @param roomId The id of the room where the commitment is.
      */
-    add(commitment: CommitmentInterface[] | CommitmentInterface): void;
+    add(commitment: CommitmentInterface[] | CommitmentInterface, roomId: string, options?: ActiveScheduling): void;
     /**
      * Get the commitments added during the game session.
      * @param id The id of the commitment.
@@ -488,13 +488,17 @@ declare class RoutineHandler {
     find(id: string): CommitmentInterface | undefined;
     /**
      * Remove the commitments added during the game session.
-     * @param commitment The commitment or commitments to remove.
+     * @param commitment The commitment or commitment id to remove.
+     * @param roomId The id of the room where the commitment is.
      */
-    remove(commitment: CommitmentInterface[] | CommitmentInterface): void;
+    remove(commitment: CommitmentInterface | string, roomId?: string): void;
     /**
      * Clear all the expired commitments.
      */
     clearExpiredRoutine(): void;
+    get characterCommitments(): {
+        [character: string]: [CommitmentInterface, string];
+    };
     /**
      * Get the current commitments. The hidden commitments are not included.
      * In case there is a character who has two or more commitments at the same time, will be selected the commitment with the highest priority.
@@ -505,6 +509,9 @@ declare class RoutineHandler {
      * @returns The current commitments.
      */
     get currentRoutine(): CommitmentInterface[];
+    get roomCommitments(): {
+        [roomId: string]: CommitmentInterface[];
+    };
     /**
      * Get the character commitment.
      * @param character The character.

package/dist/handlers.mjs

@@ -1 +1 @@
-import {RegisteredRooms,RegisteredLocations,RegisteredMaps,RegisteredQuests,fixedCommitments,RegisteredCommitments,registeredCommitments}from'@drincs/nqtr/registries';import {storage}from'@drincs/pixi-vn/storage';var C=Object.defineProperty;var N=(a,e,t)=>e in a?C(a,e,{enumerable:true,configurable:true,writable:true,value:t}):a[e]=t;var u=(a,e,t)=>N(a,typeof e!="symbol"?e+"":e,t);var f="___nqtr-time_manager_data___",T="___nqtr-current_room_memory___",D="___nqtr-last_event_memory___";function l(a){storage.set(D,a);}var c;(i=>(i.log=(m,...s)=>console.log(`[NQTR] ${m}`,...s),i.warn=(m,...s)=>console.warn(`[NQTR] ${m}`,...s),i.error=(m,...s)=>console.error(`[NQTR] ${m}`,...s),i.info=(m,...s)=>console.info(`[NQTR] ${m}`,...s)))(c||(c={}));var p=class{get rooms(){return RegisteredRooms.values()}get locations(){return RegisteredLocations.values()}get maps(){return RegisteredMaps.values()}get currentRoomId(){return storage.get(T)}get currentRoom(){let e=this.currentRoomId;if(!e){c.error("The current room has not yet been set");return}let t=RegisteredRooms.get(e);if(!t){c.error(`Current room ${e} not found`);return}return t}set currentRoom(e){if(typeof e!="string"&&(e=e.id),!RegisteredRooms.get(e)){c.error(`The room ${e} is not registered, so it can't be set as current room`);return}let r=storage.get(T);r!==e&&(l({type:"editroom",prev:r,value:e}),storage.set(T,e));}get currentLocation(){return this.currentRoom?.location}get currentMap(){return this.currentRoom?.location.map}clearExpiredActivities(){RegisteredRooms.values().forEach(e=>{e.clearExpiredActivities();});}};var g=class{get quests(){return RegisteredQuests.values()}get startedQuests(){return this.quests.filter(e=>e.started)}get inProgressQuests(){return this.quests.filter(e=>e.inProgress)}get completedQuests(){return this.quests.filter(e=>e.completed)}get failedQuests(){return this.quests.filter(e=>e.failed)}get notStartedQuests(){return this.quests.filter(e=>!e.started)}find(e){return RegisteredQuests.get(e)}async startsStageMustBeStarted(e){let t=this.quests.map(r=>r.currentStageMustStart?r.startCurrentStage(e):Promise.resolve());await Promise.all(t);}};var I="___nqtr-temporary_commitment___",y=class{get fixedRoutine(){return [...fixedCommitments.values()]}set fixedRoutine(e){e.forEach(t=>{fixedCommitments.has(t.id)&&console.warn(`[NQTR] Commitment id ${t.id} already exists, it will be overwritten`),fixedCommitments.set(t.id,t);});}get temporaryRoutine(){let e=storage.get(I);return e?e.map(r=>RegisteredCommitments.get(r)).filter(r=>r!==void 0):[]}get allRoutine(){return [...this.fixedRoutine,...this.temporaryRoutine]}add(e){Array.isArray(e)||(e=[e]);let t=e.map(r=>{if(!RegisteredCommitments.get(r.id)){console.warn(`[NQTR] Commitment ${r.id} not found, it will be ignored`);return}return r.id}).filter(r=>r!==void 0);storage.set(I,t);}find(e){return RegisteredCommitments.get(e)}remove(e){Array.isArray(e)||(e=[e]);let t=e.map(i=>i.id),r=storage.get(I);r&&(r=r.filter(i=>!t.includes(i)),storage.set(I,r));}clearExpiredRoutine(){RegisteredCommitments.values().forEach(e=>{e.expired&&registeredCommitments.delete(e.id);});}get currentRoutine(){let e={};return [...this.fixedRoutine,...this.temporaryRoutine].forEach(t=>{t.isActive&&(t.characters.length>0?t.characters.every(i=>!e[i.id]||t.priority>e[i.id].priority)&&t.characters.forEach(i=>{e[i.id]=t;}):c.error(`The commitment ${t.id} has no characters assigned`));}),Object.values(e)}getCommitmentByCharacter(e){this.currentRoutine.forEach(t=>{if(t.characters.map(r=>r.id).includes(e.id))return t});}};var o=class o{};u(o,"dayStartTime",0),u(o,"dayEndTime",24),u(o,"defaultTimeSpent",1),u(o,"timeSlots",[]),u(o,"weekLength",7),u(o,"weekendStartDay",o.weekLength-1),u(o,"getDayName");var n=o;var h=class{initialize(e){let{dayStartTime:t=0,dayEndTime:r=24,defaultTimeSpent:i=1,timeSlots:m=[],weekLength:s=7,weekendStartDay:w=s-1,getDayName:x}=e;n.dayStartTime=t,n.dayEndTime=r,n.defaultTimeSpent=i,n.timeSlots=m,n.weekLength=s,w>=n.weekLength?console.warn(`[NQTR] Weekend start day should be less than week length ${s}, so will be ignored`):n.weekendStartDay=w,n.getDayName=x;}get dayStartTime(){return n.dayStartTime}get dayEndTime(){return n.dayEndTime}get defaultTimeSpent(){return n.defaultTimeSpent}get timeSlots(){return n.timeSlots}get weekLength(){return n.weekLength}get weekendStartDay(){return n.weekendStartDay}get getDayName(){return n.getDayName}get currentTime(){let e=storage.get(f)||{};return e.hasOwnProperty("currentTime")&&typeof e.currentTime=="number"?e.currentTime:this.dayStartTime}set currentTime(e){let t=storage.get(f)||{},r={...t};typeof e=="number"?r.currentTime=e:delete r.currentTime,l({type:"edittime",prev:t,value:r}),storage.set(f,r);}get currentDate(){let e=storage.get(f)||{};return e.hasOwnProperty("currentDate")&&typeof e.currentDate=="number"?e.currentDate:0}set currentDate(e){let t=storage.get(f)||{},r={...t};typeof e=="number"?r.currentDate=e:delete r.currentDate,l({type:"edittime",prev:t,value:r}),storage.set(f,r);}get isWeekend(){return this.currentWeekDayNumber>=this.weekendStartDay}get currentWeekDayNumber(){return this.currentDate%this.weekLength+1}get currentDayName(){return this.getDayName?this.getDayName(this.currentWeekDayNumber-1):(console.warn("[NQTR] Week days names are not defined, so currentDayName will be empty"),"")}get currentTimeSlot(){if(this.timeSlots.length===0)return console.warn("[NQTR] Time slots are not defined"),0;for(let e=0;e<this.timeSlots.length;e++){let t=this.timeSlots[e];if(this.timeSlots.length>e+1&&this.nowIsBetween(t.startTime,this.timeSlots[e+1].startTime))return e}return this.timeSlots.length-1}increaseTime(e=this.defaultTimeSpent){let t=this.currentTime+e;return t>=this.dayEndTime&&(this.increaseDate(),t=this.dayStartTime+(t-this.dayEndTime)),this.currentTime=t,this.currentTime}increaseDate(e=1,t=this.dayStartTime){let r=this.currentDate+e;return this.currentDate=r,this.currentTime=t,this.currentDate}nowIsBetween(e,t){e===void 0&&(e=this.dayStartTime-1),t===void 0&&(t=this.dayEndTime+1);let r=this.currentTime;return e<t?r>=e&&r<t:r>=e||r<t}};var ce=new h,fe=new p,de=new y,le=new g;export{fe as navigator,le as questsNotebook,de as routine,ce as timeTracker};
+import {RegisteredRooms,RegisteredLocations,RegisteredMaps,RegisteredQuests,fixedCommitments,RegisteredCommitments}from'@drincs/nqtr/registries';import {storage}from'@drincs/pixi-vn/storage';import {PixiError}from'@drincs/pixi-vn/core';var N=Object.defineProperty;var k=(o,e,t)=>e in o?N(o,e,{enumerable:true,configurable:true,writable:true,value:t}):o[e]=t;var c=(o,e,t)=>k(o,typeof e!="symbol"?e+"":e,t);var d="___nqtr-time_manager_data___",I="___nqtr-current_room_memory___",v="___nqtr-last_event_memory___";function p(o){storage.set(v,o);}var m;(i=>(i.log=(a,...s)=>console.log(`[NQTR] ${a}`,...s),i.warn=(a,...s)=>console.warn(`[NQTR] ${a}`,...s),i.error=(a,...s)=>console.error(`[NQTR] ${a}`,...s),i.info=(a,...s)=>console.info(`[NQTR] ${a}`,...s)))(m||(m={}));var g=class{get rooms(){return RegisteredRooms.values()}get locations(){return RegisteredLocations.values()}get maps(){return RegisteredMaps.values()}get currentRoomId(){return storage.get(I)}get currentRoom(){let e=this.currentRoomId;if(!e){m.error("The current room has not yet been set");return}let t=RegisteredRooms.get(e);if(!t){m.error(`Current room ${e} not found`);return}return t}set currentRoom(e){if(typeof e!="string"&&(e=e.id),!RegisteredRooms.get(e)){m.error(`The room ${e} is not registered, so it can't be set as current room`);return}let r=storage.get(I);r!==e&&(p({type:"editroom",prev:r,value:e}),storage.set(I,e));}get currentLocation(){return this.currentRoom?.location}get currentMap(){return this.currentRoom?.location.map}clearExpiredActivities(){RegisteredRooms.values().forEach(e=>{e.clearExpiredActivities();});}};var y=class{get quests(){return RegisteredQuests.values()}get startedQuests(){return this.quests.filter(e=>e.started)}get inProgressQuests(){return this.quests.filter(e=>e.inProgress)}get completedQuests(){return this.quests.filter(e=>e.completed)}get failedQuests(){return this.quests.filter(e=>e.failed)}get notStartedQuests(){return this.quests.filter(e=>!e.started)}find(e){return RegisteredQuests.get(e)}async startsStageMustBeStarted(e){let t=this.quests.map(r=>r.currentStageMustStart?r.startCurrentStage(e):Promise.resolve());await Promise.all(t);}};var w="___nqtr-temporary_commitment___",T=class{get temporaryRoutine(){let e=storage.get(w);if(e){if(Array.isArray(e))throw new PixiError("obsolete_save","The save you loaded is not compatible with the current version of NQTR. Please delete the save and start a new game.")}else return {};return e}get commitmentsIds(){return [...fixedCommitments.keys(),...Object.keys(this.temporaryRoutine)]}add(e,t,r={}){Array.isArray(e)||(e=[e]);let i=this.temporaryRoutine;e.forEach(a=>{RegisteredCommitments.get(a.id)&&m.warn(`The commitment ${a.id} is already registered, it will be overwritten`),RegisteredCommitments.add(a),i[a.id]={id:a.id,roomId:t,...r};}),storage.set(w,i);}find(e){return RegisteredCommitments.get(e)}remove(e,t){typeof e!="string"&&(e=e.id);let r=this.temporaryRoutine;r[e]?(!t||r[e].roomId===t)&&delete r[e]:m.warn(`The commitment ${e} was not found in the temporary routine, so it will be ignored. If you want to remove a fixed commitment, you can add it to the temporary routine with a same character.`),storage.set(w,r);}clearExpiredRoutine(){RegisteredCommitments.values().forEach(e=>{e.expired&&this.remove(e);});}get characterCommitments(){let e=this.temporaryRoutine;return this.commitmentsIds.reduce((t,r)=>{let i=RegisteredCommitments.get(r),a=e[r],s=a?.roomId||fixedCommitments.get(r)?.[1];return s&&i&&i.isActive(a)&&(i.characters.length>0?i.characters.every(f=>!t[f.id]||i.priority>t[f.id][0].priority)&&i.characters.forEach(f=>{t[f.id]=[i,s];}):m.error(`The commitment ${i.id} has no characters assigned`)),t},{})}get currentRoutine(){return Object.values(this.characterCommitments).map(([e])=>e)}get roomCommitments(){return Object.values(this.characterCommitments).reduce((e,t)=>{let r=t[1];return e[r]||(e[r]=[]),e[r].push(t[0]),e},{})}getCommitmentByCharacter(e){return this.currentRoutine.find(t=>{if(t.characters.map(r=>r.id).includes(e.id))return t})}};var u=class u{};c(u,"dayStartTime",0),c(u,"dayEndTime",24),c(u,"defaultTimeSpent",1),c(u,"timeSlots",[]),c(u,"weekLength",7),c(u,"weekendStartDay",u.weekLength-1),c(u,"getDayName");var n=u;var _=class{initialize(e){let{dayStartTime:t=0,dayEndTime:r=24,defaultTimeSpent:i=1,timeSlots:a=[],weekLength:s=7,weekendStartDay:E=s-1,getDayName:f}=e;n.dayStartTime=t,n.dayEndTime=r,n.defaultTimeSpent=i,n.timeSlots=a,n.weekLength=s,E>=n.weekLength?console.warn(`[NQTR] Weekend start day should be less than week length ${s}, so will be ignored`):n.weekendStartDay=E,n.getDayName=f;}get dayStartTime(){return n.dayStartTime}get dayEndTime(){return n.dayEndTime}get defaultTimeSpent(){return n.defaultTimeSpent}get timeSlots(){return n.timeSlots}get weekLength(){return n.weekLength}get weekendStartDay(){return n.weekendStartDay}get getDayName(){return n.getDayName}get currentTime(){let e=storage.get(d)||{};return e.hasOwnProperty("currentTime")&&typeof e.currentTime=="number"?e.currentTime:this.dayStartTime}set currentTime(e){let t=storage.get(d)||{},r={...t};typeof e=="number"?r.currentTime=e:delete r.currentTime,p({type:"edittime",prev:t,value:r}),storage.set(d,r);}get currentDate(){let e=storage.get(d)||{};return e.hasOwnProperty("currentDate")&&typeof e.currentDate=="number"?e.currentDate:0}set currentDate(e){let t=storage.get(d)||{},r={...t};typeof e=="number"?r.currentDate=e:delete r.currentDate,p({type:"edittime",prev:t,value:r}),storage.set(d,r);}get isWeekend(){return this.currentWeekDayNumber>=this.weekendStartDay}get currentWeekDayNumber(){return this.currentDate%this.weekLength+1}get currentDayName(){return this.getDayName?this.getDayName(this.currentWeekDayNumber-1):(console.warn("[NQTR] Week days names are not defined, so currentDayName will be empty"),"")}get currentTimeSlot(){if(this.timeSlots.length===0)return console.warn("[NQTR] Time slots are not defined"),0;for(let e=0;e<this.timeSlots.length;e++){let t=this.timeSlots[e];if(this.timeSlots.length>e+1&&this.nowIsBetween(t.startTime,this.timeSlots[e+1].startTime))return e}return this.timeSlots.length-1}increaseTime(e=this.defaultTimeSpent){let t=this.currentTime+e;return t>=this.dayEndTime&&(this.increaseDate(),t=this.dayStartTime+(t-this.dayEndTime)),this.currentTime=t,this.currentTime}increaseDate(e=1,t=this.dayStartTime){let r=this.currentDate+e;return this.currentDate=r,this.currentTime=t,this.currentDate}nowIsBetween(e,t){e===void 0&&(e=this.dayStartTime-1),t===void 0&&(t=this.dayEndTime+1);let r=this.currentTime;return e<t?r>=e&&r<t:r>=e||r<t}};var de=new _,fe=new g,le=new T,pe=new y;export{fe as navigator,pe as questsNotebook,le as routine,de as timeTracker};