@drincs/nqtr 0.2.1 → 0.2.3

package/dist/{Commitment-CtNWnNQX.d.mts → Commitment-BHB-jYOi.d.mts}

@@ -1,9 +1,9 @@
 import { GraphicItemType, OnRenderGraphicItemProps, OnRunProps } from '@drincs/nqtr/dist/override';
 import { CharacterBaseModel, StoredClassModel } from '@drincs/pixi-vn';
-import ExecutionType from './types/ExecutionType.mjs';
-import ActivityModel from './classes/Activity.mjs';
 import { a as ActivityStoredAbstract, A as ActivityProps } from './ActivityProps-D45DQdcT.mjs';
 import { OnRunActivityEvent } from './types/OnRunActivityEvent.mjs';
+import ActivityModel from './classes/Activity.mjs';
+import ExecutionType from './types/ExecutionType.mjs';
 import { OnRunCommitmentEvent } from './types/OnRunCommitmentEvent.mjs';
 
 interface CommitmentProps<TCharacter extends CharacterBaseModel = CharacterBaseModel, TRoom extends RoomBaseModel = RoomBaseModel> {
@@ -217,10 +217,10 @@ declare class ActivityRoom<TRoom extends RoomBaseModel = RoomBaseModel> extends
     getStorageProperty<T>(propertyName: string): T | undefined;
     private _id;
     get id(): string;
+    private _room;
     /**
      * The room where the activity is.
      */
-    private _room;
     get room(): TRoom;
     export(): object;
 }
@@ -368,7 +368,7 @@ declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extend
 declare const ROOM_CATEGORY = "__nqtr-room__";
 /**
  * The base model of a room. I suggest you extend this class to create your own room model.
- * You must use the saveRoom function to save the room in the registered rooms.
+ * **You must use the {@link saveRoom} function to save the room in the registered rooms.**
  * @example
  * ```ts
  * export const mcRoom = new RoomBaseModel('mc_room', mcHome, {

package/dist/{Commitment-BJTIpBQ5.d.ts → Commitment-D-1lsnnU.d.ts}

@@ -1,9 +1,9 @@
 import { GraphicItemType, OnRenderGraphicItemProps, OnRunProps } from '@drincs/nqtr/dist/override';
 import { CharacterBaseModel, StoredClassModel } from '@drincs/pixi-vn';
-import ExecutionType from './types/ExecutionType.js';
-import ActivityModel from './classes/Activity.js';
 import { a as ActivityStoredAbstract, A as ActivityProps } from './ActivityProps-BkHX8xkA.js';
 import { OnRunActivityEvent } from './types/OnRunActivityEvent.js';
+import ActivityModel from './classes/Activity.js';
+import ExecutionType from './types/ExecutionType.js';
 import { OnRunCommitmentEvent } from './types/OnRunCommitmentEvent.js';
 
 interface CommitmentProps<TCharacter extends CharacterBaseModel = CharacterBaseModel, TRoom extends RoomBaseModel = RoomBaseModel> {
@@ -217,10 +217,10 @@ declare class ActivityRoom<TRoom extends RoomBaseModel = RoomBaseModel> extends
     getStorageProperty<T>(propertyName: string): T | undefined;
     private _id;
     get id(): string;
+    private _room;
     /**
      * The room where the activity is.
      */
-    private _room;
     get room(): TRoom;
     export(): object;
 }
@@ -368,7 +368,7 @@ declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extend
 declare const ROOM_CATEGORY = "__nqtr-room__";
 /**
  * The base model of a room. I suggest you extend this class to create your own room model.
- * You must use the saveRoom function to save the room in the registered rooms.
+ * **You must use the {@link saveRoom} function to save the room in the registered rooms.**
  * @example
  * ```ts
  * export const mcRoom = new RoomBaseModel('mc_room', mcHome, {

package/dist/{StageProps-CkXejAbn.d.mts → StageProps-CJSp_a54.d.mts}

@@ -75,6 +75,11 @@ declare class StageQuest extends Stage {
      */
     get completed(): boolean;
     set completed(value: boolean);
+    /**
+     * If the stage is started.
+     */
+    get started(): boolean;
+    set started(value: boolean);
     /**
      * The list of goals that the player needs to complete to finish the stage.
      */
