@drincs/nqtr 0.2.0 → 0.2.2

package/dist/{StageProps-xLLR0rjD.d.mts → StageProps-D002cyay.d.mts}

@@ -6,10 +6,19 @@ import StageFlags from './interface/quest/StageFlags.mjs';
 declare class Stage extends StoredClassModel implements StageProps {
     constructor(id: string, props: StageProps);
     private _name;
+    /**
+     * The name of the stage.
+     */
     get name(): string;
     private _description;
+    /**
+     * The description of the stage.
+     */
     get description(): string;
     private _adviceDescription;
+    /**
+     * The advice description of the stage.
+     */
     get adviceDescription(): string;
     private _renderImage?;
     /**
@@ -17,6 +26,10 @@ declare class Stage extends StoredClassModel implements StageProps {
      */
     get renderImage(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
     private _defaultGoals;
+    /**
+     * The list of goals that the player needs to complete to finish the stage.
+     * This is the list set by the developer. if you want to get the current goals, use the goals property.
+     */
     get defaultGoals(): Goal[];
     private _flags;
     /**
@@ -24,40 +37,89 @@ declare class Stage extends StoredClassModel implements StageProps {
      */
     get flags(): StageFlags[];
     private _daysRequiredToStart?;
+    /**
+     * The number of days required to start the stage.
+     */
     get daysRequiredToStart(): number;
     private _flagsRequiredToStart;
+    /**
+     * The list of flags required to start the stage.
+     */
     get flagsRequiredToStart(): StageFlags[];
     private _questsRequiredToStart;
+    /**
+     * The list of quests required to start the stage.
+     */
     get questsRequiredToStart(): QuestsRequiredType[];
     private _requestDescriptionToStart;
+    /**
+     * The description of the request to start the stage.
+     */
     get requestDescriptionToStart(): string;
     private _onStart?;
+    /**
+     * The function that will be called when the stage starts.
+     */
     get onStart(): undefined | ((props: OnStartStage) => void);
     private _onEnd?;
+    /**
+     * The function that will be called when the stage ends.
+     */
     get onEnd(): undefined | ((props: OnEndStage) => void);
 }
 declare class StageQuest extends Stage {
     constructor(id: string, props: StageProps);
+    /**
+     * Check if the flag and goals are completed.
+     * You can force the completion of the stage by setting the completed property to true.
+     */
     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.
      */
     get goals(): GoalStage[];
     private get prevStageEndDay();
     private set prevStageEndDay(value);
+    /**
+     * The day when the stage starts.
+     */
     get startDay(): number | undefined;
+    /**
+     * Check if the stage can start.
+     */
     get canStart(): boolean;
-    get onStart(): undefined | ((props: OnStartStage) => void);
+    /**
+     * 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.
+     */
+    start(props: OnStartStage): void;
 }
 
 declare class Quest extends StoredClassModel {
     constructor(id: string, stages: Stage[], props: QuestProps);
     private _stages;
+    /**
+     * The stages of the quest.
+     */
     get stages(): StageQuest[];
     private _name;
+    /**
+     * The name of the quest.
+     */
     get name(): string;
     private _description;
+    /**
+     * The description of the quest.
+     */
     get description(): string;
     private _renderIcon?;
     /**
@@ -70,14 +132,59 @@ declare class Quest extends StoredClassModel {
      */
     get renderImage(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
     private _isInDevelopment;
+    /**
+     * If the quest is in development.
+     */
     get isInDevelopment(): boolean;
+    /**
+     * The index of the current stage.
+     */
     get currentStageIndex(): number | undefined;
     private set currentStageIndex(value);
+    /**
+     * The current stage.
+     */
     get currentStage(): StageQuest | undefined;
+    /**
+     * If the quest is started.
+     */
     get started(): boolean;
+    /**
+     * If the quest is completed.
+     */
     get completed(): boolean;
+    /**
+     * Start the quest.
+     * @param props The properties for the start stage. If you not want to pass any property, you can pass an {}.
+     * @returns
+     */
     start(props: OnStartStage): void;
-    tryToGoNextStage(startProps: OnStartStage, endProps: OnEndStage): void;
+    /**
+     * 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;
+    get currentStageMustStart(): boolean;
+    startCurrentStage(props: OnStartStage): void;
 }
 
 type QuestsRequiredType = {

package/dist/{StageProps-DCZkZHwZ.d.ts → StageProps-DleWO-vf.d.ts}

@@ -6,10 +6,19 @@ import StageFlags from './interface/quest/StageFlags.js';
 declare class Stage extends StoredClassModel implements StageProps {
     constructor(id: string, props: StageProps);
     private _name;
+    /**
+     * The name of the stage.
+     */
     get name(): string;
     private _description;
+    /**
+     * The description of the stage.
+     */
     get description(): string;
     private _adviceDescription;
+    /**
+     * The advice description of the stage.
+     */
     get adviceDescription(): string;
     private _renderImage?;
     /**
@@ -17,6 +26,10 @@ declare class Stage extends StoredClassModel implements StageProps {
      */
     get renderImage(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
     private _defaultGoals;
+    /**
+     * The list of goals that the player needs to complete to finish the stage.
+     * This is the list set by the developer. if you want to get the current goals, use the goals property.
+     */
     get defaultGoals(): Goal[];
     private _flags;
     /**
@@ -24,40 +37,89 @@ declare class Stage extends StoredClassModel implements StageProps {
      */
     get flags(): StageFlags[];
     private _daysRequiredToStart?;
+    /**
+     * The number of days required to start the stage.
+     */
     get daysRequiredToStart(): number;
     private _flagsRequiredToStart;
+    /**
+     * The list of flags required to start the stage.
+     */
     get flagsRequiredToStart(): StageFlags[];
     private _questsRequiredToStart;
+    /**
+     * The list of quests required to start the stage.
+     */
     get questsRequiredToStart(): QuestsRequiredType[];
     private _requestDescriptionToStart;
+    /**
+     * The description of the request to start the stage.
+     */
     get requestDescriptionToStart(): string;
     private _onStart?;
+    /**
+     * The function that will be called when the stage starts.
+     */
     get onStart(): undefined | ((props: OnStartStage) => void);
     private _onEnd?;
+    /**
+     * The function that will be called when the stage ends.
+     */
     get onEnd(): undefined | ((props: OnEndStage) => void);
 }
 declare class StageQuest extends Stage {
     constructor(id: string, props: StageProps);
+    /**
+     * Check if the flag and goals are completed.
+     * You can force the completion of the stage by setting the completed property to true.
+     */
     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.
      */
     get goals(): GoalStage[];
     private get prevStageEndDay();
     private set prevStageEndDay(value);
+    /**
+     * The day when the stage starts.
+     */
     get startDay(): number | undefined;
+    /**
+     * Check if the stage can start.
+     */
     get canStart(): boolean;
-    get onStart(): undefined | ((props: OnStartStage) => void);
+    /**
+     * 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.
+     */
+    start(props: OnStartStage): void;
 }
 
 declare class Quest extends StoredClassModel {
     constructor(id: string, stages: Stage[], props: QuestProps);
     private _stages;
+    /**
+     * The stages of the quest.
+     */
     get stages(): StageQuest[];
     private _name;
+    /**
+     * The name of the quest.
+     */
     get name(): string;
     private _description;
+    /**
+     * The description of the quest.
+     */
     get description(): string;
     private _renderIcon?;
     /**
@@ -70,14 +132,59 @@ declare class Quest extends StoredClassModel {
      */
     get renderImage(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
     private _isInDevelopment;
+    /**
+     * If the quest is in development.
+     */
     get isInDevelopment(): boolean;
+    /**
+     * The index of the current stage.
+     */
     get currentStageIndex(): number | undefined;
     private set currentStageIndex(value);
+    /**
+     * The current stage.
+     */
     get currentStage(): StageQuest | undefined;
+    /**
+     * If the quest is started.
+     */
     get started(): boolean;
+    /**
+     * If the quest is completed.
+     */
     get completed(): boolean;
+    /**
+     * Start the quest.
+     * @param props The properties for the start stage. If you not want to pass any property, you can pass an {}.
+     * @returns
+     */
     start(props: OnStartStage): void;
-    tryToGoNextStage(startProps: OnStartStage, endProps: OnEndStage): void;
+    /**
+     * 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;
+    get currentStageMustStart(): boolean;
+    startCurrentStage(props: OnStartStage): void;
 }
 
 type QuestsRequiredType = {

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-Eox2652k.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-D3LPSbFX.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-Eox2652k.mjs';
 export { default as Goal } from './quest/Goal.mjs';
-export { S as Stage } from '../StageProps-xLLR0rjD.mjs';
+export { S as Stage } from '../StageProps-D002cyay.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-D3LPSbFX.js';
 export { default as Goal } from './quest/Goal.js';
-export { S as Stage } from '../StageProps-DCZkZHwZ.js';
+export { S as Stage } from '../StageProps-DleWO-vf.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';

package/dist/classes/index.js

@@ -261,136 +261,7 @@ var TimeManager = class _TimeManager {
   }
 };
 
-// src/classes/Activity.ts
-var ActivityModel = class {
-  /**
-   * @param id The activity id, that must be unique.
-   * @param onRun The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function.
-   * @param props The activity properties.
-   */
-  constructor(id, onRun, props) {
-    this._id = id;
-    this._name = props.name;
-    this._fromHour = props.fromHour;
-    this._toHour = props.toHour;
-    this._fromDay = props.fromDay;
-    this._toDay = props.toDay;
-    this._disabled = props.disabled || false;
-    this._hidden = props.hidden || false;
-    this._renderIcon = props.renderIcon;
-    this._onRun = onRun;
-  }
-  /**
-   * The activity id, that is unique.
-   */
-  get id() {
-    return this._id;
-  }
-  /**
-   * The name
-   */
-  get name() {
-    return this._name;
-  }
-  /**
-   * The hour when the activity starts. If the activity is not started yet, it will be hidden.
-   */
-  get fromHour() {
-    return this._fromHour;
-  }
-  /**
-   * The hour when the activity ends. If the activity is ended yet, it will be hidden.
-   */
-  get toHour() {
-    return this._toHour;
-  }
-  /**
-   * The day when the activity starts. If the activity is not started yet, it will be hidden.
-   */
-  get fromDay() {
-    return this._fromDay;
-  }
-  /**
-   * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
-   */
-  get toDay() {
-    return this._toDay;
-  }
-  /**
-   * Whether is disabled.
-   */
-  get disabled() {
-    if (typeof this._disabled === "string") {
-      return pixiVn.getFlag(this._disabled);
-    }
-    return this._disabled;
-  }
-  /**
-   * Whether is hidden. If the activity is not started yet, it will be hidden.
-   */
-  get hidden() {
-    if (this.fromDay && this.fromDay > TimeManager.currentDay) {
-      return true;
-    }
-    if (!this.isDeadline) {
-      return true;
-    }
-    if (typeof this._hidden === "string") {
-      return pixiVn.getFlag(this._hidden);
-    }
-    return this._hidden;
-  }
-  /**
-   * The function for rendering the icon of the activity.
-   */
-  get renderIcon() {
-    let render = this._renderIcon;
-    if (render === void 0) {
-      return void 0;
-    }
-    if (typeof render === "function") {
-      return (props) => {
-        return render(this, props);
-      };
-    }
-    return (props) => render;
-  }
-  get _initialOnRun() {
-    return this._onRun;
-  }
-  /**
-   * The function that is called when the activity is runned.
-   */
-  get run() {
-    return (props) => this._onRun(this, props);
-  }
-  /**
-   * Whether the activity is a deadline.
-   * @returns Whether the activity is a deadline.
-   */
-  isDeadline() {
-    if (this.toDay && this.toDay <= TimeManager.currentDay) {
-      return true;
-    }
-    return false;
-  }
-  /**
-   * Export the activity properties.
-   * @returns The activity properties.
-   */
-  export() {
-    return {
-      name: this._name,
-      fromHour: this._fromHour,
-      toHour: this._toHour,
-      fromDay: this._fromDay,
-      toDay: this._toDay,
-      disabled: this._disabled,
-      hidden: this._hidden,
-      renderIcon: this._renderIcon
-    };
-  }
-};
+// src/classes/Commitment.ts
 var COMMITMENT_CATEGORY = "__nqtr-commitment__";
 var CommitmentBaseModel = class extends pixiVn.StoredClassModel {
   /**
@@ -1037,9 +908,15 @@ var Goal = class extends pixiVn.StoredClassModel {
   get description() {
     return this._description;
   }
+  /**
+   * The number of times the goal must be completed.
+   */
   get need() {
     return this._need;
   }
+  /**
+   * The default number of times the goal has been completed.
+   */
   get defaultHave() {
     return this._defaultHave;
   }
@@ -1063,12 +940,21 @@ var Stage = class extends pixiVn.StoredClassModel {
     this._onStart = props.onStart;
     this._onEnd = props.onEnd;
   }
+  /**
+   * The name of the stage.
+   */
   get name() {
     return this._name;
   }
+  /**
+   * The description of the stage.
+   */
   get description() {
     return this._description;
   }
+  /**
+   * The advice description of the stage.
+   */
   get adviceDescription() {
     return this._adviceDescription;
   }
@@ -1087,6 +973,10 @@ var Stage = class extends pixiVn.StoredClassModel {
     }
     return (props) => render;
   }
+  /**
+   * The list of goals that the player needs to complete to finish the stage.
+   * This is the list set by the developer. if you want to get the current goals, use the goals property.
+   */
   get defaultGoals() {
     return this._defaultGoals;
   }
@@ -1096,21 +986,39 @@ var Stage = class extends pixiVn.StoredClassModel {
   get flags() {
     return this._flags;
   }
+  /**
+   * The number of days required to start the stage.
+   */
   get daysRequiredToStart() {
     return this._daysRequiredToStart || 0;
   }
+  /**
+   * The list of flags required to start the stage.
+   */
   get flagsRequiredToStart() {
     return this._flagsRequiredToStart;
   }
+  /**
+   * The list of quests required to start the stage.
+   */
   get questsRequiredToStart() {
     return this._questsRequiredToStart || [];
   }
+  /**
+   * The description of the request to start the stage.
+   */
   get requestDescriptionToStart() {
     return this._requestDescriptionToStart;
   }
+  /**
+   * The function that will be called when the stage starts.
+   */
   get onStart() {
     return this._onStart;
   }
+  /**
+   * The function that will be called when the stage ends.
+   */
   get onEnd() {
     return this._onEnd;
   }
@@ -1387,7 +1295,6 @@ var RoomBaseModel = class extends pixiVn.StoredClassModel {
   }
 };
 
-exports.ActivityModel = ActivityModel;
 exports.ActivityRoom = ActivityRoom;
 exports.CommitmentBaseModel = CommitmentBaseModel;
 exports.Goal = Goal;