@drincs/nqtr 0.0.5 → 0.0.7

package/dist/index.d.ts

@@ -5,38 +5,46 @@ type GraphicItemType<TCanvasItem extends CanvasBase<any> = CanvasBase<any>> = st
 interface ActivityProps {
     /**
      * The name
+     * @default ""
      */
     name?: string;
     /**
      * The hour when the activity starts. If the activity is not started yet, it will be hidden.
      * If you set 3, the activity will be hidden into hours 1 and 2, and will be shown from hour 3.
+     * @default TimeManager.minDayHours
      */
     fromHour?: number;
     /**
      * The hour when the activity ends. If the activity is ended yet, it will be hidden.
      * If you set 3, the activity 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 activity starts. If the activity is not started yet, it will be hidden.
      * If you set 3, the activity will be hidden into days 1 and 2, and will be shown from day 3.
+     * @default undefined
      */
     fromDay?: number;
     /**
      * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
      * If you set 3, the activity will be shown into days 1 and 2 and will be deleted or hidden from day 3.
+     * @default undefined
      */
     toDay?: number;
     /**
      * 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;
 }
@@ -99,9 +107,15 @@ declare class ActivityModel {
     export(): ActivityProps;
 }
 
+declare enum ExecutionTypeEnum {
+    AUTOMATIC = "automatic",
+    INTERACTION = "interaction"
+}
+
 interface MapBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
     /**
      * The name
+     * @default ""
      */
     name?: string;
     /**
@@ -116,10 +130,9 @@ interface MapBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
      *    "night": "night-background.jpg"
      * }
      * ```
+     * @default undefined
      */
-    image?: GraphicItemType | {
-        [key: string]: GraphicItemType;
-    };
+    image?: GraphicItemType | Record<any, GraphicItemType> | object;
     /**
      * The neighboring maps that are available in this map.
      * @example
@@ -131,16 +144,19 @@ interface MapBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
      *    "west": birminghamMap
      * }
      * ```
+     * @default {}
      */
     neighboringMaps?: {
         [key: string]: TMap;
     };
     /**
      * 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;
 }
@@ -169,21 +185,17 @@ declare class MapBaseModel extends StoredClassModel {
     private defaultName;
     /**
      * The name of the map.
-     * If you set undefined, it will return the default 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 of the map. It can be a string, an Element or a Pixi'VN Canvas Item.
-     * If you set undefined, it will return the default image.
+     * If you set undefined, it will return the initial value of image.
      */
-    get image(): GraphicItemType | {
-        [key: string]: GraphicItemType;
-    } | undefined;
-    set image(value: GraphicItemType | {
-        [key: string]: GraphicItemType;
-    } | undefined);
+    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.
@@ -196,114 +208,21 @@ declare class MapBaseModel extends StoredClassModel {
      */
     get hidden(): boolean;
     set hidden(value: boolean | string);
+    private _neighboringMaps?;
     /**
-     * Get all locations in the map.
-     * @returns The locations in the map.
-     */
-    getLocations<TLocation extends LocationBaseModel = LocationBaseModel>(): TLocation[];
-}
-
-declare enum ExecutionTypeEnum {
-    AUTOMATIC = "automatic",
-    INTERACTION = "interaction"
-}
-
-interface CommitmentBaseModelProps {
-    /**
-     * The name
-     */
-    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.
-     */
-    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.
-     */
-    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.
-     */
-    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.
-     */
-    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"
-     * }
-     * ```
+     * The neighboring maps that are available in this map.
      */
-    image?: GraphicItemType | {
-        [key: string]: GraphicItemType;
+    get neighboringMaps(): {
+        [key: string]: MapBaseModel;
     };
+    set neighboringMaps(value: {
+        [key: string]: MapBaseModel;
+    } | undefined);
     /**
-     * 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.
-     */
-    executionType?: ExecutionTypeEnum;
-    /**
-     * Is a function that is called when the player interacts with the character.
-     * @param commitment
-     * @returns
-     */
-    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.
-     */
-    disabled?: boolean | string;
-    /**
-     * Whether is hidden. You can also pass a Pixi'VN flag name.
+     * Get all locations in the map.
+     * @returns The locations in the map.
      */
-    hidden?: boolean | string;
-}
-declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = CharacterBaseModel, TRoom extends RoomBaseModel = RoomBaseModel> extends StoredClassModel {
-    constructor(id: string, character: TCharacter | TCharacter[] | undefined, room: TRoom, props: CommitmentBaseModelProps);
-    private _characters;
-    get characters(): TCharacter[];
-    private _room;
-    get room(): TRoom;
-    private _name;
-    get name(): GraphicItemType;
-    private defaultFromHour?;
-    get fromHour(): number;
-    set fromHour(value: number | undefined);
-    private defaultToHour?;
-    get toHour(): number;
-    set toHour(value: number | undefined);
-    private defaultFromDay?;
-    get fromDay(): number | undefined;
-    set fromDay(value: number | undefined);
-    private defaultToDay?;
-    get toDay(): number | undefined;
-    set toDay(value: number | undefined);
-    private _image?;
-    get image(): GraphicItemType | {
-        [key: string]: GraphicItemType;
-    } | undefined;
-    private _executionType;
-    get executionType(): ExecutionTypeEnum;
-    private _onRun?;
-    onRun(): void;
-    private defaultDisabled;
-    get disabled(): boolean;
-    set disabled(value: boolean | string);
-    private defaultHidden;
-    get hidden(): boolean;
-    set hidden(value: boolean | string);
-    isExpired(): boolean;
+    getLocations<TLocation extends LocationBaseModel = LocationBaseModel>(): TLocation[];
 }
 
 declare class ActivityRoom<TRoom extends RoomBaseModel = RoomBaseModel> extends ActivityStoredAbstract {
@@ -320,6 +239,7 @@ declare class ActivityRoom<TRoom extends RoomBaseModel = RoomBaseModel> extends
 interface RoomBaseModelProps {
     /**
      * The name
+     * @default ""
      */
     name?: string;
     /**
@@ -334,28 +254,32 @@ interface RoomBaseModelProps {
      *    "night": "night-background.jpg"
      * }
      * ```
+     * @default undefined
      */
-    image?: GraphicItemType | {
-        [key: string]: GraphicItemType;
-    };
+    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;
 }
