@drincs/nqtr 0.1.0 → 0.1.1

package/dist/index.d.mts

@@ -48,62 +48,153 @@ interface ActivityProps {
      */
     icon?: GraphicItemType;
 }
+/**
+ * The function that is called when the activity is runned.
+ */
+type OnRunActivityEvent<T> = (activity: T, yourParams?: {
+    [key: string]: any;
+}) => void;
 declare abstract class ActivityStoredAbstract {
-    constructor(onRun: (activity: ActivityStoredAbstract) => void, props: ActivityProps);
+    /**
+     * @param onRun The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function.
+     * @param props The activity properties.
+     */
+    constructor(onRun: OnRunActivityEvent<ActivityStoredAbstract>, props: ActivityProps);
     abstract setStorageProperty<T>(propertyName: string, value: T | undefined): void;
     abstract getStorageProperty<T>(propertyName: string): T | undefined;
     abstract get id(): string;
     private defaultName?;
+    /**
+     * The name
+     */
     get name(): string;
     set name(value: string | undefined);
     private defaultFromHour?;
+    /**
+     * The hour when the activity starts. If the activity is not started yet, it will be hidden.
+     */
     get fromHour(): number;
     set fromHour(value: number | undefined);
     private defaultToHour?;
+    /**
+     * The hour when the activity ends. If the activity is ended yet, it will be hidden.
+     */
     get toHour(): number;
     set toHour(value: number | undefined);
     private defaultFromDay?;
+    /**
+     * The day when the activity starts. If the activity is not started yet, it will be hidden.
+     */
     get fromDay(): number | undefined;
     set fromDay(value: number | undefined);
     private defaultToDay?;
+    /**
+     * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
+     */
     get toDay(): number | undefined;
     set toDay(value: number | undefined);
     private defaultDisabled;
+    /**
+     * Whether is disabled.
+     */
     get disabled(): boolean;
     set disabled(value: boolean | string);
     private defaultHidden;
+    /**
+     * Whether is hidden. If the activity is not started yet, it will be hidden.
+     */
     get hidden(): boolean;
     set hidden(value: boolean | string);
     private _icon?;
+    /**
+     * The icon element.
+     */
     get icon(): GraphicItemType | undefined;
     private _onRun;
+    /**
+     * The function that is called when the activity is runned.
+     */
     get onRun(): () => void;
+    /**
+     * Whether the activity is a deadline.
+     * @returns Whether the activity is a deadline.
+     */
     isExpired(): boolean;
+    /**
+     * Export the activity properties.
+     * @returns The activity properties.
+     */
     export(): ActivityProps;
 }
+/**
+ * The activity model.
+ */
 declare class ActivityModel {
-    constructor(id: string, onRun: (activity: ActivityModel) => void, props: ActivityProps);
+    /**
+     * @param id The activity id, that must be unique.
+     * @param onRun The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function.
+     * @param props The activity properties.
+     */
+    constructor(id: string, onRun: OnRunActivityEvent<ActivityModel>, props: ActivityProps);
     private _id;
+    /**
+     * The activity id, that is unique.
+     */
     get id(): string;
     private _name?;
+    /**
+     * The name
+     */
     get name(): string | undefined;
     private _fromHour?;
+    /**
+     * The hour when the activity starts. If the activity is not started yet, it will be hidden.
+     */
     get fromHour(): number | undefined;
     private _toHour?;
+    /**
+     * The hour when the activity ends. If the activity is ended yet, it will be hidden.
+     */
     get toHour(): number | undefined;
     private _fromDay?;
+    /**
+     * The day when the activity starts. If the activity is not started yet, it will be hidden.
+     */
     get fromDay(): number | undefined;
     private _toDay?;
+    /**
+     * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
+     */
     get toDay(): number | undefined;
     private _disabled?;
+    /**
+     * Whether is disabled.
+     */
     get disabled(): boolean | undefined;
     private _hidden;
+    /**
+     * Whether is hidden. If the activity is not started yet, it will be hidden.
+     */
     get hidden(): boolean;
     private _icon?;
+    /**
+     * The icon element.
+     */
     get icon(): GraphicItemType | undefined;
     private _onRun;
+    /**
+     * The function that is called when the activity is runned.
+     */
     get onRun(): () => void;
+    /**
+     * Whether the activity is a deadline.
+     * @returns Whether the activity is a deadline.
+     */
     isDeadline(): boolean;
+    /**
+     * Export the activity properties.
+     * @returns The activity properties.
+     */
     export(): ActivityProps;
 }
 
