@drincs/nqtr/dist/nqtr.d.d.mts

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

declare module "@drincs/nqtr" {
    interface ActivityInterface {
        /**
         * The name of the activity.
         */
        name: string;
        /**
         * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
         */
        get disabled(): boolean;
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        set disabled(value: boolean | string);
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        get hidden(): boolean;
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        set hidden(value: boolean | string);
        /**
         * The icon of the activity.
         */
        readonly icon: string | undefined;
    }
    interface CommitmentInterface {
        /**
         * The name of the commitment.
         */
        readonly name: string;
        /**
         * The image of the commitment.
         */
        readonly image: string;
        /**
         * The icon of the commitment.
         */
        readonly icon: string;
        /**
         * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
         */
        get disabled(): boolean;
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        set disabled(value: boolean | string);
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        get hidden(): boolean;
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        set hidden(value: boolean | string);
    }
    interface LocationInterface {
        /**
         * The name of the location.
         * If you set undefined, it will return the initial value of name.
         */
        name: string;
        /**
         * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
         */
        get disabled(): boolean;
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        set disabled(value: boolean | string);
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        get hidden(): boolean;
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        set hidden(value: boolean | string);
        /**
         * The icon of the location.
         */
        readonly icon: string | undefined;
    }
    interface MapInterface {
        /**
         * The name of the map.
         */
        name: string;
        /**
         * The image of the map.
         */
        readonly image?: string;
    }
    /**
     * The props of the OnRunActivityEvent function.
     * You can override this interface to add your own props.
     * @example
     * ```typescript
     * // nqtr.types.ts
     * declare module '@drincs/nqtr' {
     *     interface OnRunProps {
     *         navigate: (route: string) => void,
     *         [key: string]: any
     *     }
     * }
     * ```
     */
    interface OnRunProps {
        [key: string]: any;
    }
    interface QuestInterface {
        /**
         * The name of the quest.
         */
        readonly name: string;
        /**
         * The description of the quest.
         */
        readonly description: string;
        /**
         * The function for rendering the icon of the quest.
         */
        readonly icon?: string;
        /**
         * The function for rendering the image of the quest.
         */
        readonly image?: string;
        /**
         * If the quest is in development.
         */
        readonly inDevelopment: boolean;
    }
    interface RoomInterface {
        /**
         * The name.
         * If you set undefined, it will return the initial value of name.
         */
        name: string;
        /**
         * The image of the room.
         */
        readonly image: string | undefined;
        /**
         * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
         */
        get disabled(): boolean;
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        set disabled(value: boolean | string);
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        get hidden(): boolean;
        /**
         * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
         */
        set hidden(value: boolean | string);
        /**
         * The icon of the room.
         */
        readonly icon: string | undefined;
    }
    interface StageInterface {
        /**
         * The name of the stage.
         */
        readonly name: string;
        /**
         * The description of the stage.
         */
        readonly description: string;
        /**
         * The advice description of the stage.
         */
        readonly adviceDescription: string;
        /**
         * The image of the stage.
         */
        readonly image?: string;
        /**
         * The list of flags that the player must complete to finish the stage.
         */
        readonly flags: StageFlags[];
        /**
         * The list of flags required to start the stage.
         */
        readonly flagsRequiredToStart: StageFlags[];
        /**
         * The description of the request to start the stage.
         */
        readonly requestDescriptionToStart: string;
    }
}