@drincs/nqtr 0.1.5 → 0.1.7

package/dist/{index-Ci6Aw7YE.d.ts → index-D_4poX-_.d.ts}

@@ -1,9 +1,10 @@
 import ActivityModel, { ActivityStoredAbstract, OnRunActivityEvent, ActivityProps } from './classes/Activity.js';
 import { StoredClassModel, CharacterBaseModel } from '@drincs/pixi-vn';
 import { ExecutionTypeEnum } from './enums/ExecutionTypeEnum.js';
-import { GraphicItemType } from './types/GraphicItem.js';
+import GraphicItemType from './override/GraphicItemType.js';
+import OnRenderGraphicItemProps from './override/OnRenderGraphicItemProps.js';
 
-interface MapBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
+interface MapBaseModelProps {
     /**
      * The name
      * @default ""
@@ -23,7 +24,7 @@ interface MapBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
      * ```
      * @default undefined
      */
-    image?: GraphicItemType | Record<any, GraphicItemType> | object;
+    renderImage?: GraphicItemType | ((map: MapBaseModel, props?: OnRenderGraphicItemProps) => GraphicItemType);
     /**
      * The neighboring maps that are available in this map.
      * @example
@@ -80,13 +81,11 @@ declare class MapBaseModel extends StoredClassModel {
      */
     get name(): string;
     set name(value: string | undefined);
-    private defaultImage?;
+    private _renderImage?;
     /**
-     * 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.
+     * The function for rendering the image of the map.
      */
-    get image(): GraphicItemType | Record<any, GraphicItemType> | object | undefined;
-    set image(value: GraphicItemType | Record<any, GraphicItemType> | object | undefined);
+    get renderImage(): ((props?: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
     private defaultDisabled;
     /**
      * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
@@ -143,7 +142,7 @@ declare class ActivityRoom<TRoom extends RoomBaseModel = RoomBaseModel> extends
 }
 
 declare const ROOM_CATEGORY = "__nqtr-room__";
-interface RoomBaseModelProps {
+interface RoomBaseModelProps<TLocation extends LocationBaseModel = LocationBaseModel> {
     /**
      * The name
      * @default ""
@@ -163,7 +162,7 @@ interface RoomBaseModelProps {
      * ```
      * @default undefined
      */
-    image?: GraphicItemType | Record<any, GraphicItemType> | object;
+    renderImage?: GraphicItemType | ((room: RoomBaseModel<TLocation>, props?: OnRenderGraphicItemProps) => GraphicItemType);
     /**
      * The activities that are available in this room.
      * @default []
@@ -183,7 +182,7 @@ interface RoomBaseModelProps {
      * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
      * @default undefined
      */
-    icon?: GraphicItemType;
+    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
@@ -210,7 +209,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);
+    constructor(id: string, location: TLocation, props?: RoomBaseModelProps<TLocation>);
     private _location;
     /**
      * The location where the room is.
@@ -228,13 +227,11 @@ declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseMo
      */
     get name(): string;
     set name(value: string | undefined);
-    private defaultImage?;
+    private _renderImage?;
     /**
-     * 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.
+     * The function for rendering the image of the room.
      */
-    get image(): GraphicItemType | Record<any, GraphicItemType> | object | undefined;
-    set image(value: GraphicItemType | Record<any, GraphicItemType> | object | undefined);
+    get renderImage(): ((props?: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
     private defaultActivityIds;
     /**
      * The activities that are available in this room.
@@ -289,11 +286,11 @@ declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseMo
      */
     get hidden(): boolean;
     set hidden(value: boolean | string);
+    private _renderIcon?;
     /**
-     * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
+     * The function for rendering the icon of the room.
      */
-    private _icon?;
-    get icon(): GraphicItemType | undefined;
+    get renderIcon(): ((props?: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
     /**
      * Get the character commitments of the room.
      * @returns The character commitments of the room.
@@ -301,7 +298,7 @@ declare class RoomBaseModel<TLocation extends LocationBaseModel = LocationBaseMo
     getRoutine<TCommitment extends CommitmentBaseModel = CommitmentBaseModel>(): TCommitment[];
 }
 
-interface LocationBaseModelProps {
+interface LocationBaseModelProps<TMap extends MapBaseModel = MapBaseModel> {
     /**
      * The name
      * @default ""
@@ -321,7 +318,7 @@ interface LocationBaseModelProps {
      * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
      * @default undefined
      */
-    icon?: GraphicItemType;
+    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.
@@ -339,7 +336,7 @@ declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extend
      * @param map The map where the location is.
      * @param props The properties of the location.
      */
-    constructor(id: string, map: TMap, props?: LocationBaseModelProps);
+    constructor(id: string, map: TMap, props?: LocationBaseModelProps<TMap>);
     private defaultName;
     /**
      * The name of the location.
@@ -359,11 +356,11 @@ declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extend
      */
     get hidden(): boolean;
     set hidden(value: boolean | string);
-    private _icon?;
+    private _renderIcon?;
     /**
-     * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
+     * The function for rendering the icon of the location.
      */
-    get icon(): GraphicItemType | undefined;
+    get renderIcon(): ((props?: OnRenderGraphicItemProps) => GraphicItemType) | undefined;
     private _map;
     /**
      * The map where the location is.
@@ -391,7 +388,7 @@ declare class LocationBaseModel<TMap extends MapBaseModel = MapBaseModel> extend
     getRooms<TRoom extends RoomBaseModel = RoomBaseModel>(): TRoom[];
 }
 
-interface CommitmentBaseModelProps {
+interface CommitmentBaseModelProps<TCharacter extends CharacterBaseModel = CharacterBaseModel, TRoom extends RoomBaseModel = RoomBaseModel> {
     /**
      * The name
      * @default ""
@@ -435,7 +432,7 @@ interface CommitmentBaseModelProps {
      * ```
      * @default undefined
      */
-    image?: GraphicItemType | Record<any, GraphicItemType> | object;
+    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
@@ -483,7 +480,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);
+    constructor(id: string, character: TCharacter | TCharacter[] | undefined, room: TRoom, props: CommitmentBaseModelProps<TCharacter, TRoom>);
     private _characters;
     /**
      * The character or characters that are in the commitment and so in the room.
@@ -498,7 +495,7 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
     /**
      * The name
      */
-    get name(): GraphicItemType;
+    get name(): string;
     private defaultFromHour?;
     /**
      * The hour when the commitment starts. If the commitment is not started yet, it will be hidden.
@@ -527,11 +524,11 @@ declare class CommitmentBaseModel<TCharacter extends CharacterBaseModel = Charac
      */
     get toDay(): number | undefined;
     set toDay(value: number | undefined);
-    private _image?;
+    private _renderImage?;
     /**
-     * The image. It can be a string, an Element or a Pixi'VN Canvas Item.
+     * The function for rendering the image of the room.
      */
-    get image(): GraphicItemType | Record<any, GraphicItemType> | object | 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.

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 export { default as ActivityModel, ActivityProps } from './classes/Activity.mjs';
-export { C as CommitmentBaseModel, a as CommitmentBaseModelProps, L as LocationBaseModel, b as LocationBaseModelProps, M as MapBaseModel, c as MapBaseModelProps, R as RoomBaseModel, d as RoomBaseModelProps } from './index-BvCfRbJB.mjs';
+export { C as CommitmentBaseModel, a as CommitmentBaseModelProps, L as LocationBaseModel, b as LocationBaseModelProps, M as MapBaseModel, c as MapBaseModelProps, R as RoomBaseModel, d as RoomBaseModelProps } from './index-CwqgrVp6.mjs';
 export { default as Goal, GoalProps } from './classes/quest/Goal.mjs';
 export { Q as QuestBaseModel, a as QuestBaseModelProps, c as QuestsRequiredType, S as StageBaseModel, b as StageBaseModelProps } from './index-gJ26gdgL.mjs';
 export { getActivityById, saveActivity } from './decorators/ActivityDecorator.mjs';
@@ -12,5 +12,6 @@ export { clearExpiredRoutine, getCommitmentByCharacter, getCurrentCommitments }
 export { default as TimeManager } from './managers/TimeManager.mjs';
 export { ITimeStlot, TimeSettings } from './types/TimeSettings.mjs';
 import '@drincs/nqtr/dist/override';
-import './types/GraphicItem.mjs';
+import './override/GraphicItemType.mjs';
 import '@drincs/pixi-vn';
+import './override/OnRenderGraphicItemProps.mjs';

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { default as ActivityModel, ActivityProps } from './classes/Activity.js';
-export { C as CommitmentBaseModel, a as CommitmentBaseModelProps, L as LocationBaseModel, b as LocationBaseModelProps, M as MapBaseModel, c as MapBaseModelProps, R as RoomBaseModel, d as RoomBaseModelProps } from './index-Ci6Aw7YE.js';
+export { C as CommitmentBaseModel, a as CommitmentBaseModelProps, L as LocationBaseModel, b as LocationBaseModelProps, M as MapBaseModel, c as MapBaseModelProps, R as RoomBaseModel, d as RoomBaseModelProps } from './index-D_4poX-_.js';
 export { default as Goal, GoalProps } from './classes/quest/Goal.js';
 export { Q as QuestBaseModel, a as QuestBaseModelProps, c as QuestsRequiredType, S as StageBaseModel, b as StageBaseModelProps } from './index-BjOzVDyw.js';
 export { getActivityById, saveActivity } from './decorators/ActivityDecorator.js';
@@ -12,5 +12,6 @@ export { clearExpiredRoutine, getCommitmentByCharacter, getCurrentCommitments }
 export { default as TimeManager } from './managers/TimeManager.js';
 export { ITimeStlot, TimeSettings } from './types/TimeSettings.js';
 import '@drincs/nqtr/dist/override';
-import './types/GraphicItem.js';
+import './override/GraphicItemType.js';
 import '@drincs/pixi-vn';
+import './override/OnRenderGraphicItemProps.js';

package/dist/index.js

@@ -275,8 +275,8 @@ var ActivityStoredAbstract = class {
     this.defaultToDay = props.toDay;
     this.defaultDisabled = props.disabled || false;
     this.defaultHidden = props.hidden || false;
-    this._icon = props.icon;
-    this._onRun = onRun;
+    this._renderIcon = props.renderIcon;
+    this._onRun = (props2) => onRun(this, props2);
   }
   /**
    * The name
@@ -359,10 +359,17 @@ var ActivityStoredAbstract = class {
     this.setStorageProperty("hidden", value);
   }
   /**
-   * The icon element.
+   * The function for rendering the icon of the activity.
    */
-  get icon() {
-    return this._icon;
+  get renderIcon() {
+    if (typeof this._renderIcon !== "function") {
+      return (props) => this._renderIcon;
+    }
+    if (this._renderIcon !== void 0) {
+      return (props) => {
+        return this._renderIcon(this, props);
+      };
+    }
   }
   /**
    * The function that is called when the activity is runned.
@@ -393,7 +400,7 @@ var ActivityStoredAbstract = class {
       toDay: this.getStorageProperty("toDay") || this.defaultToDay,
       disabled: this.getStorageProperty("disabled") || this.defaultDisabled,
       hidden: this.getStorageProperty("hidden") || this.defaultHidden,
-      icon: this._icon
+      renderIcon: this._renderIcon
     };
   }
 };
@@ -412,8 +419,8 @@ var ActivityModel = class {
     this._toDay = props.toDay;
     this._disabled = props.disabled || false;
     this._hidden = props.hidden || false;
-    this._icon = props.icon;
-    this._onRun = onRun;
+    this._renderIcon = props.renderIcon;
+    this._onRun = (props2) => onRun(this, props2);
   }
   /**
    * The activity id, that is unique.
@@ -476,16 +483,23 @@ var ActivityModel = class {
     return this._hidden;
   }
   /**
-   * The icon element.
+   * The function for rendering the icon of the activity.
    */
-  get icon() {
-    return this._icon;
+  get renderIcon() {
+    if (typeof this._renderIcon !== "function") {
+      return (props) => this._renderIcon;
+    }
+    if (this._renderIcon !== void 0) {
+      return (props) => {
+        return this._renderIcon(this, props);
+      };
+    }
   }
   /**
    * The function that is called when the activity is runned.
    */
   get onRun() {
-    return () => this._onRun(this);
+    return (props) => this._onRun(this, props);
   }
   /**
    * Whether the activity is a deadline.
@@ -510,7 +524,7 @@ var ActivityModel = class {
       toDay: this._toDay,
       disabled: this._disabled,
       hidden: this._hidden,
-      icon: this._icon
+      renderIcon: this._renderIcon
     };
   }
 };
@@ -540,7 +554,7 @@ var CommitmentBaseModel = class extends pixiVn.StoredClassModel {
     this.defaultToHour = props.toHour;
     this.defaultFromDay = props.fromDay;
     this.defaultToDay = props.toDay;
-    this._image = props.image;
+    this._renderImage = props.renderImage;
     this._executionType = props.executionType || "interaction" /* INTERACTION */;
     this._onRun = props.onRun;
     this.defaultDisabled = props.disabled || false;
@@ -605,10 +619,17 @@ var CommitmentBaseModel = class extends pixiVn.StoredClassModel {
     this.setStorageProperty("toDay", value);
   }
   /**
-   * The image. It can be a string, an Element or a Pixi'VN Canvas Item.
+   * The function for rendering the image of the room.
    */
-  get image() {
-    return this._image;
+  get renderImage() {
+    if (typeof this._renderImage !== "function") {
+      return (props) => this._renderImage;
+    }
+    if (this.renderImage !== void 0) {
+      return (props) => {
+        return this.renderImage(this, props);
+      };
+    }
   }
   /**
    * 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.
@@ -732,7 +753,7 @@ var LocationBaseModel = class extends pixiVn.StoredClassModel {
     this.defaultName = props.name || "";
     this.defaultDisabled = props.disabled || false;
     this.defaultHidden = props.hidden || false;
-    this._icon = props.icon;
+    this._renderIcon = props.renderIcon;
     this._map = map;
   }
   /**
@@ -772,10 +793,17 @@ var LocationBaseModel = class extends pixiVn.StoredClassModel {
     this.setStorageProperty("hidden", value);
   }
   /**
-   * The icon element. Can be a string or an Element or a Pixi'VN CanvasItem
+   * The function for rendering the icon of the location.
    */
-  get icon() {
-    return this._icon;
+  get renderIcon() {
+    if (typeof this._renderIcon !== "function") {
+      return (props) => this._renderIcon;
+    }
+    if (this._renderIcon !== void 0) {
+      return (props) => {
+        return this._renderIcon(this, props);
+      };
+    }
   }
   /**
    * The map where the location is.
@@ -822,7 +850,7 @@ var MapBaseModel = class extends pixiVn.StoredClassModel {
   constructor(id, props = {}) {
     super(MAP_CATEGORY, id);
     this.defaultName = props.name || "";
-    this.defaultImage = props.image;
+    this._renderImage = props.renderImage;
     this.defaultDisabled = props.disabled || false;
     this.defaultHidden = props.hidden || false;
   }
@@ -837,14 +865,17 @@ var MapBaseModel = class extends pixiVn.StoredClassModel {
     this.setStorageProperty("name", value);
   }
   /**
-   * 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.
+   * The function for rendering the image of the map.
    */
-  get image() {
-    return this.getStorageProperty("image") || this.defaultImage;
-  }
-  set image(value) {
-    this.setStorageProperty("image", value);
+  get renderImage() {
+    if (typeof this._renderImage !== "function") {
+      return (props) => this._renderImage;
+    }
+    if (this.renderImage !== void 0) {
+      return (props) => {
+        return this.renderImage(this, props);
+      };
+    }
   }
   /**
    * Whether is disabled. If it is a string, it is a Pixi'VN flag name.
@@ -1095,11 +1126,11 @@ var RoomBaseModel = class extends pixiVn.StoredClassModel {
     super(ROOM_CATEGORY, id);
     this._location = location;
     this.defaultName = props.name || "";
-    this.defaultImage = props.image;
+    this._renderImage = props.renderImage;
     this.defaultActivityIds = ((_a = props.defaultActivities) == null ? void 0 : _a.map((activity) => activity.id)) || [];
     this.defaultDisabled = props.disabled || false;
     this.defaultHidden = props.hidden || false;
-    this._icon = props.icon;
+    this._renderIcon = props.renderIcon;
     this._isEntrance = props.isEntrance;
   }
   /**
@@ -1125,14 +1156,17 @@ var RoomBaseModel = class extends pixiVn.StoredClassModel {
     this.setStorageProperty("name", value);
   }
   /**
-   * 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.
+   * The function for rendering the image of the room.
    */
-  get image() {
-    return this.getStorageProperty("image") || this.defaultImage;
-  }
-  set image(value) {
-    this.setStorageProperty("image", value);
+  get renderImage() {
+    if (typeof this._renderImage !== "function") {
+      return (props) => this._renderImage;
+    }
+    if (this.renderImage !== void 0) {
+      return (props) => {
+        return this.renderImage(this, props);
+      };
+    }
   }
   /**
    * The activities that are available in this room.
@@ -1289,8 +1323,18 @@ var RoomBaseModel = class extends pixiVn.StoredClassModel {
   set hidden(value) {
     this.setStorageProperty("hidden", value);
   }
-  get icon() {
-    return this._icon;
+  /**
+   * The function for rendering the icon of the room.
+   */
+  get renderIcon() {
+    if (typeof this._renderIcon !== "function") {
+      return (props) => this._renderIcon;
+    }
+    if (this._renderIcon !== void 0) {
+      return (props) => {
+        return this._renderIcon(this, props);
+      };
+    }
   }
   /**
    * Get the character commitments of the room.