@drincs/nqtr/dist/interface/quest/StageProps.d.ts

A complete system introducing the concepts of location, time and event, producing the framework of a not-quite-point-and-click adventure game.

import { OnRunProps } from '@drincs/nqtr';
import { a as QuestsRequiredType, S as StageInterface } from '../../StageInterface-DX74DUxG.js';
import StageFlags from './StageFlags.js';

interface StageProps {
    /**
     * 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 of the stage.
     */
    image?: string;
    /**
     * 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: StageInterface, props: OnRunProps) => void;
    /**
     * The function that will be executed when the stage ends.
     */
    onEnd?: (stage: StageInterface, props: OnRunProps) => void;
}

export type { StageProps as default };