@drincs/nqtr 0.1.19 → 0.1.20

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/index.d.mts

@@ -1,7 +1,7 @@
 export { default as ActivityModel } from './Activity.mjs';
-export { C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-C3Nc2RJH.mjs';
+export { A as ActivityRoom, C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-C3Nc2RJH.mjs';
 export { default as Goal } from './quest/Goal.mjs';
-export { Q as QuestBaseModel, S as StageBaseModel } from '../Quest-Bdm0R9LA.mjs';
+export { Q as Quest, S as Stage } from '../Quest-DaNlPBHb.mjs';
 import '@drincs/nqtr/dist/override';
 import '../ActivityProps-BoJeWa2B.mjs';
 import '../types/OnRunActivityEvent.mjs';
@@ -9,4 +9,4 @@ import '@drincs/pixi-vn';
 import '../types/ExecutionType.mjs';
 import '../types/OnRunCommitmentEvent.mjs';
 import '../interface/quest/GoalProps.mjs';
-import '../interface/quest/QuestProps.mjs';
+import '../interface/quest/StageFlags.mjs';

package/dist/classes/index.d.ts

@@ -1,7 +1,7 @@
 export { default as ActivityModel } from './Activity.js';
-export { C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-Cc2kZEy0.js';
+export { A as ActivityRoom, C as CommitmentBaseModel, L as LocationBaseModel, M as MapBaseModel, R as RoomBaseModel } from '../Commitment-Cc2kZEy0.js';
 export { default as Goal } from './quest/Goal.js';
-export { Q as QuestBaseModel, S as StageBaseModel } from '../Quest-CxJcXETG.js';
+export { Q as Quest, S as Stage } from '../Quest-BQ1pwvQ_.js';
 import '@drincs/nqtr/dist/override';
 import '../ActivityProps-_79x9-BX.js';
 import '../types/OnRunActivityEvent.js';
@@ -9,4 +9,4 @@ import '@drincs/pixi-vn';
 import '../types/ExecutionType.js';
 import '../types/OnRunCommitmentEvent.js';
 import '../interface/quest/GoalProps.js';
-import '../interface/quest/QuestProps.js';
+import '../interface/quest/StageFlags.js';