@drincs/nqtr 0.0.4 → 0.0.5

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { CanvasBase, StoredClassModel, CharacterBaseModel } from '@drincs/pixi-vn';
 
-type GraphicItemType<TCanvasItem extends CanvasBase<any> = CanvasBase<any>> = string | HTMLElement | TCanvasItem;
+type GraphicItemType<TCanvasItem extends CanvasBase<any> = CanvasBase<any>> = string | Element | TCanvasItem;
 
 interface ActivityProps {
     /**
@@ -36,9 +36,9 @@ interface ActivityProps {
      */
     hidden?: boolean | string;
     /**
-     * The icon element. Can be a string or an HTMLElement or a Pixi'VN CanvasItem
+     * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
      */
-    iconElement?: GraphicItemType;
+    icon?: GraphicItemType;
 }
 declare abstract class ActivityStoredAbstract {
     constructor(onRun: (activity: ActivityModel) => void, props: ActivityProps);
@@ -66,8 +66,8 @@ declare abstract class ActivityStoredAbstract {
     private defaultHidden;
     get hidden(): boolean;
     set hidden(value: boolean | string);
-    private _iconElement?;
-    get iconElement(): GraphicItemType | undefined;
+    private _icon?;
+    get icon(): GraphicItemType | undefined;
     private _onRun;
     get onRun(): (activity: ActivityModel) => void;
     isExpired(): boolean;
@@ -91,8 +91,8 @@ declare class ActivityModel {
     get disabled(): boolean | undefined;
     private _hidden;
     get hidden(): boolean;
-    private _iconElement?;
-    get iconElement(): GraphicItemType | undefined;
+    private _icon?;
+    get icon(): GraphicItemType | undefined;
     private _onRun;
     get onRun(): (activity: ActivityModel) => void;
     isDeadline(): boolean;
@@ -105,7 +105,7 @@ interface MapBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
      */
     name?: string;
     /**
-     * The image. It can be a string, an HTMLElement or a Pixi'VN Canvas Item.
+     * 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
@@ -144,12 +144,40 @@ interface MapBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
      */
     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": northMap,
+ *         "south": southMap,
+ *         "east": eastMap,
+ *         "west": westMap
+ *     }
+ * });
+ * ```
+ */
 declare class MapBaseModel extends StoredClassModel {
-    constructor(id: string, props: MapBaseModelProps);
+    /**
+     * @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 default name.
+     */
     get name(): string;
-    set name(value: 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.
+     */
     get image(): GraphicItemType | {
         [key: string]: GraphicItemType;
     } | undefined;
@@ -157,11 +185,22 @@ declare class MapBaseModel extends StoredClassModel {
         [key: string]: GraphicItemType;
     } | 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);
+    /**
+     * Get all locations in the map.
+     * @returns The locations in the map.
+     */
+    getLocations<TLocation extends LocationBaseModel = LocationBaseModel>(): TLocation[];
 }
 
 declare enum ExecutionTypeEnum {
@@ -195,7 +234,7 @@ interface CommitmentBaseModelProps {
      */
     toDay?: number;
     /**
-     * The image. It can be a string, an HTMLElement or a Pixi'VN Canvas Item.
+     * 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
@@ -284,7 +323,7 @@ interface RoomBaseModelProps {
      */
     name?: string;
     /**
-     * The image. It can be a string, an HTMLElement or a Pixi'VN Canvas Item.
+     * 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
@@ -312,24 +351,57 @@ interface RoomBaseModelProps {
      */
     hidden?: boolean | string;
     /**
-     * The icon element. Can be a string or an HTMLElement or a Pixi'VN CanvasItem
+     * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
      */
-    iconElement?: GraphicItemType;
+    icon?: GraphicItemType;
     /**
      * Whether is an entrance room, so when the player enters in the location, it will be the first room to be shown.
      */
     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 {
-    constructor(id: string, location: TLocation, props: RoomBaseModelProps);
+    /**
+     * @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 default name.
+     */
     get name(): string;
-    set name(value: 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.
+     */
     get image(): GraphicItemType | {
         [key: string]: GraphicItemType;
     } | undefined;
@@ -337,23 +409,68 @@ declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseMo
         [key: string]: GraphicItemType;
     } | undefined);
     private defaultActivityIds;
+    /**
+     * The activities that are available in this room.
+     */
     get defaultActivities(): ActivityRoom<this>[];
-    get activityIds(): string[];
+    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);
-    private _iconElement?;
-    get iconElement(): GraphicItemType | undefined;
+    /**
+     * 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[];
 }
 
@@ -371,26 +488,76 @@ interface LocationBaseModelProps {
      */
     hidden?: boolean | string;
     /**
-     * The icon element. Can be a string or an HTMLElement or a Pixi'VN CanvasItem
+     * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
      */
-    iconElement?: GraphicItemType;
+    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 {
-    constructor(id: string, map: TMap, props: LocationBaseModelProps);
-    getEntrance<TRoom extends RoomBaseModel = RoomBaseModel>(): TRoom | undefined;
+    /**
+     * @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 default name.
+     */
     get name(): string;
-    set name(value: 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 _iconElement?;
-    get iconElement(): GraphicItemType | undefined;
+    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 GoalProps {
@@ -497,13 +664,33 @@ declare function addTemporaryCommitment<TCommitment extends CommitmentBaseModel
 declare function getFixedCommitments<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
 declare function getTemporaryCommitments<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
 
+/**
+ * Save a room in the registered rooms.
+ * @param room The room to save.
+ * @returns
+ */
 declare function saveRoom<TRoom extends RoomBaseModel = RoomBaseModel>(room: TRoom | TRoom[]): void;
+/**
+ * Get a room by its id.
+ * @param id The id of the room.
+ * @returns The room or undefined if not found.
+ */
 declare function getRoomById<TRoom extends RoomBaseModel = RoomBaseModel>(id: string): TRoom | undefined;
+/**
+ * Get all locations in the registered rooms.
+ * @returns All locations in the registered rooms.
+ */
+declare function getAllLocations<TLocation extends LocationBaseModel = LocationBaseModel>(): TLocation[];
+/**
+ * Get all maps in the registered rooms.
+ * @returns All maps in the registered rooms.
+ */
+declare function getAllMaps<TMap extends MapBaseModel = MapBaseModel>(): TMap[];
 
 declare function clearExpiredActivities(): void;
 declare function currentActivities(): ActivityRoom[];
 
-declare function setCurrentRoom<TRoom extends RoomBaseModel = RoomBaseModel>(room: TRoom): void;
+declare function setCurrentRoom<TRoom extends RoomBaseModel = RoomBaseModel>(room: TRoom | LocationBaseModel): void;
 declare function getCurrentRoom<TRoom extends RoomBaseModel = RoomBaseModel>(): TRoom | undefined;
 declare function getCurrenrLocation<TLocation extends LocationBaseModel = LocationBaseModel>(): TLocation | undefined;
 declare function getCueerntMap<TMap extends MapBaseModel = MapBaseModel>(): TMap | undefined;
@@ -640,4 +827,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, getCommitmentByCharacter, getCommitmentById, getCueerntMap, getCurrenrLocation, getCurrentCommitments, getCurrentRoom, getFixedCommitments, getRoomById, getTemporaryCommitments, saveActivity, saveCommitment, saveRoom, setCurrentRoom, setFixedCommitments };
+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 };