@@ -89,10 +94,14 @@ declare class StageQuest extends Stage {
      * Check if the stage can start.
      */
     get canStart(): boolean;
+    /**
+     * Inizialize the stage. **This function should be called only by the Quest class.**
+     */
+    inizialize(): void;
     /**
      * The function that will be called when the stage starts.
      */
-    get onStart(): undefined | ((props: OnStartStage) => void);
+    start(props: OnStartStage): void;
 }
 
 declare class Quest extends StoredClassModel {
@@ -151,12 +160,38 @@ declare class Quest extends StoredClassModel {
      */
     start(props: OnStartStage): void;
     /**
-     * Try to go to the next stage.
+     * Go to the next stage if the current stage is completed.
+     * If you want to force the change of stage, use goNextStage.
      * @param startProps The properties for the start stage. If you not want to pass any property, you can pass an {}.
      * @param endProps The properties for the end stage. If you not want to pass any property, you can pass an {}.
      * @returns true if the stage was changed, false otherwise.
      */
     tryToGoNextStage(startProps: OnStartStage, endProps: OnEndStage): boolean;
+    /**
+     * Complete the current stage and go to the next stage.
+     * If you want to go to the next stage only if the current stage is completed, use tryToGoNextStage.
+     * @param startProps The properties for the start stage. If you not want to pass any property, you can pass an {}.
+     * @param endProps The properties for the end stage. If you not want to pass any property, you can pass an {}.
+     * @returns true if the stage was changed, false otherwise.
+     */
+    completeCurrentStageAndGoNext(startProps: OnStartStage, endProps: OnEndStage): boolean;
+    /**
+     * Go to the next stage without checking if the current stage is completed.
+     * If you want to go to the next stage only if the current stage is completed, use tryToGoNextStage.
+     * @param startProps
+     * @param endProps
+     * @returns returns true if the stage was changed, false otherwise.
+     */
+    goNextStage(startProps: OnStartStage, endProps: OnEndStage): boolean;
+    /**
+     * If the current stage must start. It is true if the current stage is not started, can start and not completed.
+     */
+    get currentStageMustStart(): boolean;
+    /**
+     * Start the current stage.
+     * @param props The properties for the start stage. If you not want to pass any property, you can pass an {}.
+     */
+    startCurrentStage(props: OnStartStage): void;
 }
 
 type QuestsRequiredType = {
@@ -273,4 +308,4 @@ interface StageProps {
     onEnd?: (props: OnEndStage) => void;
 }
 
-export { type QuestProps as Q, Stage as S, type StageProps as a, type QuestsRequiredType as b, Quest as c, StageQuest as d };
+export { Quest as Q, Stage as S, type QuestProps as a, type StageProps as b, type QuestsRequiredType as c, StageQuest as d };

package/dist/{StageProps-BFsiCaZT.d.ts → StageProps-CV4rWD7t.d.ts}

@@ -75,6 +75,11 @@ declare class StageQuest extends Stage {
      */
     get completed(): boolean;
     set completed(value: boolean);
+    /**
+     * If the stage is started.
+     */
+    get started(): boolean;
+    set started(value: boolean);
     /**
      * The list of goals that the player needs to complete to finish the stage.
      */
@@ -89,10 +94,14 @@ declare class StageQuest extends Stage {
      * Check if the stage can start.
      */
     get canStart(): boolean;
+    /**
+     * Inizialize the stage. **This function should be called only by the Quest class.**
+     */
+    inizialize(): void;
     /**
      * The function that will be called when the stage starts.
      */
-    get onStart(): undefined | ((props: OnStartStage) => void);
+    start(props: OnStartStage): void;
 }
 
 declare class Quest extends StoredClassModel {
@@ -151,12 +160,38 @@ declare class Quest extends StoredClassModel {
      */
     start(props: OnStartStage): void;
     /**
-     * Try to go to the next stage.
+     * Go to the next stage if the current stage is completed.
+     * If you want to force the change of stage, use goNextStage.
      * @param startProps The properties for the start stage. If you not want to pass any property, you can pass an {}.
      * @param endProps The properties for the end stage. If you not want to pass any property, you can pass an {}.
      * @returns true if the stage was changed, false otherwise.
      */
     tryToGoNextStage(startProps: OnStartStage, endProps: OnEndStage): boolean;
+    /**
+     * Complete the current stage and go to the next stage.
+     * If you want to go to the next stage only if the current stage is completed, use tryToGoNextStage.
+     * @param startProps The properties for the start stage. If you not want to pass any property, you can pass an {}.
+     * @param endProps The properties for the end stage. If you not want to pass any property, you can pass an {}.
+     * @returns true if the stage was changed, false otherwise.
+     */
+    completeCurrentStageAndGoNext(startProps: OnStartStage, endProps: OnEndStage): boolean;
+    /**
+     * Go to the next stage without checking if the current stage is completed.
+     * If you want to go to the next stage only if the current stage is completed, use tryToGoNextStage.
+     * @param startProps
+     * @param endProps
+     * @returns returns true if the stage was changed, false otherwise.
+     */
+    goNextStage(startProps: OnStartStage, endProps: OnEndStage): boolean;
+    /**
+     * If the current stage must start. It is true if the current stage is not started, can start and not completed.
+     */
+    get currentStageMustStart(): boolean;
+    /**
+     * Start the current stage.
+     * @param props The properties for the start stage. If you not want to pass any property, you can pass an {}.
+     */
+    startCurrentStage(props: OnStartStage): void;
 }
 
 type QuestsRequiredType = {
@@ -273,4 +308,4 @@ interface StageProps {
     onEnd?: (props: OnEndStage) => void;
 }
 
-export { type QuestProps as Q, Stage as S, type StageProps as a, type QuestsRequiredType as b, Quest as c, StageQuest as d };
+export { Quest as Q, Stage as S, type QuestProps as a, type StageProps as b, type QuestsRequiredType as c, StageQuest as d };

package/dist/classes/Commitment.d.mts

@@ -1,8 +1,8 @@
 import '@drincs/nqtr/dist/override';
 import '@drincs/pixi-vn';
-export { C as default } from '../Commitment-CtNWnNQX.mjs';
+export { C as default } from '../Commitment-BHB-jYOi.mjs';
 import '../types/ExecutionType.mjs';
-import './Activity.mjs';
 import '../ActivityProps-D45DQdcT.mjs';
 import '../types/OnRunActivityEvent.mjs';
+import './Activity.mjs';
 import '../types/OnRunCommitmentEvent.mjs';

package/dist/classes/Commitment.d.ts

@@ -1,8 +1,8 @@
 import '@drincs/nqtr/dist/override';
 import '@drincs/pixi-vn';
-export { C as default } from '../Commitment-BJTIpBQ5.js';
+export { C as default } from '../Commitment-D-1lsnnU.js';
 import '../types/ExecutionType.js';
-import './Activity.js';
 import '../ActivityProps-BkHX8xkA.js';
 import '../types/OnRunActivityEvent.js';
+import './Activity.js';
 import '../types/OnRunCommitmentEvent.js';

package/dist/classes/index.d.mts

@@ -1,11 +1,11 @@
-export { default as ActivityModel } from './Activity.mjs';
-export { A as ActivityRoom, C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-CtNWnNQX.mjs';
+export { A as ActivityRoom, C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-BHB-jYOi.mjs';
 export { default as Goal } from './quest/Goal.mjs';
-export { S as Stage } from '../StageProps-CkXejAbn.mjs';
+export { Q as Quest, S as Stage } from '../StageProps-CJSp_a54.mjs';
 import '@drincs/nqtr/dist/override';
+import '@drincs/pixi-vn';
 import '../ActivityProps-D45DQdcT.mjs';
 import '../types/OnRunActivityEvent.mjs';
-import '@drincs/pixi-vn';
+import './Activity.mjs';
 import '../types/ExecutionType.mjs';
 import '../types/OnRunCommitmentEvent.mjs';
 import '../interface/quest/GoalProps.mjs';

package/dist/classes/index.d.ts

@@ -1,11 +1,11 @@
-export { default as ActivityModel } from './Activity.js';
-export { A as ActivityRoom, C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-BJTIpBQ5.js';
+export { A as ActivityRoom, C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-D-1lsnnU.js';
 export { default as Goal } from './quest/Goal.js';
-export { S as Stage } from '../StageProps-BFsiCaZT.js';
+export { Q as Quest, S as Stage } from '../StageProps-CV4rWD7t.js';
 import '@drincs/nqtr/dist/override';
+import '@drincs/pixi-vn';
 import '../ActivityProps-BkHX8xkA.js';
 import '../types/OnRunActivityEvent.js';
-import '@drincs/pixi-vn';
+import './Activity.js';
 import '../types/ExecutionType.js';
 import '../types/OnRunCommitmentEvent.js';
 import '../interface/quest/GoalProps.js';