@drincs/pixi-vn 0.3.3 → 0.3.4

package/dist/index.d.mts

@@ -82,11 +82,29 @@ declare class StoredClassModel {
     getStorageProperty<T>(propertyName: string): T | undefined;
 }
 
+/**
+ * CharacterBaseModelProps is an interface that is used to create a character model.
+ */
 interface CharacterBaseModelProps {
+    /**
+     * The name of the character.
+     */
     name: string;
+    /**
+     * The surname of the character.
+     */
     surname?: string;
+    /**
+     * The age of the character.
+     */
     age?: number;
+    /**
+     * The icon of the character.
+     */
     icon?: string;
+    /**
+     * The color of the character.
+     */
     color?: string;
 }
 /**
@@ -113,19 +131,41 @@ interface CharacterBaseModelProps {
  * ```
  */
 declare class CharacterBaseModel extends StoredClassModel implements CharacterBaseModelProps {
+    /**
+     * @param id The id of the character.
+     * @param props The properties of the character.
+     */
     constructor(id: string, props: CharacterBaseModelProps);
     private defaultName;
+    /***
+     * The name of the character.
+     * If you set undefined, it will return the default name.
+     */
     get name(): string;
-    set name(value: string);
+    set name(value: string | undefined);
     private defaultSurname?;
+    /**
+     * The surname of the character.
+     * If you set undefined, it will return the default surname.
+     */
     get surname(): string | undefined;
     set surname(value: string | undefined);
     private defaultAge?;
+    /**
+     * The age of the character.
+     * If you set undefined, it will return the default age.
+     */
     get age(): number | undefined;
     set age(value: number | undefined);
     private _icon?;
+    /**
+     * The icon of the character.
+     */
     get icon(): string | undefined;
     private _color?;
+    /**
+     * The color of the character.
+     */
     get color(): string | undefined;
 }
 
@@ -229,24 +269,43 @@ interface IStoratedChoiceMenuOptionLabel {
 }
 
 /**
- * Base class for all dialogue models. I suggest you extend this class to create your own dialogue models.
+ * Munu is a type that contains a list of Label that a player can choose from.
+ * For Ren'py this is the equivalent of a menu.
+ */
+type ChoiceMenuOptionsType = ChoiceMenuOptionLabel[];
+
+declare const PauseValueType = "Pause";
+type PauseType = {
+    type: typeof PauseValueType;
+    duration: number;
+};
+declare function Pause(duration: number): PauseType;
+
+type RepeatType = "Repeat";
+declare const Repeat: RepeatType;
+
+/**
+ * StorageElementType are all the types that can be stored in the storage
+ */
+type StorageElementType = string | number | boolean | object | undefined | null;
+
+/**
+ * Base class for all dialogue models.
+ * You can extend this class, but it is not reccomended. You can use the oltherParams property to store any other data you need.
  * @example
  * ```typescript
- * export class DialogueModel extends DialogueBaseModel {
- *     constructor(
- *         character: CharacterBaseModel | string,
- *         text: string,
- *         emotion: string
- *     ) {
- *         super(character, text);
- *         this.emotion = emotion;
- *     }
- *     emotion = ""
- * }
+ * setDialogue(new DialogueBaseModel("Hello World", character))
  * ```
  */
 declare class DialogueBaseModel<TCharacter extends CharacterBaseModel = CharacterBaseModel> {
-    constructor(text: string, character: string | TCharacter | undefined);
+    /**
+     * @param text The text of the dialogue.
+     * @param character The id of the character that is speaking.
+     * @param oltherParams Other parameters that can be stored in the dialogue.
+     */
+    constructor(text: string, character: string | TCharacter | undefined, oltherParams?: {
+        [key: string]: StorageElementType;
+    });
     /**
      * The text of the dialogue.
      */
@@ -255,6 +314,12 @@ declare class DialogueBaseModel<TCharacter extends CharacterBaseModel = Characte
      * The id of the character that is speaking.
      */
     characterId?: string;
+    /**
+     * Other parameters that can be stored in the dialogue.
+     */
+    oltherParams: {
+        [key: string]: StorageElementType;
+    };
 }
 
 /**
@@ -552,11 +617,6 @@ interface ITicker<TArgs extends TickerArgsType> {
     priority?: UPDATE_PRIORITY;
 }
 
-/**
- * StorageElementType are all the types that can be stored in the storage
- */
-type StorageElementType = string | number | boolean | object | undefined | null;
-
 type TickerArgsType = {
     [id: string]: StorageElementType;
 };