@@ -138,16 +229,16 @@ interface MapBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
      * @example
      * ```ts
      * {
-     *    "north": atlantaMap,
-     *    "south": miamiMap,
-     *    "east": savannahMap,
-     *    "west": birminghamMap
+     *    "north": "atlanta_map_id",
+     *    "south": "miami_map_id",
+     *    "east": "new_york_map_id",
+     *    "west": "los_angeles_map_id"
      * }
      * ```
      * @default {}
      */
     neighboringMaps?: {
-        [key: string]: TMap;
+        [key: string]: string;
     };
     /**
      * Whether is disabled. You can also pass a Pixi'VN flag name.
@@ -225,12 +316,18 @@ declare class MapBaseModel extends StoredClassModel {
     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: (activity: ActivityStoredAbstract) => void, props: ActivityProps);
+    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;
@@ -802,19 +899,23 @@ type ITimeStlot = {
  */
 type TimeSettings = {
     /**
-     * Minimum hour of the day (default: 0)
+     * Minimum hour of the day
+     * @default 0
      */
     minDayHours?: number;
     /**
-     * Maximum hour of the day (default: 24)
+     * Maximum hour of the day
+     * @default 24
      */
     maxDayHours?: number;
     /**
-     * Default time spent (default: 1)
+     * Default time spent
+     * @default 1
      */
     defaultTimeSpent?: number;
     /**
-     * Time slots (default: [])
+     * Time slots
+     * @default []
      * @example
      * ```ts
      * [
@@ -826,15 +927,18 @@ type TimeSettings = {
      */
     timeSlots?: ITimeStlot[];
     /**
-     * Week length (default: 7)
+     * Week length
+     * @default 7
      */
     weekLength?: number;
     /**
-     * Weekend start day. For example, if the real life weekend starts on Saturday, then the value should be 6 (default: weekLength - 1)
+     * Weekend start day. For example, if the real life weekend starts on Saturday, then the value should be 6
+     * @default weekLength - 1
      */
     weekendStartDay?: number;
     /**
-     * Week days names (default: [])
+     * Week days names
+     * @default []
      * @example
      * ```ts
      * ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
@@ -848,6 +952,7 @@ declare class TimeManager {
     private static editSettings;
     /**
      * Get time settings
+     * @default {}
      */
     static get settings(): TimeSettings;
     /**
@@ -883,8 +988,9 @@ declare class TimeManager {
     /**
      * Get the current week day name. If the week days names are not defined, then it will return undefined.
      * For example, if the week days names are ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'] and the current day is 10, then the result will be 'Thursday'.
+     * @default ""
      */
-    static get currentDayName(): string | undefined;
+    static get currentDayName(): string;
     /**
      * Get the current TimeManager.timeSlots index.
      * You can use this property to create "Image that changes based on the time period":

package/dist/index.d.ts

@@ -48,62 +48,153 @@ interface ActivityProps {
      */
     icon?: GraphicItemType;
 }
+/**
+ * The function that is called when the activity is runned.
+ */
+type OnRunActivityEvent<T> = (activity: T, yourParams?: {
+    [key: string]: any;
+}) => void;
 declare abstract class ActivityStoredAbstract {
-    constructor(onRun: (activity: ActivityStoredAbstract) => void, props: ActivityProps);
+    /**
+     * @param onRun The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function.
+     * @param props The activity properties.
+     */
+    constructor(onRun: OnRunActivityEvent<ActivityStoredAbstract>, props: ActivityProps);
     abstract setStorageProperty<T>(propertyName: string, value: T | undefined): void;
     abstract getStorageProperty<T>(propertyName: string): T | undefined;
     abstract get id(): string;
     private defaultName?;
+    /**
+     * The name
+     */
     get name(): string;
     set name(value: string | undefined);
     private defaultFromHour?;
+    /**
+     * The hour when the activity starts. If the activity is not started yet, it will be hidden.
+     */
     get fromHour(): number;
     set fromHour(value: number | undefined);
     private defaultToHour?;
+    /**
+     * The hour when the activity ends. If the activity is ended yet, it will be hidden.
+     */
     get toHour(): number;
     set toHour(value: number | undefined);
     private defaultFromDay?;
+    /**
+     * The day when the activity starts. If the activity is not started yet, it will be hidden.
+     */
     get fromDay(): number | undefined;
     set fromDay(value: number | undefined);
     private defaultToDay?;
+    /**
+     * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
+     */
     get toDay(): number | undefined;
     set toDay(value: number | undefined);
     private defaultDisabled;
+    /**
+     * Whether is disabled.
+     */
     get disabled(): boolean;
     set disabled(value: boolean | string);
     private defaultHidden;
+    /**
+     * Whether is hidden. If the activity is not started yet, it will be hidden.
+     */
     get hidden(): boolean;
     set hidden(value: boolean | string);
     private _icon?;
+    /**
+     * The icon element.
+     */
     get icon(): GraphicItemType | undefined;
     private _onRun;
+    /**
+     * The function that is called when the activity is runned.
+     */
     get onRun(): () => void;
+    /**
+     * Whether the activity is a deadline.
+     * @returns Whether the activity is a deadline.
+     */
     isExpired(): boolean;
+    /**
+     * Export the activity properties.
+     * @returns The activity properties.
+     */
     export(): ActivityProps;
 }
