@drincs/nqtr/dist/classes/navigation/RoomBaseModel.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 { L as LocationInterface, C as CommitmentInterface } from '../../RoomInterface-CdAM_q7P.js';
import RoomBaseModelProps from '../../interface/navigation/RoomBaseModelProps.js';
import RoomStoredClass from './RoomStoredClass.js';
import '@drincs/nqtr';
import '@drincs/pixi-vn';
import '../../interface/ActivityInterface.js';
import '../../types/ExecutionType.js';
import '../../interface/navigation/NavigationAbstractClass.js';
import './NavigationAbstractClass.js';

/**
 * The base model of a room. I suggest you extend this class to create your own room model.
 * **You must use the {@link saveRoom} function to save the room in the registered rooms.**
 * @example
 * ```ts
 * export const mcRoom = new RoomBaseModel('mc_room', mcHome, {
 *     name: "MC Room",
 *     icon: "https://icon.jpg",
 *     image: "https://image.jpg",
 * })
 * saveRoom(mcRoom)
 * ```
 */
declare class RoomBaseModel extends RoomStoredClass {
    /**
     * @param id The id of the room, it must be unique.
     * @param location The location where the room is.
     * @param props The properties of the room.
     */
    constructor(id: string, location: LocationInterface, props?: RoomBaseModelProps);
    private defaultName;
    /**
     * The name.
     * If you set undefined, it will return the initial value of name.
     */
    get name(): string;
    set name(value: string | undefined);
    private _image?;
    /**
     * The image of the room.
     */
    get image(): string | undefined;
    private defaultDisabled;
    /**
     * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
     */
    get disabled(): boolean;
    set disabled(value: boolean | string);
    private defaultHidden;
    /**
     * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
     */
    get hidden(): boolean;
    set hidden(value: boolean | string);
    private _icon?;
    /**
     * The function for rendering the icon of the room.
     */
    get icon(): string | undefined;
    /**
     * Get the character commitments of the room.
     * @returns The character commitments of the room.
     */
    get routine(): CommitmentInterface[];
}

export { RoomBaseModel as default };