@drincs/nqtr 0.1.18 → 0.1.20

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

@@ -1,6 +1,6 @@
 import { GraphicItemType, OnRenderGraphicItemProps, OnRunProps } from '@drincs/nqtr/dist/override';
 import { CharacterBaseModel, StoredClassModel } from '@drincs/pixi-vn';
-import { ExecutionTypeEnum } from './enums/ExecutionTypeEnum.mjs';
+import ExecutionType from './types/ExecutionType.mjs';
 import ActivityModel from './classes/Activity.mjs';
 import { a as ActivityStoredAbstract, A as ActivityProps } from './ActivityProps-BoJeWa2B.mjs';
 import { OnRunActivityEvent } from './types/OnRunActivityEvent.mjs';
@@ -53,9 +53,9 @@ 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.
-     * @default ExecutionTypeEnum.INTERACTION
+     * @default "interaction"
      */
-    executionType?: ExecutionTypeEnum;
+    executionType?: ExecutionType;
     /**
      * Is a function that is called when the player interacts with the character.
      * @param commitment
@@ -79,6 +79,12 @@ interface CommitmentProps<TCharacter extends CharacterBaseModel = CharacterBaseM
      * @default undefined
      */
     renderIcon?: GraphicItemType | ((commitment: CommitmentBaseModel, props: OnRenderGraphicItemProps) => GraphicItemType);
