@drincs/nqtr 0.2.13 → 0.2.14

package/dist/StageProps-CqgBUi3e.d.mts

@@ -1,326 +0,0 @@
-import { OnRenderGraphicItemProps, GraphicItemType, OnStartEndStageQuest } 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 | ((stage: Stage, props: OnStartEndStageQuest) => void);
-    private _onEnd?;
-    /**
-     * The function that will be called when the stage ends.
-     */
-    get onEnd(): undefined | ((stage: Stage, props: OnStartEndStageQuest) => 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;
-    /**
-     * 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: OnStartEndStageQuest): 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;
-    private _onStart?;
-    /**
-     * The function that will be called when the quest starts.
-     */
-    get onStart(): undefined | ((stage: Quest, props: OnStartEndStageQuest) => void);
-    private _onNextStage?;
-    /**
-     * The function that will be called when the quest goes to the next stage.
-     */
-    get onNextStage(): undefined | ((stage: Quest, props: OnStartEndStageQuest) => void);
-    /**
-     * 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: OnStartEndStageQuest): void;
-    /**
-     * Go to the next stage if the current stage is completed.
-     * If you want to force the change of stage, use goNextStage.
-     * @param props The properties. If you not want to pass any property, you can pass an {}.
-     * @returns true if the stage was changed, false otherwise.
-     */
-    tryToGoNextStage(props: OnStartEndStageQuest): 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 props The properties. If you not want to pass any property, you can pass an {}.
-     * @returns true if the stage was changed, false otherwise.
-     */
-    completeCurrentStageAndGoNext(props: OnStartEndStageQuest): 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 props The properties. If you not want to pass any property, you can pass an {}.
-     * @returns returns true if the stage was changed, false otherwise.
-     */
-    goNextStage(props: OnStartEndStageQuest): boolean;
-    /**
-     * If the current stage must start. It is true if the current stage is not started, can start and not completed.
-     */
-    get currentStageMustStart(): boolean;
-    /**
-     * Start the current stage.
-     * @param props The properties for the start stage. If you not want to pass any property, you can pass an {}.
-     */
-    startCurrentStage(props: OnStartEndStageQuest): void;
-}
-
-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;
-    /**
-     * The function that will be executed when the quest starts.
-     */
-    onStart?: (quest: Quest, props: OnStartEndStageQuest) => void;
-    /**
-     * The function that will be executed when a stage end in the quest.
-     */
-    onNextStage?: (quest: Quest, props: OnStartEndStageQuest) => void;
-}
-
-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 []
-     */
-    flagsRequiredToStart?: StageFlags[];
-    /**
-     * The quests required to start the stage.
-     * @default []
-     */
-    questsRequiredToStart?: QuestsRequiredType[];
-    /**
-     * The description to request to start the stage.
-     * @default ""
-     */
-    requestDescriptionToStart?: string;
-    /**
-     * The function that will be executed when the stage starts.
-     */
-    onStart?: (stage: Stage, props: OnStartEndStageQuest) => void;
-    /**
-     * The function that will be executed when the stage ends.
-     */
-    onEnd?: (stage: Stage, props: OnStartEndStageQuest) => void;
-}
-
-export { type QuestsRequiredType as Q, type StageProps as S, type QuestProps as a, Quest as b, Stage as c, StageQuest as d };

package/dist/StageProps-DghO7WaT.d.ts

@@ -1,326 +0,0 @@
-import { OnRenderGraphicItemProps, GraphicItemType, OnStartEndStageQuest } 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 | ((stage: Stage, props: OnStartEndStageQuest) => void);
-    private _onEnd?;
-    /**
-     * The function that will be called when the stage ends.
-     */
-    get onEnd(): undefined | ((stage: Stage, props: OnStartEndStageQuest) => 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;
-    /**
-     * 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: OnStartEndStageQuest): 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;
-    private _onStart?;
-    /**
-     * The function that will be called when the quest starts.
-     */
-    get onStart(): undefined | ((stage: Quest, props: OnStartEndStageQuest) => void);
-    private _onNextStage?;
-    /**
-     * The function that will be called when the quest goes to the next stage.
-     */
-    get onNextStage(): undefined | ((stage: Quest, props: OnStartEndStageQuest) => void);
-    /**
-     * 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: OnStartEndStageQuest): void;
-    /**
-     * Go to the next stage if the current stage is completed.
-     * If you want to force the change of stage, use goNextStage.
-     * @param props The properties. If you not want to pass any property, you can pass an {}.
-     * @returns true if the stage was changed, false otherwise.
-     */
-    tryToGoNextStage(props: OnStartEndStageQuest): 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 props The properties. If you not want to pass any property, you can pass an {}.
-     * @returns true if the stage was changed, false otherwise.
-     */
-    completeCurrentStageAndGoNext(props: OnStartEndStageQuest): 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 props The properties. If you not want to pass any property, you can pass an {}.
-     * @returns returns true if the stage was changed, false otherwise.
-     */
-    goNextStage(props: OnStartEndStageQuest): boolean;
-    /**
-     * If the current stage must start. It is true if the current stage is not started, can start and not completed.
-     */
-    get currentStageMustStart(): boolean;
-    /**
-     * Start the current stage.
-     * @param props The properties for the start stage. If you not want to pass any property, you can pass an {}.
-     */
-    startCurrentStage(props: OnStartEndStageQuest): void;
-}
-
-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;
-    /**
-     * The function that will be executed when the quest starts.
-     */
-    onStart?: (quest: Quest, props: OnStartEndStageQuest) => void;
-    /**
-     * The function that will be executed when a stage end in the quest.
-     */
-    onNextStage?: (quest: Quest, props: OnStartEndStageQuest) => void;
-}
-
-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 []
-     */
-    flagsRequiredToStart?: StageFlags[];
-    /**
-     * The quests required to start the stage.
-     * @default []
-     */
-    questsRequiredToStart?: QuestsRequiredType[];
-    /**
-     * The description to request to start the stage.
-     * @default ""
-     */
-    requestDescriptionToStart?: string;
-    /**
-     * The function that will be executed when the stage starts.
-     */
-    onStart?: (stage: Stage, props: OnStartEndStageQuest) => void;
-    /**
-     * The function that will be executed when the stage ends.
-     */
-    onEnd?: (stage: Stage, props: OnStartEndStageQuest) => void;
-}
-
-export { type QuestsRequiredType as Q, type StageProps as S, type QuestProps as a, Quest as b, Stage as c, StageQuest as d };