@drincs/nqtr 0.2.0 → 0.2.1

package/dist/{StageProps-DCZkZHwZ.d.ts → StageProps-BFsiCaZT.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,20 +37,42 @@ 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);
     /**
@@ -46,18 +81,36 @@ declare class StageQuest extends 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;
+    /**
+     * The function that will be called when the stage starts.
+     */
     get onStart(): undefined | ((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 +123,40 @@ 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;
+    /**
+     * Try to go to the next stage.
+     * @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;
 }
 
 type QuestsRequiredType = {

package/dist/{StageProps-xLLR0rjD.d.mts → StageProps-CkXejAbn.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,20 +37,42 @@ 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);
     /**
@@ -46,18 +81,36 @@ declare class StageQuest extends 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;
+    /**
+     * The function that will be called when the stage starts.
+     */
     get onStart(): undefined | ((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 +123,40 @@ 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;
+    /**
+     * Try to go to the next stage.
+     * @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;
 }
 
 type QuestsRequiredType = {

package/dist/classes/index.d.mts

@@ -1,7 +1,7 @@
 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 { default as Goal } from './quest/Goal.mjs';
-export { S as Stage } from '../StageProps-xLLR0rjD.mjs';
+export { S as Stage } from '../StageProps-CkXejAbn.mjs';
 import '@drincs/nqtr/dist/override';
 import '../ActivityProps-D45DQdcT.mjs';
 import '../types/OnRunActivityEvent.mjs';

package/dist/classes/index.d.ts

@@ -1,7 +1,7 @@
 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 { default as Goal } from './quest/Goal.js';
-export { S as Stage } from '../StageProps-DCZkZHwZ.js';
+export { S as Stage } from '../StageProps-BFsiCaZT.js';
 import '@drincs/nqtr/dist/override';
 import '../ActivityProps-BkHX8xkA.js';
 import '../types/OnRunActivityEvent.js';

package/dist/classes/index.js

@@ -1037,9 +1037,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 +1069,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 +1102,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 +1115,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;
   }