+    /**
+     * The priority. The higher the number, the higher the priority.
+     * To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.
+     * @default 0
+     */
+    priority?: number;
 }
 
 interface LocationProps<TMap extends MapBaseModel = MapBaseModel> {
@@ -544,7 +550,7 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
     /**
      * 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.
      */
-    get executionType(): ExecutionTypeEnum;
+    get executionType(): ExecutionType;
     private _renderIcon?;
     /**
      * The function for rendering the icon of the commitment.
@@ -567,6 +573,13 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
      */
     get hidden(): boolean;
     set hidden(value: boolean | string);
+    private defaultPriority;
+    /**
+     * The priority. The higher the number, the higher the priority.
+     * To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.
+     */
+    get priority(): number;
+    set priority(value: number);
     /**
      * Whether the commitment is expired.
      * @returns Whether the commitment is expired.

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

@@ -1,6 +1,6 @@
 import { GraphicItemType, OnRenderGraphicItemProps, OnRunProps } from '@drincs/nqtr/dist/override';
 import { CharacterBaseModel, StoredClassModel } from '@drincs/pixi-vn';
-import { ExecutionTypeEnum } from './enums/ExecutionTypeEnum.js';
+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 { OnRunActivityEvent } from './types/OnRunActivityEvent.js';
@@ -53,9 +53,9 @@ 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.
-     * @default ExecutionTypeEnum.INTERACTION
+     * @default "interaction"
      */
-    executionType?: ExecutionTypeEnum;
+    executionType?: ExecutionType;
     /**
      * Is a function that is called when the player interacts with the character.
      * @param commitment
@@ -79,6 +79,12 @@ interface CommitmentProps<TCharacter extends CharacterBaseModel = CharacterBaseM
      * @default undefined
      */
     renderIcon?: GraphicItemType | ((commitment: CommitmentBaseModel, props: OnRenderGraphicItemProps) => GraphicItemType);
+    /**
+     * The priority. The higher the number, the higher the priority.
+     * To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.
+     * @default 0
+     */
+    priority?: number;
 }
 
 interface LocationProps<TMap extends MapBaseModel = MapBaseModel> {
@@ -544,7 +550,7 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
     /**
      * 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.
      */
-    get executionType(): ExecutionTypeEnum;
+    get executionType(): ExecutionType;
     private _renderIcon?;
     /**
      * The function for rendering the icon of the commitment.
@@ -567,6 +573,13 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
      */
     get hidden(): boolean;
     set hidden(value: boolean | string);
+    private defaultPriority;
+    /**
+     * The priority. The higher the number, the higher the priority.
+     * To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.
+     */
+    get priority(): number;
+    set priority(value: number);
     /**
      * Whether the commitment is expired.
      * @returns Whether the commitment is expired.

package/dist/Quest-BQ1pwvQ_.d.ts

@@ -0,0 +1,197 @@
+import { GraphicItemType, OnRenderGraphicItemProps } 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';
+
+type QuestsRequiredType = {
+    quest: Quest;
+    stageNumber: number;
+};
+
+interface QuestProps {
+    /**
+     * The name of the quest.
+     * @default ""
+     */
+    name?: string;
+    /**
+     * The description of the quest.
+     * @default ""
+     */
+    description?: string;
+    /**
+     * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
+     * @default undefined
+     */
+    renderIcon?: GraphicItemType | ((room: Quest, props: OnRenderGraphicItemProps) => GraphicItemType);
+    /**
+     * The image. It can be a string, an Element or a Pixi'VN Canvas Item.
+     * Or an object to manage multiple image types. For example to have a image based on time.
+     * @example
+     * ```ts
+     * {
+     *    "morning": "morning-background.jpg",
+     *    "afternoon": "afternoon-background.jpg",
+     *    "evening": "evening-background.jpg",
+     *    "night": "night-background.jpg"
+     * }
+     * ```
+     * @default undefined
+     */
+    renderImage?: GraphicItemType | ((room: Quest, props: OnRenderGraphicItemProps) => GraphicItemType);
+    /**
+     * If the quest is in development.
+     * @default false
+     */
+    isInDevelopment?: boolean;
+}
+
+interface StageProps {
+    /**
+     * The goals of the stage.
+     * @default []
+     */
+    goals?: Goal[];
+    /**
+     * The flags of the stage.
+     * @default []
+     */
+    flags?: StageFlags[];
+    /**
+     * The name of the stage.
+     * @default ""
+     */
+    name?: string;
+    /**
+     * The description of the stage.
+     * @default ""
+     */
+    description?: string;
+    /**
+     * The advice description of the stage.
+     * @default ""
+     */
+    adviceDescription?: string;
+    /**
+     * The image. It can be a string, an Element or a Pixi'VN Canvas Item.
+     * Or an object to manage multiple image types. For example to have a image based on time.
+     * @example
+     * ```ts
+     * {
+     *    "morning": "morning-background.jpg",
+     *    "afternoon": "afternoon-background.jpg",
+     *    "evening": "evening-background.jpg",
+     *    "night": "night-background.jpg"
+     * }
+     * ```
+     * @default undefined
+     */
+    renderImage?: GraphicItemType | ((room: Stage, props: OnRenderGraphicItemProps) => GraphicItemType);
+    /**
+     * The day required to start the stage.
+     * @example If the value is 3, and the previous stage ends on day 1, the stage will start on day 4.
+     */
+    daysRequiredToStart?: number;
+    /**
+     * The flags required to start the stage.
+     * @default []
+     */
+    flagsRequired?: StageFlags[];
+    /**
+     * The quests required to start the stage.
+     * @default []
+     */
+    questsRequired?: QuestsRequiredType[];
+    /**
+     * The description to request to start the stage.
+     * @default ""
+     */
+    requestDescription?: string;
+    /**
+     * The function that will be executed when the stage starts.
+     */
+    onStart?: () => 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;
+}
+
+export { Quest as Q, Stage as S, type QuestProps as a, type StageProps as b, type QuestsRequiredType as c, StageQuest as d };

package/dist/Quest-DaNlPBHb.d.mts