@@ -592,6 +652,11 @@ type TickerArgsType = {
  * ```
  */
 declare class TickerBase<TArgs extends TickerArgsType> implements ITicker<TArgs> {
+    /**
+     * @param args The arguments that you want to pass to the ticker.
+     * @param duration The duration of the ticker. If is undefined, the ticker will be called every frame.
+     * @param priority The priority of the ticker. If is undefined, the priority will be UPDATE_PRIORITY.NORMAL.
+     */
     constructor(args: TArgs, duration?: number, priority?: UPDATE_PRIORITY);
     args: TArgs;
     duration?: number;
@@ -907,16 +972,6 @@ interface ISaveData {
     path: string;
 }
 
-declare const PauseValueType = "Pause";
-type PauseType = {
-    type: typeof PauseValueType;
-    duration: number;
-};
-declare function Pause(duration: number): PauseType;
-
-type RepeatType = "Repeat";
-declare const Repeat: RepeatType;
-
 interface ITickersStep<TArgs extends TickerArgsType> extends ITicker<TArgs> {
     /**
      * Ticker class name
@@ -941,12 +996,6 @@ interface ITickersSteps {
     steps: (ITickersStep<any> | RepeatType | PauseType)[];
 }
 
-/**
- * Munu is a type that contains a list of Label that a player can choose from.
- * For Ren'py this is the equivalent of a menu.
- */
-type ChoiceMenuOptionsType = ChoiceMenuOptionLabel[];
-
 /**
  * Set the dialogue to be shown in the game
  * @param text Text of the dialogue

package/dist/index.d.ts

@@ -82,11 +82,29 @@ declare class StoredClassModel {
     getStorageProperty<T>(propertyName: string): T | undefined;
 }
 
+/**
+ * CharacterBaseModelProps is an interface that is used to create a character model.
+ */
 interface CharacterBaseModelProps {
+    /**
+     * The name of the character.
+     */
     name: string;
+    /**
+     * The surname of the character.
+     */
     surname?: string;
+    /**
+     * The age of the character.
+     */
     age?: number;
+    /**
+     * The icon of the character.
+     */
     icon?: string;
+    /**
+     * The color of the character.
+     */
     color?: string;
 }
 /**
@@ -113,19 +131,41 @@ interface CharacterBaseModelProps {
  * ```
  */
 declare class CharacterBaseModel extends StoredClassModel implements CharacterBaseModelProps {
+    /**
+     * @param id The id of the character.
+     * @param props The properties of the character.
+     */
     constructor(id: string, props: CharacterBaseModelProps);
     private defaultName;
+    /***
+     * The name of the character.
+     * If you set undefined, it will return the default name.
+     */
     get name(): string;
-    set name(value: string);
+    set name(value: string | undefined);
     private defaultSurname?;
+    /**
+     * The surname of the character.
+     * If you set undefined, it will return the default surname.
+     */
     get surname(): string | undefined;
     set surname(value: string | undefined);
     private defaultAge?;
+    /**
+     * The age of the character.
+     * If you set undefined, it will return the default age.
+     */
     get age(): number | undefined;
     set age(value: number | undefined);
     private _icon?;
+    /**
+     * The icon of the character.
+     */
     get icon(): string | undefined;
     private _color?;
+    /**
+     * The color of the character.
+     */
     get color(): string | undefined;
 }
 
@@ -229,24 +269,43 @@ interface IStoratedChoiceMenuOptionLabel {
 }
 
 /**
- * Base class for all dialogue models. I suggest you extend this class to create your own dialogue models.
+ * Munu is a type that contains a list of Label that a player can choose from.
+ * For Ren'py this is the equivalent of a menu.
+ */
+type ChoiceMenuOptionsType = ChoiceMenuOptionLabel[];
+
+declare const PauseValueType = "Pause";
+type PauseType = {
+    type: typeof PauseValueType;
+    duration: number;
+};
+declare function Pause(duration: number): PauseType;
+
+type RepeatType = "Repeat";
+declare const Repeat: RepeatType;
+
+/**
+ * StorageElementType are all the types that can be stored in the storage
+ */
+type StorageElementType = string | number | boolean | object | undefined | null;
+
+/**
+ * Base class for all dialogue models.
+ * You can extend this class, but it is not reccomended. You can use the oltherParams property to store any other data you need.
  * @example
  * ```typescript
- * export class DialogueModel extends DialogueBaseModel {
- *     constructor(
- *         character: CharacterBaseModel | string,
- *         text: string,
- *         emotion: string
- *     ) {
- *         super(character, text);
- *         this.emotion = emotion;
- *     }
- *     emotion = ""
- * }
+ * setDialogue(new DialogueBaseModel("Hello World", character))
  * ```
  */
 declare class DialogueBaseModel<TCharacter extends CharacterBaseModel = CharacterBaseModel> {
-    constructor(text: string, character: string | TCharacter | undefined);
+    /**
+     * @param text The text of the dialogue.
+     * @param character The id of the character that is speaking.
+     * @param oltherParams Other parameters that can be stored in the dialogue.
+     */
+    constructor(text: string, character: string | TCharacter | undefined, oltherParams?: {
+        [key: string]: StorageElementType;
+    });
     /**
      * The text of the dialogue.
      */
@@ -255,6 +314,12 @@ declare class DialogueBaseModel<TCharacter extends CharacterBaseModel = Characte
      * The id of the character that is speaking.
      */
     characterId?: string;
+    /**
+     * Other parameters that can be stored in the dialogue.
+     */
+    oltherParams: {
+        [key: string]: StorageElementType;
+    };
 }
 
 /**
@@ -552,11 +617,6 @@ interface ITicker<TArgs extends TickerArgsType> {
     priority?: UPDATE_PRIORITY;
 }
 
-/**
- * StorageElementType are all the types that can be stored in the storage
- */
-type StorageElementType = string | number | boolean | object | undefined | null;
-
 type TickerArgsType = {
     [id: string]: StorageElementType;
 };
@@ -592,6 +652,11 @@ type TickerArgsType = {
  * ```
  */
 declare class TickerBase<TArgs extends TickerArgsType> implements ITicker<TArgs> {
+    /**
+     * @param args The arguments that you want to pass to the ticker.
+     * @param duration The duration of the ticker. If is undefined, the ticker will be called every frame.
+     * @param priority The priority of the ticker. If is undefined, the priority will be UPDATE_PRIORITY.NORMAL.
+     */
     constructor(args: TArgs, duration?: number, priority?: UPDATE_PRIORITY);
     args: TArgs;
     duration?: number;
@@ -907,16 +972,6 @@ interface ISaveData {
     path: string;
 }
 
-declare const PauseValueType = "Pause";
-type PauseType = {
-    type: typeof PauseValueType;
-    duration: number;
-};
-declare function Pause(duration: number): PauseType;
-
-type RepeatType = "Repeat";
-declare const Repeat: RepeatType;
-
 interface ITickersStep<TArgs extends TickerArgsType> extends ITicker<TArgs> {
     /**
      * Ticker class name
@@ -941,12 +996,6 @@ interface ITickersSteps {
     steps: (ITickersStep<any> | RepeatType | PauseType)[];
 }
 
-/**
- * Munu is a type that contains a list of Label that a player can choose from.
- * For Ren'py this is the equivalent of a menu.
- */
-type ChoiceMenuOptionsType = ChoiceMenuOptionLabel[];
-
 /**
  * Set the dialogue to be shown in the game
  * @param text Text of the dialogue

package/dist/index.js

@@ -802,6 +802,11 @@ function setMemoryText(element, memory) {
 
 // src/classes/ticker/TickerBase.ts
 var TickerBase = class {
+  /**
+   * @param args The arguments that you want to pass to the ticker.
+   * @param duration The duration of the ticker. If is undefined, the ticker will be called every frame.
+   * @param priority The priority of the ticker. If is undefined, the priority will be UPDATE_PRIORITY.NORMAL.
+   */
   constructor(args, duration, priority) {
     this.args = args;
     this.duration = duration;
@@ -2377,6 +2382,10 @@ var StoredClassModel = class {
 
 // src/classes/CharacterBaseModel.ts
 var CharacterBaseModel2 = class extends StoredClassModel {
+  /**
+   * @param id The id of the character.
+   * @param props The properties of the character.
+   */
   constructor(id, props) {
     super(GameStorageManager.keysSystem.CHARACTER_CATEGORY_KEY, id);
     this.defaultName = "";
@@ -2386,27 +2395,45 @@ var CharacterBaseModel2 = class extends StoredClassModel {
     this._icon = props.icon;
     this._color = props.color;
   }
+  /***
+   * The name of the character.
+   * If you set undefined, it will return the default name.
+   */
   get name() {
     return this.getStorageProperty("name") || this.defaultName;
   }
   set name(value) {
     this.setStorageProperty("name", value);
   }
+  /**
+   * The surname of the character.
+   * If you set undefined, it will return the default surname.
+   */
   get surname() {
     return this.getStorageProperty("surname") || this.defaultSurname;
   }
   set surname(value) {
     this.setStorageProperty("surname", value);
   }
+  /**
+   * The age of the character.
+   * If you set undefined, it will return the default age.
+   */
   get age() {
     return this.getStorageProperty("age") || this.defaultAge;
   }
   set age(value) {
     this.setStorageProperty("age", value);
   }
+  /**
+   * The icon of the character.
+   */
   get icon() {
     return this._icon;
   }
+  /**
+   * The color of the character.
+   */
   get color() {
     return this._color;
   }
@@ -2435,17 +2462,27 @@ var ChoiceMenuOptionLabel = class {
 
 // src/classes/DialogueBaseModel.ts
 var DialogueBaseModel = class {
-  constructor(text, character) {
+  /**
+   * @param text The text of the dialogue.
+   * @param character The id of the character that is speaking. 
+   * @param oltherParams Other parameters that can be stored in the dialogue.
+   */
+  constructor(text, character, oltherParams = {}) {
     /**
      * The text of the dialogue.
      */
     this.text = "";
+    /**
+     * Other parameters that can be stored in the dialogue.
+     */
+    this.oltherParams = {};
     this.text = text;
     if (typeof character === "string") {
       this.characterId = character;
     } else {
       this.characterId = character == null ? void 0 : character.id;
     }
+    this.oltherParams = oltherParams;
   }
 };