@@ -393,21 +317,17 @@ declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseMo
     private defaultName;
     /**
      * The name.
-     * If you set undefined, it will return the default 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 default image.
+     * If you set undefined, it will return the initial value of image.
      */
-    get image(): GraphicItemType | {
-        [key: string]: GraphicItemType;
-    } | undefined;
-    set image(value: GraphicItemType | {
-        [key: string]: GraphicItemType;
-    } | undefined);
+    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.
@@ -477,18 +397,22 @@ declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseMo
 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;
 }
@@ -512,7 +436,7 @@ declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extend
     private defaultName;
     /**
      * The name of the location.
-     * If you set undefined, it will return the default name.
+     * If you set undefined, it will return the initial value of name.
      */
     get name(): string;
     set name(value: string | undefined);
@@ -560,6 +484,176 @@ declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extend
     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;
+}
+
 interface GoalProps {
     description: string;
     need?: number;
@@ -699,10 +793,14 @@ declare function clearExpiredRoutine(): void;
 declare function getCurrentCommitments<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
 declare function getCommitmentByCharacter<TCommitment extends CommitmentBaseModel = CommitmentBaseModel, TCharacter extends CharacterBaseModel = CharacterBaseModel>(character: TCharacter): TCommitment | undefined;
 
+type ITimeStlot = {
+    name: string;
+    startHour: number;
+};
 /**
  * Time Settings, which can be set using `TimeManager.editSettings`
  */
-interface TimeSettings {
+type TimeSettings = {
     /**
      * Minimum hour of the day (default: 0)
      */
@@ -743,11 +841,8 @@ interface TimeSettings {
      * ```
      */
     weekDaysNames?: string[];
-}
-interface ITimeStlot {
-    name: string;
-    startHour: number;
-}
+};
+
 declare class TimeManager {
     private constructor();
     private static editSettings;
@@ -803,7 +898,7 @@ declare class TimeManager {
      *     )
      * }
      */
-    static get currentTimeSlots(): number;
+    static get currentTimeSlot(): number;
     /**
      * This function will increase the current hour by the given time spent.
      * If the new hour is greater than or equal to the max day hours, then it will increase the day and set the new hour.
@@ -827,4 +922,4 @@ declare class TimeManager {
     static nowIsBetween(fromHour: number, toHour: number): boolean;
 }
 
-export { ActivityModel, type ActivityProps, ExecutionTypeEnum, Goal, type GoalProps, LocationBaseModel, type LocationBaseModelProps, MapBaseModel, type MapBaseModelProps, QuestBaseModel, type QuestBaseModelProps, type QuestsRequiredType, RoomBaseModel, type RoomBaseModelProps, StageBaseModel, type StageBaseModelProps, TimeManager, type TimeSettings, addTemporaryCommitment, clearExpiredActivities, clearExpiredRoutine, currentActivities, getActivityById, getAllLocations, getAllMaps, getCommitmentByCharacter, getCommitmentById, getCueerntMap, getCurrenrLocation, getCurrentCommitments, getCurrentRoom, getFixedCommitments, getRoomById, getTemporaryCommitments, saveActivity, saveCommitment, saveRoom, setCurrentRoom, setFixedCommitments };
+export { ActivityModel, type ActivityProps, CommitmentBaseModel, type CommitmentBaseModelProps, ExecutionTypeEnum, Goal, type GoalProps, type ITimeStlot, LocationBaseModel, type LocationBaseModelProps, MapBaseModel, type MapBaseModelProps, QuestBaseModel, type QuestBaseModelProps, type QuestsRequiredType, RoomBaseModel, type RoomBaseModelProps, StageBaseModel, type StageBaseModelProps, TimeManager, type TimeSettings, addTemporaryCommitment, clearExpiredActivities, clearExpiredRoutine, currentActivities, getActivityById, getAllLocations, getAllMaps, getCommitmentByCharacter, getCommitmentById, getCueerntMap, getCurrenrLocation, getCurrentCommitments, getCurrentRoom, getFixedCommitments, getRoomById, getTemporaryCommitments, saveActivity, saveCommitment, saveRoom, setCurrentRoom, setFixedCommitments };