@drincs/nqtr 0.1.0 → 0.1.2

package/dist/index-BvCfRbJB.d.mts

@@ -0,0 +1,564 @@
+import ActivityModel, { ActivityStoredAbstract, OnRunActivityEvent, ActivityProps } from './classes/Activity.mjs';
+import { StoredClassModel, CharacterBaseModel } from '@drincs/pixi-vn';
+import { ExecutionTypeEnum } from './enums/ExecutionTypeEnum.mjs';
+import { GraphicItemType } from './types/GraphicItem.mjs';
+
+interface MapBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
+    /**
+     * The name
+     * @default ""
+     */
+    name?: 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
+     */
+    image?: GraphicItemType | Record<any, GraphicItemType> | object;
+    /**
+     * The neighboring maps that are available in this map.
+     * @example
+     * ```ts
+     * {
+     *    "north": "atlanta_map_id",
+     *    "south": "miami_map_id",
+     *    "east": "new_york_map_id",
+     *    "west": "los_angeles_map_id"
+     * }
+     * ```
+     * @default {}
+     */
+    neighboringMaps?: {
+        [key: string]: string;
+    };
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    hidden?: boolean | string;
+}
+/**
+ * The base model of a map. I suggest you extend this class to create your own map model.
+ * @example
+ * ```typescript
+ * export const mainMap = new MapBaseModel('main_map', {
+ *     name: 'Main Map',
+ *     image: "https://image.jpg",
+ *     neighboringMaps: {
+ *         "north": "atlanta_map_id",
+ *         "south": "miami_map_id",
+ *         "east": "new_york_map_id",
+ *         "west": "los_angeles_map_id"
+ *     }
+ * });
+ * ```
+ */
+declare class MapBaseModel extends StoredClassModel {
+    /**
+     * @param id The id of the map, it must be unique.
+     * @param props The properties of the map.
+     */
+    constructor(id: string, props?: MapBaseModelProps);
+    private defaultName;
+    /**
+     * The name of the map.
+     * If you set undefined, it will return the initial value of name.
+     */
+    get name(): string;
+    set name(value: string | undefined);
+    private defaultImage?;
+    /**
+     * The image of the map. It can be a string, an Element or a Pixi'VN Canvas Item.
+     * If you set undefined, it will return the initial value of image.
+     */
+    get image(): GraphicItemType | Record<any, GraphicItemType> | object | undefined;
+    set image(value: GraphicItemType | Record<any, GraphicItemType> | object | 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 _neighboringMaps?;
+    /**
+     * The neighboring maps that are available in this map.
+     * @example
+     * ```ts
+     * {
+     *     "north": "atlanta_map_id",
+     *     "south": "miami_map_id",
+     *     "east": "new_york_map_id",
+     *     "west": "los_angeles_map_id"
+     * }
+     * ```
+     */
+    get neighboringMaps(): {
+        [key: string]: string;
+    };
+    set neighboringMaps(value: {
+        [key: string]: string;
+    } | undefined);
+    /**
+     * Get all locations in the map.
+     * @returns The locations in the map.
+     */
+    getLocations<TLocation extends LocationBaseModel = LocationBaseModel>(): TLocation[];
+}
+
+/**
+ * The activity generated by the room.
+ */
+declare class ActivityRoom<TRoom extends RoomBaseModel = RoomBaseModel> extends ActivityStoredAbstract {
+    constructor(id: string, room: TRoom, onRun: OnRunActivityEvent<ActivityStoredAbstract>, props: ActivityProps);
+    setStorageProperty<T>(_: string, __: T | undefined): void;
+    getStorageProperty<T>(propertyName: string): T | undefined;
+    private _id;
+    get id(): string;
+    /**
+     * The room where the activity is.
+     */
+    private _room;
+    get room(): TRoom;
+    export(): object;
+}
+
+declare const ROOM_CATEGORY = "__nqtr-room__";
+interface RoomBaseModelProps {
+    /**
+     * The name
+     * @default ""
+     */
+    name?: 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
+     */
+    image?: GraphicItemType | Record<any, GraphicItemType> | object;
+    /**
+     * The activities that are available in this room.
+     * @default []
+     */
+    defaultActivities?: ActivityModel[];
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    hidden?: boolean | string;
+    /**
+     * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
+     * @default undefined
+     */
+    icon?: GraphicItemType;
+    /**
+     * Whether is an entrance room, so when the player enters in the location, it will be the first room to be shown.
+     * @default false
+     */
+    isEntrance?: boolean;
+}
+/**
+ * The base model of a room. I suggest you extend this class to create your own room model.
+ * You must use the 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",
+ *     isEntrance: false,
+ * })
+ * saveRoom(mcRoom)
+ * ```
+ */
+declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseModel> extends StoredClassModel {
+    /**
+     * @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: TLocation, props?: RoomBaseModelProps);
+    private _location;
+    /**
+     * The location where the room is.
+     */
+    get location(): TLocation;
+    private _isEntrance?;
+    /**
+     * Whether is an entrance room, so when the player enters in the location, it will be the first room to be shown.
+     */
+    get isEntrance(): boolean;
+    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 defaultImage?;
+    /**
+     * The image. It can be a string, an Element or a Pixi'VN Canvas Item.
+     * If you set undefined, it will return the initial value of image.
+     */
+    get image(): GraphicItemType | Record<any, GraphicItemType> | object | undefined;
+    set image(value: GraphicItemType | Record<any, GraphicItemType> | object | undefined);
+    private defaultActivityIds;
+    /**
+     * The activities that are available in this room.
+     */
+    get defaultActivities(): ActivityRoom<this>[];
+    private get activityIds();
+    /**
+     * The activities that are available in this room.
+     */
+    get activities(): ActivityRoom<this>[];
+    /**
+     * Get the memory of an activity. This function can be used into olther libraries to get the memory of the activity.
+     * @param id The id of the activity.
+     * @returns The memory of the activity.
+     */
+    getActivityMemory(id: string): object | undefined;
+    /**
+     * Get the activity by id.
+     * @param id The id of the activity.
+     * @returns The room activity.
+     */
+    getActivity(id: string): ActivityRoom<this> | undefined;
+    /**
+     * Set the memory of an activity. This function can be used into olther libraries to set the memory of the activity.
+     * @param id The id of the activity.
+     * @param memory The memory of the activity.
+     */
+    setActivity(activity: ActivityRoom): void;
+    /**
+     * Add an activity to the room.
+     * @param activity The activity to add.
+     */
+    addActivity(activity: ActivityModel): void;
+    /**
+     * Remove an activity from the room.
+     * @param activity The activity to remove.
+     */
+    removeActivity(activity: ActivityModel | string): void;
+    /**
+     * Clear all expired activities.
+     */
+    clearExpiredActivities(): void;
+    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);
+    /**
+     * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
+     */
+    private _icon?;
+    get icon(): GraphicItemType | undefined;
+    /**
+     * Get the character commitments of the room.
+     * @returns The character commitments of the room.
+     */
+    getRoutine<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
+}
+
+interface LocationBaseModelProps {
+    /**
+     * The name
+     * @default ""
+     */
+    name?: string;
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    hidden?: boolean | string;
+    /**
+     * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
+     * @default undefined
+     */
+    icon?: GraphicItemType;
+}
+/**
+ * The base model of a location. I suggest you extend this class to create your own location model.
+ * @example
+ * ```typescript
+ * export const mcHome = new LocationBaseModel('mc_home', mainMap, {
+ *     name: 'MC Home',
+ *     icon: "https://icon.jpg",
+ * });
+ * ```
+ */
+declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extends StoredClassModel {
+    /**
+     * @param id The id of the location, it must be unique.
+     * @param map The map where the location is.
+     * @param props The properties of the location.
+     */
+    constructor(id: string, map: TMap, props?: LocationBaseModelProps);
+    private defaultName;
+    /**
+     * The name of the location.
+     * If you set undefined, it will return the initial value of name.
+     */
+    get name(): string;
+    set name(value: 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 icon element. Can be a string or an Element or a Pixi'VN CanvasItem
+     */
+    get icon(): GraphicItemType | undefined;
+    private _map;
+    /**
+     * The map where the location is.
+     */
+    get map(): TMap;
+    /**
+     * Get the entrance room of the location.
+     * You can cast the room to a specific type that extends RoomBaseModel.
+     * @returns The entrance room or the first room if there is no entrance.
+     * @example
+     * ```typescript
+     * const entranceHome = new RoomBaseModel("entrance-home", home, { isEntrance: true })
+     * saveRoom(entranceHome)
+     * const home = new LocationBaseModel("home", map, { name: "Home" })
+     *
+     * const entrance = home.getEntrance() // entrance === entranceHome
+     * ```
+     */
+    getEntrance<TRoom extends RoomBaseModel = RoomBaseModel>(): TRoom | undefined;
+    /**
+     * Get all rooms in the location.
+     * You can cast the rooms to a specific type that extends RoomBaseModel.
+     * @returns The rooms in the location.
+     */
+    getRooms<TRoom extends RoomBaseModel = RoomBaseModel>(): TRoom[];
+}
+
+interface CommitmentBaseModelProps {
+    /**
+     * The name
+     * @default ""
+     */
+    name?: string;
+    /**
+     * The hour when the commitment starts. If the commitment is not started yet, it will be hidden.
+     * If you set 3, the commitment will be hidden into hours 1 and 2, and will be shown from hour 3.
+     * @default TimeManager.minDayHours
+     */
+    fromHour?: number;
+    /**
+     * The hour when the commitment ends. If the commitment is ended yet, it will be hidden.
+     * If you set 3, the commitment will be shown into hours 1 and 2 and will be hidden from hour 3.
+     * @default TimeManager.maxDayHours + 1
+     */
+    toHour?: number;
+    /**
+     * The day when the commitment starts. If the commitment is not started yet, it will be hidden.
+     * If you set 3, the commitment will be hidden into days 1 and 2, and will be shown from day 3.
+     * @default undefined
+     */
+    fromDay?: number;
+    /**
+     * The day when the commitment ends. If the commitment is ended yet, it will be deleted or hidden.
+     * If you set 3, the commitment will be shown into days 1 and 2 and will be deleted or hidden from day 3.
+     * @default undefined
+     */
+    toDay?: number;
+    /**
+     * 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
+     */
+    image?: GraphicItemType | Record<any, GraphicItemType> | object;
+    /**
+     * Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
+     * @default ExecutionTypeEnum.INTERACTION
+     */
+    executionType?: ExecutionTypeEnum;
+    /**
+     * Is a function that is called when the player interacts with the character.
+     * @param commitment
+     * @returns
+     * @default undefined
+     */
+    onRun?: (commitment: CommitmentBaseModel) => void;
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     * If it is disabled this commitment will not be taken into consideration. So the characters will not be in the room, but will be busy with other commitments.
+     * @default false
+     */
+    disabled?: boolean | string;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     * @default false
+     */
+    hidden?: boolean | string;
+}
+/**
+ * The base model of a commitment. I suggest you extend this class to create your own commitment model.
+ * You must use the saveRoom function to save the commitment in the registered commitments.
+ * @example
+ * ```ts
+ * export const mcRoom = new CommitmentBaseModel("test", character, room, {
+ *     name: "Test",
+ *     image: "https://image.jpg",
+ *     executionType: ExecutionTypeEnum.INTERACTION,
+ *     onRun: (commitment) => {
+ *         // Do something
+ *     }
+})
+ * saveCommitment(mcRoom)
+ * ```
+ */
+declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = CharacterBaseModel, TRoom extends RoomBaseModel = RoomBaseModel> extends StoredClassModel {
+    /**
+     * @param id The id of the commitment, it must be unique.
+     * @param character The character or characters that are in the commitment and so in the room.
+     * @param room The room where the commitment is.
+     * @param props The properties of the commitment.
+     */
+    constructor(id: string, character: TCharacter | TCharacter[] | undefined, room: TRoom, props: CommitmentBaseModelProps);
+    private _characters;
+    /**
+     * The character or characters that are in the commitment and so in the room.
+     */
+    get characters(): TCharacter[];
+    private _room;
+    /**
+     * The room where the commitment is.
+     */
+    get room(): TRoom;
+    private _name;
+    /**
+     * The name
+     */
+    get name(): GraphicItemType;
+    private defaultFromHour?;
+    /**
+     * The hour when the commitment starts. If the commitment is not started yet, it will be hidden.
+     * If you set undefined, it will return the initial value of fromHour.
+     */
+    get fromHour(): number;
+    set fromHour(value: number | undefined);
+    private defaultToHour?;
+    /**
+     * The hour when the commitment ends. If the commitment is ended yet, it will be hidden.
+     * If you set undefined, it will return the initial value of toHour.
+     */
+    get toHour(): number;
+    set toHour(value: number | undefined);
+    private defaultFromDay?;
+    /**
+     * The day when the commitment starts. If the commitment is not started yet, it will be hidden.
+     * If you set undefined, it will return the initial value of fromDay.
+     */
+    get fromDay(): number | undefined;
+    set fromDay(value: number | undefined);
+    private defaultToDay?;
+    /**
+     * The day when the commitment ends. If the commitment is ended yet, it will be deleted or hidden.
+     * If you set undefined, it will return the initial value of toDay.
+     */
+    get toDay(): number | undefined;
+    set toDay(value: number | undefined);
+    private _image?;
+    /**
+     * The image. It can be a string, an Element or a Pixi'VN Canvas Item.
+     */
+    get image(): GraphicItemType | Record<any, GraphicItemType> | object | undefined;
+    private _executionType;
+    /**
+     * Execution type. If is "automatic" the onRun() runned automatically when the palayer is in the room. If is "interaction" the player must interact with the character to run the onRun() function.
+     */
+    get executionType(): ExecutionTypeEnum;
+    private _onRun?;
+    /**
+     * Is a function that is called when the player interacts with the character.
+     */
+    onRun(): void;
+    private defaultDisabled;
+    /**
+     * Whether is disabled. You can also pass a Pixi'VN flag name.
+     */
+    get disabled(): boolean;
+    set disabled(value: boolean | string);
+    private defaultHidden;
+    /**
+     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     */
+    get hidden(): boolean;
+    set hidden(value: boolean | string);
+    /**
+     * Whether the commitment is expired.
+     * @returns Whether the commitment is expired.
+     */
+    isExpired(): boolean;
+}
+
+export { ActivityRoom as A, CommitmentBaseModel as C, LocationBaseModel as L, MapBaseModel as M, RoomBaseModel as R, type CommitmentBaseModelProps as a, type LocationBaseModelProps as b, type MapBaseModelProps as c, type RoomBaseModelProps as d, ROOM_CATEGORY as e };