@@ -0,0 +1,197 @@
+import { GraphicItemType, OnRenderGraphicItemProps } 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';
+
+type QuestsRequiredType = {
+    quest: Quest;
+    stageNumber: number;
+};
+
+interface QuestProps {
+    /**
+     * The name of the quest.
+     * @default ""
+     */
+    name?: string;
+    /**
+     * The description of the quest.
+     * @default ""
+     */
+    description?: string;
+    /**
+     * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
+     * @default undefined
+     */
+    renderIcon?: GraphicItemType | ((room: Quest, props: OnRenderGraphicItemProps) => GraphicItemType);
+    /**
+     * The image. It can be a string, an Element or a Pixi'VN Canvas Item.
+     * Or an object to manage multiple image types. For example to have a image based on time.
+     * @example
+     * ```ts
+     * {
+     *    "morning": "morning-background.jpg",
+     *    "afternoon": "afternoon-background.jpg",
+     *    "evening": "evening-background.jpg",
+     *    "night": "night-background.jpg"
+     * }
+     * ```
+     * @default undefined
+     */
+    renderImage?: GraphicItemType | ((room: Quest, props: OnRenderGraphicItemProps) => GraphicItemType);
+    /**
+     * If the quest is in development.
+     * @default false
+     */
+    isInDevelopment?: boolean;
+}
+
+interface StageProps {
+    /**
+     * The goals of the stage.
+     * @default []
+     */
+    goals?: Goal[];
+    /**
+     * The flags of the stage.
+     * @default []
+     */
+    flags?: StageFlags[];
+    /**
+     * The name of the stage.
+     * @default ""
+     */
+    name?: string;
+    /**
+     * The description of the stage.
+     * @default ""
+     */
+    description?: string;
+    /**
+     * The advice description of the stage.
+     * @default ""
+     */
+    adviceDescription?: string;
+    /**
+     * The image. It can be a string, an Element or a Pixi'VN Canvas Item.
+     * Or an object to manage multiple image types. For example to have a image based on time.
+     * @example
+     * ```ts
+     * {
+     *    "morning": "morning-background.jpg",
+     *    "afternoon": "afternoon-background.jpg",
+     *    "evening": "evening-background.jpg",
+     *    "night": "night-background.jpg"
+     * }
+     * ```
+     * @default undefined
+     */
+    renderImage?: GraphicItemType | ((room: Stage, props: OnRenderGraphicItemProps) => GraphicItemType);
+    /**
+     * The day required to start the stage.
+     * @example If the value is 3, and the previous stage ends on day 1, the stage will start on day 4.
+     */
+    daysRequiredToStart?: number;
+    /**
+     * The flags required to start the stage.
+     * @default []
+     */
+    flagsRequired?: StageFlags[];
+    /**
+     * The quests required to start the stage.
+     * @default []
+     */
+    questsRequired?: QuestsRequiredType[];
+    /**
+     * The description to request to start the stage.
+     * @default ""
+     */
+    requestDescription?: string;
+    /**
+     * The function that will be executed when the stage starts.
+     */
+    onStart?: () => 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;
+}
+
+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,7 +1,7 @@
 import '@drincs/nqtr/dist/override';
 import '@drincs/pixi-vn';
-import '../enums/ExecutionTypeEnum.mjs';
-export { C as default } from '../Commitment-DNn_TEgV.mjs';
+export { C as default } from '../Commitment-C3Nc2RJH.mjs';
+import '../types/ExecutionType.mjs';
 import './Activity.mjs';
 import '../ActivityProps-BoJeWa2B.mjs';
 import '../types/OnRunActivityEvent.mjs';

package/dist/classes/Commitment.d.ts

@@ -1,7 +1,7 @@
 import '@drincs/nqtr/dist/override';
 import '@drincs/pixi-vn';
-import '../enums/ExecutionTypeEnum.js';
-export { C as default } from '../Commitment-GIA4EK_q.js';
+export { C as default } from '../Commitment-Cc2kZEy0.js';
+import '../types/ExecutionType.js';
 import './Activity.js';
 import '../ActivityProps-_79x9-BX.js';
 import '../types/OnRunActivityEvent.js';

package/dist/classes/Commitment.js

@@ -265,11 +265,12 @@ var CommitmentBaseModel = class extends pixiVn.StoredClassModel {
     this.defaultFromDay = props.fromDay;
     this.defaultToDay = props.toDay;
     this._renderImage = props.renderImage;
-    this._executionType = props.executionType || "interaction" /* INTERACTION */;
+    this._executionType = props.executionType || "interaction";
     this._onRun = props.onRun;
     this.defaultDisabled = props.disabled || false;
     this.defaultHidden = props.hidden || false;
     this._renderIcon = props.renderIcon;
+    this.defaultPriority = props.priority || 0;
   }
   /**
    * The character or characters that are in the commitment and so in the room.
@@ -411,6 +412,16 @@ var CommitmentBaseModel = class extends pixiVn.StoredClassModel {
   set hidden(value) {
     this.setStorageProperty("hidden", value);
   }
+  /**
+   * The priority. The higher the number, the higher the priority.
+   * To ensure that a character is not in 2 places at the same time, if there are 2 or more valid commits at the same time and with the same character, the one with the highest priority will be chosen.
+   */
+  get priority() {
+    return this.getStorageProperty("priority") || this.defaultPriority || 0;
+  }
+  set priority(value) {
+    this.setStorageProperty("priority", value);
+  }
   /**
    * Whether the commitment is expired.
    * @returns Whether the commitment is expired.