@drincs/nqtr 0.1.14 → 0.1.16

package/dist/{index-Cu8ZAiqF.d.ts → Commitment-BjkhJtTx.d.ts}

@@ -1,14 +1,41 @@
-import ActivityModel, { ActivityStoredAbstract, OnRunActivityEvent, ActivityProps } from './classes/Activity.js';
-import { GraphicItemType, OnRenderGraphicItemProps } from '@drincs/nqtr/dist/override';
-import { StoredClassModel, CharacterBaseModel } from '@drincs/pixi-vn';
+import { GraphicItemType, OnRenderGraphicItemProps, OnRunActivityProps } from '@drincs/nqtr/dist/override';
+import { CharacterBaseModel, StoredClassModel } from '@drincs/pixi-vn';
 import { ExecutionTypeEnum } from './enums/ExecutionTypeEnum.js';
+import ActivityModel from './classes/Activity.js';
+import { a as ActivityStoredAbstract, A as ActivityProps } from './ActivityProps-B1IaFbGD.js';
+import { OnRunActivityEvent } from './types/OnRunActivityEvent.js';
+import { OnRunCommitmentEvent } from './types/OnRunCommitmentEvent.js';
 
-interface MapBaseModelProps {
+interface CommitmentProps<TCharacter extends CharacterBaseModel = CharacterBaseModel, TRoom extends RoomBaseModel = RoomBaseModel> {
     /**
      * 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.
@@ -23,7 +50,76 @@ interface MapBaseModelProps {
      * ```
      * @default undefined
      */
-    renderImage?: GraphicItemType | ((map: MapBaseModel, props?: OnRenderGraphicItemProps) => GraphicItemType);
+    renderImage?: GraphicItemType | ((commitment: CommitmentBaseModel<TCharacter, TRoom>, props: OnRenderGraphicItemProps) => GraphicItemType);
+    /**
+     * 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?: OnRunCommitmentEvent<CommitmentBaseModel>;
+    /**
+     * 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;
+}
+
+interface LocationProps<TMap extends MapBaseModel = MapBaseModel> {
+    /**
+     * 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
+     */
+    renderIcon?: GraphicItemType | ((location: LocationBaseModel<TMap>, props: OnRenderGraphicItemProps) => GraphicItemType);
+}
+
+interface MapProps {
+    /**
+     * 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
+     */
+    renderImage?: GraphicItemType | ((map: MapBaseModel, props: OnRenderGraphicItemProps) => GraphicItemType);
     /**
      * The neighboring maps that are available in this map.
      * @example
@@ -51,6 +147,72 @@ interface MapBaseModelProps {
      */
     hidden?: boolean | string;
 }
+
+interface RoomProps<TLocation extends LocationBaseModel = LocationBaseModel> {
+    /**
+     * 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
+     */
+    renderImage?: GraphicItemType | ((room: RoomBaseModel<TLocation>, props: OnRenderGraphicItemProps) => GraphicItemType);
+    /**
+     * 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
+     */
+    renderIcon?: GraphicItemType | ((room: RoomBaseModel<TLocation>, props: OnRenderGraphicItemProps) => 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 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;
+}
+
 /**
  * The base model of a map. I suggest you extend this class to create your own map model.
  * @example
@@ -72,7 +234,7 @@ 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);
+    constructor(id: string, props?: MapProps);
     private defaultName;
     /**
      * The name of the map.
@@ -84,7 +246,7 @@ declare class MapBaseModel extends StoredClassModel {
     /**
      * The function for rendering the image of the map.
      */
-    get renderImage(): ((props?: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
+    get renderImage(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
     private defaultDisabled;
     /**
      * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
@@ -124,70 +286,74 @@ declare class MapBaseModel extends StoredClassModel {
 }
 
 /**
- * The activity generated by the room.
+ * 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 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;
+declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extends StoredClassModel {
     /**
-     * The room where the activity is.
+     * @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.
      */
-    private _room;
-    get room(): TRoom;
-    export(): object;
-}
-
-declare const ROOM_CATEGORY = "__nqtr-room__";
-interface RoomBaseModelProps<TLocation extends LocationBaseModel = LocationBaseModel> {
+    constructor(id: string, map: TMap, props?: LocationProps<TMap>);
+    private defaultName;
     /**
-     * The name
-     * @default ""
+     * The name of the location.
+     * If you set undefined, it will return the initial value of name.
      */
-    name?: string;
+    get name(): string;
+    set name(value: string | undefined);
+    private defaultDisabled;
     /**
-     * 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
+     * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
      */
-    renderImage?: GraphicItemType | ((room: RoomBaseModel<TLocation>, props?: OnRenderGraphicItemProps) => GraphicItemType);
+    get disabled(): boolean;
+    set disabled(value: boolean | string);
+    private defaultHidden;
     /**
-     * The activities that are available in this room.
-     * @default []
+     * Whether is hidden. If it is a string, it is a Pixi'VN flag name.
      */
-    defaultActivities?: ActivityModel[];
+    get hidden(): boolean;
+    set hidden(value: boolean | string);
+    private _renderIcon?;
     /**
-     * Whether is disabled. You can also pass a Pixi'VN flag name.
-     * @default false
+     * The function for rendering the icon of the location.
      */
-    disabled?: boolean | string;
+    get renderIcon(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
+    private _map;
     /**
-     * Whether is hidden. You can also pass a Pixi'VN flag name.
-     * @default false
+     * The map where the location is.
      */
-    hidden?: boolean | string;
+    get map(): TMap;
     /**
-     * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
-     * @default undefined
+     * 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
+     * ```
      */
-    renderIcon?: GraphicItemType | ((room: RoomBaseModel<TLocation>, props?: OnRenderGraphicItemProps) => GraphicItemType);
+    getEntrance<TRoom extends RoomBaseModel = RoomBaseModel>(): TRoom | undefined;
     /**
-     * Whether is an entrance room, so when the player enters in the location, it will be the first room to be shown.
-     * @default false
+     * Get all rooms in the location.
+     * You can cast the rooms to a specific type that extends RoomBaseModel.
+     * @returns The rooms in the location.
      */
-    isEntrance?: boolean;
+    getRooms<TRoom extends RoomBaseModel = RoomBaseModel>(): TRoom[];
 }
+
+declare const ROOM_CATEGORY = "__nqtr-room__";
 /**
  * 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.
@@ -208,7 +374,7 @@ declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseMo
      * @param location The location where the room is.
      * @param props The properties of the room.
      */
-    constructor(id: string, location: TLocation, props?: RoomBaseModelProps<TLocation>);
+    constructor(id: string, location: TLocation, props?: RoomProps<TLocation>);
     private _location;
     /**
      * The location where the room is.
@@ -230,7 +396,7 @@ declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseMo
     /**
      * The function for rendering the image of the room.
      */
-    get renderImage(): ((props?: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
+    get renderImage(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
     private defaultActivityIds;
     /**
      * The activities that are available in this room.
@@ -289,7 +455,7 @@ declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseMo
     /**
      * The function for rendering the icon of the room.
      */
-    get renderIcon(): ((props?: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
+    get renderIcon(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
     /**
      * Get the character commitments of the room.
      * @returns The character commitments of the room.
@@ -297,165 +463,6 @@ declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseMo
     getRoutine<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
 }
 
-interface LocationBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
-    /**
-     * 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
-     */
-    renderIcon?: GraphicItemType | ((location: LocationBaseModel<TMap>, props?: OnRenderGraphicItemProps) => 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<TMap>);
-    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 _renderIcon?;
-    /**
-     * The function for rendering the icon of the location.
-     */
-    get renderIcon(): ((props?: OnRenderGraphicItemProps) => 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<TCharacter extends CharacterBaseModel = CharacterBaseModel, TRoom extends RoomBaseModel = RoomBaseModel> {
-    /**
-     * 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
-     */
-    renderImage?: GraphicItemType | ((commitment: CommitmentBaseModel<TCharacter, TRoom>, props?: OnRenderGraphicItemProps) => GraphicItemType);
-    /**
-     * 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.
@@ -468,7 +475,7 @@ interface CommitmentBaseModelProps<TCharacter extends CharacterBaseModel = Chara
  *     onRun: (commitment) => {
  *         // Do something
  *     }
-})
+ * })
  * saveCommitment(mcRoom)
  * ```
  */
@@ -479,7 +486,7 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
      * @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<TCharacter, TRoom>);
+    constructor(id: string, character: TCharacter | TCharacter[] | undefined, room: TRoom, props: CommitmentProps<TCharacter, TRoom>);
     private _characters;
     /**
      * The character or characters that are in the commitment and so in the room.
@@ -527,7 +534,7 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
     /**
      * The function for rendering the image of the room.
      */
-    get renderImage(): ((props?: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
+    get renderImage(): ((props: OnRenderGraphicItemProps) => GraphicItemType) | 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.
@@ -537,7 +544,7 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
     /**
      * Is a function that is called when the player interacts with the character.
      */
-    onRun(): void;
+    onRun(): undefined | ((props: OnRunActivityProps) => void);
     private defaultDisabled;
     /**
      * Whether is disabled. You can also pass a Pixi'VN flag name.
@@ -557,4 +564,4 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
     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 };
+export { ActivityRoom as A, CommitmentBaseModel as C, LocationBaseModel as L, MapBaseModel as M, RoomBaseModel as R, type CommitmentProps as a, type LocationProps as b, type MapProps as c, type RoomProps as d, ROOM_CATEGORY as e };