@drincs/nqtr 0.1.20 → 0.2.1

package/dist/{ActivityProps-_79x9-BX.d.ts → ActivityProps-BkHX8xkA.d.ts}

@@ -61,7 +61,7 @@ declare abstract class ActivityStoredAbstract {
     /**
      * The function that is called when the activity is runned.
      */
-    get onRun(): (props: OnRunProps) => void;
+    get run(): (props: OnRunProps) => void;
     /**
      * Whether the activity is a deadline.
      * @returns Whether the activity is a deadline.

package/dist/{ActivityProps-BoJeWa2B.d.mts → ActivityProps-D45DQdcT.d.mts}

@@ -61,7 +61,7 @@ declare abstract class ActivityStoredAbstract {
     /**
      * The function that is called when the activity is runned.
      */
-    get onRun(): (props: OnRunProps) => void;
+    get run(): (props: OnRunProps) => void;
     /**
      * Whether the activity is a deadline.
      * @returns Whether the activity is a deadline.

package/dist/{Commitment-Cc2kZEy0.d.ts → Commitment-BJTIpBQ5.d.ts}

@@ -2,7 +2,7 @@ import { GraphicItemType, OnRenderGraphicItemProps, OnRunProps } from '@drincs/n
 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-_79x9-BX.js';
+import { a as ActivityStoredAbstract, A as ActivityProps } from './ActivityProps-BkHX8xkA.js';
 import { OnRunActivityEvent } from './types/OnRunActivityEvent.js';
 import { OnRunCommitmentEvent } from './types/OnRunCommitmentEvent.js';
 
@@ -53,6 +53,7 @@ interface CommitmentProps<TCharacter extends CharacterBaseModel = CharacterBaseM
     renderImage?: GraphicItemType | ((commitment: CommitmentBaseModel<TCharacter, TRoom>, props: OnRenderGraphicItemProps) => GraphicItemType);
     /**
      * 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.
      * @default "interaction"
      */
     executionType?: ExecutionType;
@@ -549,6 +550,7 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
     private _executionType;
     /**
      * 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.
      */
     get executionType(): ExecutionType;
     private _renderIcon?;
@@ -560,7 +562,7 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
     /**
      * Is a function that is called when the player interacts with the character.
      */
-    get onRun(): undefined | ((props: OnRunProps) => void);
+    get run(): undefined | ((props: OnRunProps) => void);
     private defaultDisabled;
     /**
      * Whether is disabled. You can also pass a Pixi'VN flag name.

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

@@ -2,7 +2,7 @@ import { GraphicItemType, OnRenderGraphicItemProps, OnRunProps } from '@drincs/n
 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-BoJeWa2B.mjs';
+import { a as ActivityStoredAbstract, A as ActivityProps } from './ActivityProps-D45DQdcT.mjs';
 import { OnRunActivityEvent } from './types/OnRunActivityEvent.mjs';
 import { OnRunCommitmentEvent } from './types/OnRunCommitmentEvent.mjs';
 
@@ -53,6 +53,7 @@ interface CommitmentProps<TCharacter extends CharacterBaseModel = CharacterBaseM
     renderImage?: GraphicItemType | ((commitment: CommitmentBaseModel<TCharacter, TRoom>, props: OnRenderGraphicItemProps) => GraphicItemType);
     /**
      * 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.
      * @default "interaction"
      */
     executionType?: ExecutionType;
@@ -549,6 +550,7 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
     private _executionType;
     /**
      * 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.
      */
     get executionType(): ExecutionType;
     private _renderIcon?;
@@ -560,7 +562,7 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
     /**
      * Is a function that is called when the player interacts with the character.
      */
-    get onRun(): undefined | ((props: OnRunProps) => void);
+    get run(): undefined | ((props: OnRunProps) => void);
     private defaultDisabled;
     /**
      * Whether is disabled. You can also pass a Pixi'VN flag name.

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

@@ -1,8 +1,164 @@
-import { GraphicItemType, OnRenderGraphicItemProps } from '@drincs/nqtr/dist/override';
+import { OnRenderGraphicItemProps, GraphicItemType, OnStartStage, OnEndStage } from '@drincs/nqtr/dist/override';
 import { StoredClassModel } from '@drincs/pixi-vn';
 import Goal, { GoalStage } from './classes/quest/Goal.js';
 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?;
+    /**
+     * The function for rendering the image of the stage.
+     */
+    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;
+    /**
+     * The list of flags that the player must complete to finish the stage.
+     */
+    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);
+    /**
+     * 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;
+    /**
+     * 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?;
+    /**
+     * The function for rendering the icon of the quest.
+     */
+    get renderIcon(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
+    private _renderImage?;
+    /**
+     * The function for rendering the image of the quest.
+     */
+    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;
+    /**
+     * 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 = {
     quest: Quest;
     stageNumber: number;
@@ -110,88 +266,11 @@ interface StageProps {
     /**
      * The function that will be executed when the stage starts.
      */
-    onStart?: () => void;
+    onStart?: (props: OnStartStage) => void;
     /**
      * The function that will be executed when the stage ends.
      */
-    onEnd?: () => void;
-}
-
-declare class Stage extends StoredClassModel implements StageProps {
-    constructor(id: string, props: StageProps);
-    private _name;
-    get name(): string;
-    private _description;
-    get description(): string;
-    private _adviceDescription;
-    get adviceDescription(): string;
-    private _renderImage?;
-    /**
-     * The function for rendering the image of the stage.
-     */
-    get renderImage(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
-    private _defaultGoals;
-    get defaultGoals(): Goal[];
-    private _flags;
-    /**
-     * The list of flags that the player must complete to finish the stage.
-     */
-    get flags(): StageFlags[];
-    private _daysRequiredToStart?;
-    get daysRequiredToStart(): number;
-    private _flagsRequiredToStart;
-    get flagsRequiredToStart(): StageFlags[];
-    private _questsRequiredToStart;
-    get questsRequiredToStart(): QuestsRequiredType[];
-    private _requestDescriptionToStart;
-    get requestDescriptionToStart(): string;
-    private _onStart?;
-    get onStart(): undefined | (() => void);
-    private _onEnd?;
-    get onEnd(): undefined | (() => void);
-}
-declare class StageQuest extends Stage {
-    constructor(id: string, props: StageProps);
-    get completed(): boolean;
-    set completed(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);
-    get startDay(): number | undefined;
-    get canStart(): boolean;
-    get onStart(): undefined | (() => void);
-}
-
-declare class Quest extends StoredClassModel {
-    constructor(id: string, stages: Stage[], props: QuestProps);
-    private _stages;
-    get stages(): StageQuest[];
-    private _name;
-    get name(): string;
-    private _description;
-    get description(): string;
-    private _renderIcon?;
-    /**
-     * The function for rendering the icon of the quest.
-     */
-    get renderIcon(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
-    private _renderImage?;
-    /**
-     * The function for rendering the image of the quest.
-     */
-    get renderImage(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
-    private _isInDevelopment;
-    get isInDevelopment(): boolean;
-    get currentStageIndex(): number | undefined;
-    private set currentStageIndex(value);
-    get currentStage(): StageQuest | undefined;
-    get started(): boolean;
-    get completed(): boolean;
-    start(): void;
-    tryToGoNextStage(): void;
+    onEnd?: (props: OnEndStage) => void;
 }
 
-export { Quest as Q, Stage as S, type QuestProps as a, type StageProps as b, type QuestsRequiredType as c, StageQuest as d };
+export { type QuestProps as Q, Stage as S, type StageProps as a, type QuestsRequiredType as b, Quest as c, StageQuest as d };

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

@@ -1,8 +1,164 @@
-import { GraphicItemType, OnRenderGraphicItemProps } from '@drincs/nqtr/dist/override';
+import { OnRenderGraphicItemProps, GraphicItemType, OnStartStage, OnEndStage } from '@drincs/nqtr/dist/override';
 import { StoredClassModel } from '@drincs/pixi-vn';
 import Goal, { GoalStage } from './classes/quest/Goal.mjs';
 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?;
+    /**
+     * The function for rendering the image of the stage.
+     */
+    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;
+    /**
+     * The list of flags that the player must complete to finish the stage.
+     */
+    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);
+    /**
+     * 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;
+    /**
+     * 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?;
+    /**
+     * The function for rendering the icon of the quest.
+     */
+    get renderIcon(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
+    private _renderImage?;
+    /**
+     * The function for rendering the image of the quest.
+     */
+    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;
+    /**
+     * 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 = {
     quest: Quest;
     stageNumber: number;
@@ -110,88 +266,11 @@ interface StageProps {
     /**
      * The function that will be executed when the stage starts.
      */
-    onStart?: () => void;
+    onStart?: (props: OnStartStage) => void;
     /**
      * The function that will be executed when the stage ends.
      */
-    onEnd?: () => void;
-}
-
-declare class Stage extends StoredClassModel implements StageProps {
-    constructor(id: string, props: StageProps);
-    private _name;
-    get name(): string;
-    private _description;
-    get description(): string;
-    private _adviceDescription;
-    get adviceDescription(): string;
-    private _renderImage?;
-    /**
-     * The function for rendering the image of the stage.
-     */
-    get renderImage(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
-    private _defaultGoals;
-    get defaultGoals(): Goal[];
-    private _flags;
-    /**
-     * The list of flags that the player must complete to finish the stage.
-     */
-    get flags(): StageFlags[];
-    private _daysRequiredToStart?;
-    get daysRequiredToStart(): number;
-    private _flagsRequiredToStart;
-    get flagsRequiredToStart(): StageFlags[];
-    private _questsRequiredToStart;
-    get questsRequiredToStart(): QuestsRequiredType[];
-    private _requestDescriptionToStart;
-    get requestDescriptionToStart(): string;
-    private _onStart?;
-    get onStart(): undefined | (() => void);
-    private _onEnd?;
-    get onEnd(): undefined | (() => void);
-}
-declare class StageQuest extends Stage {
-    constructor(id: string, props: StageProps);
-    get completed(): boolean;
-    set completed(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);
-    get startDay(): number | undefined;
-    get canStart(): boolean;
-    get onStart(): undefined | (() => void);
-}
-
-declare class Quest extends StoredClassModel {
-    constructor(id: string, stages: Stage[], props: QuestProps);
-    private _stages;
-    get stages(): StageQuest[];
-    private _name;
-    get name(): string;
-    private _description;
-    get description(): string;
-    private _renderIcon?;
-    /**
-     * The function for rendering the icon of the quest.
-     */
-    get renderIcon(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
-    private _renderImage?;
-    /**
-     * The function for rendering the image of the quest.
-     */
-    get renderImage(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
-    private _isInDevelopment;
-    get isInDevelopment(): boolean;
-    get currentStageIndex(): number | undefined;
-    private set currentStageIndex(value);
-    get currentStage(): StageQuest | undefined;
-    get started(): boolean;
-    get completed(): boolean;
-    start(): void;
-    tryToGoNextStage(): void;
+    onEnd?: (props: OnEndStage) => void;
 }
 
-export { Quest as Q, Stage as S, type QuestProps as a, type StageProps as b, type QuestsRequiredType as c, StageQuest as d };
+export { type QuestProps as Q, Stage as S, type StageProps as a, type QuestsRequiredType as b, Quest as c, StageQuest as d };

package/dist/classes/Activity.d.mts

@@ -1,5 +1,5 @@
 import { OnRenderGraphicItemProps, GraphicItemType, OnRunProps } from '@drincs/nqtr/dist/override';
-import { A as ActivityProps, a as ActivityStoredAbstract } from '../ActivityProps-BoJeWa2B.mjs';
+import { A as ActivityProps, a as ActivityStoredAbstract } from '../ActivityProps-D45DQdcT.mjs';
 import { OnRunActivityEvent } from '../types/OnRunActivityEvent.mjs';
 
 /**
@@ -96,7 +96,7 @@ declare class ActivityModel {
     /**
      * The function that is called when the activity is runned.
      */
-    get onRun(): (props: OnRunProps) => void;
+    get run(): (props: OnRunProps) => void;
     /**
      * Whether the activity is a deadline.
      * @returns Whether the activity is a deadline.

package/dist/classes/Activity.d.ts

@@ -1,5 +1,5 @@
 import { OnRenderGraphicItemProps, GraphicItemType, OnRunProps } from '@drincs/nqtr/dist/override';
-import { A as ActivityProps, a as ActivityStoredAbstract } from '../ActivityProps-_79x9-BX.js';
+import { A as ActivityProps, a as ActivityStoredAbstract } from '../ActivityProps-BkHX8xkA.js';
 import { OnRunActivityEvent } from '../types/OnRunActivityEvent.js';
 
 /**
@@ -96,7 +96,7 @@ declare class ActivityModel {
     /**
      * The function that is called when the activity is runned.
      */
-    get onRun(): (props: OnRunProps) => void;
+    get run(): (props: OnRunProps) => void;
     /**
      * Whether the activity is a deadline.
      * @returns Whether the activity is a deadline.

package/dist/classes/Activity.js

@@ -346,7 +346,7 @@ var ActivityModel = class {
   /**
    * The function that is called when the activity is runned.
    */
-  get onRun() {
+  get run() {
     return (props) => this._onRun(this, props);
   }
   /**