+/**
+ * The activity model.
+ */
 declare class ActivityModel {
-    constructor(id: string, onRun: (activity: ActivityModel) => void, props: ActivityProps);
+    /**
+     * @param id The activity id, that must be unique.
+     * @param onRun The function that is called when the activity is runned. Have 2 parameters: the runned activity and the yourParams object, that is an object with the parameters that you want to pass to the onRun function.
+     * @param props The activity properties.
+     */
+    constructor(id: string, onRun: OnRunActivityEvent<ActivityModel>, props: ActivityProps);
     private _id;
+    /**
+     * The activity id, that is unique.
+     */
     get id(): string;
     private _name?;
+    /**
+     * The name
+     */
     get name(): string | undefined;
     private _fromHour?;
+    /**
+     * The hour when the activity starts. If the activity is not started yet, it will be hidden.
+     */
     get fromHour(): number | undefined;
     private _toHour?;
+    /**
+     * The hour when the activity ends. If the activity is ended yet, it will be hidden.
+     */
     get toHour(): number | undefined;
     private _fromDay?;
+    /**
+     * The day when the activity starts. If the activity is not started yet, it will be hidden.
+     */
     get fromDay(): number | undefined;
     private _toDay?;
+    /**
+     * The day when the activity ends. If the activity is ended yet, it will be deleted or hidden.
+     */
     get toDay(): number | undefined;
     private _disabled?;
+    /**
+     * Whether is disabled.
+     */
     get disabled(): boolean | undefined;
     private _hidden;
+    /**
+     * Whether is hidden. If the activity is not started yet, it will be hidden.
+     */
     get hidden(): boolean;
     private _icon?;
+    /**
+     * The icon element.
+     */
     get icon(): GraphicItemType | undefined;
     private _onRun;
+    /**
+     * The function that is called when the activity is runned.
+     */
     get onRun(): () => void;
+    /**
+     * Whether the activity is a deadline.
+     * @returns Whether the activity is a deadline.
+     */
     isDeadline(): boolean;
+    /**
+     * Export the activity properties.
+     * @returns The activity properties.
+     */
     export(): ActivityProps;
 }
 
@@ -138,16 +229,16 @@ interface MapBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
      * @example
      * ```ts
      * {
-     *    "north": atlantaMap,
-     *    "south": miamiMap,
-     *    "east": savannahMap,
-     *    "west": birminghamMap
+     *    "north": "atlanta_map_id",
+     *    "south": "miami_map_id",
+     *    "east": "new_york_map_id",
+     *    "west": "los_angeles_map_id"
      * }
      * ```
      * @default {}
      */
     neighboringMaps?: {
-        [key: string]: TMap;
+        [key: string]: string;
     };
     /**
      * Whether is disabled. You can also pass a Pixi'VN flag name.
@@ -225,12 +316,18 @@ declare class MapBaseModel extends StoredClassModel {
     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: (activity: ActivityStoredAbstract) => void, props: ActivityProps);
+    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;
@@ -802,19 +899,23 @@ type ITimeStlot = {
  */
 type TimeSettings = {
     /**
-     * Minimum hour of the day (default: 0)
+     * Minimum hour of the day
+     * @default 0
      */
     minDayHours?: number;
     /**
-     * Maximum hour of the day (default: 24)
+     * Maximum hour of the day
+     * @default 24
      */
     maxDayHours?: number;
     /**
-     * Default time spent (default: 1)
+     * Default time spent
+     * @default 1
      */
     defaultTimeSpent?: number;
     /**
-     * Time slots (default: [])
+     * Time slots
+     * @default []
      * @example
      * ```ts
      * [
@@ -826,15 +927,18 @@ type TimeSettings = {
      */
     timeSlots?: ITimeStlot[];
     /**
-     * Week length (default: 7)
+     * Week length
+     * @default 7
      */
     weekLength?: number;
     /**
-     * Weekend start day. For example, if the real life weekend starts on Saturday, then the value should be 6 (default: weekLength - 1)
+     * Weekend start day. For example, if the real life weekend starts on Saturday, then the value should be 6
+     * @default weekLength - 1
      */
     weekendStartDay?: number;
     /**
-     * Week days names (default: [])
+     * Week days names
+     * @default []
      * @example
      * ```ts
      * ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday']
@@ -848,6 +952,7 @@ declare class TimeManager {
     private static editSettings;
     /**
      * Get time settings
+     * @default {}
      */
     static get settings(): TimeSettings;
     /**
@@ -883,8 +988,9 @@ declare class TimeManager {
     /**
      * Get the current week day name. If the week days names are not defined, then it will return undefined.
      * For example, if the week days names are ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday'] and the current day is 10, then the result will be 'Thursday'.
+     * @default ""
      */
-    static get currentDayName(): string | undefined;
+    static get currentDayName(): string;
     /**
      * Get the current TimeManager.timeSlots index.
      * You can use this property to create "Image that changes based on the time period":