@drincs/pixi-vn 0.5.2 → 0.5.4

package/dist/classes/ChoiceMenuOption.d.mts

@@ -3,15 +3,15 @@ import { CloseType } from '../types/CloseType.mjs';
 import LabelRunModeType from '../types/LabelRunModeType.mjs';
 import { StorageObjectType } from '../types/StorageElementType.mjs';
 import { LabelIdType } from '../types/LabelIdType.mjs';
+import '../types/StepHistoryDataType.mjs';
 import '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
-import '../types/StepHistoryDataType.mjs';
 
 /**
  * ChoiceMenuOption is a class that contains a Label and a text that will be displayed in the menu.
  * @example
  * ```typescript
- * new ChoiceMenuOption("Events Test", EventsTestLabel)
+ * new ChoiceMenuOption("Hello", HelloLabel)
  * ```
  */
 declare class ChoiceMenuOption<T extends StorageObjectType> {
@@ -33,11 +33,11 @@ declare class ChoiceMenuOption<T extends StorageObjectType> {
     props: StorageObjectType;
     /**
      * @param text Text to be displayed in the menu
-     * @param label Label to be opened when the option is selected
-     * @param type Type of the label to be opened
-     * @param props Properties to be passed to the label, when the label is called. it cannot contain functions or classes.
+     * @param label Label to be opened when the option is selected or the id of the label
+     * @param type Type of the label to be opened. @default "call"
+     * @param props Properties to be passed to the label, when the label is called. it cannot contain functions or classes. @default {}
      */
-    constructor(text: string, label: typeof Label<T>, type?: LabelRunModeType, props?: T);
+    constructor(text: string, label: Label<T> | LabelIdType, type?: LabelRunModeType, props?: T);
 }
 /**
  * ChoiceMenuOptionClose is a class that contains a text that will be displayed in the menu.
@@ -78,10 +78,22 @@ type IStoratedChoiceMenuOption = {
     text: string;
     type: CloseType;
 };
+/**
+ * HistoryChoiceMenuOption is a type that contains the history information of a choice menu option.
+ */
 type HistoryChoiceMenuOption = {
+    /**
+     * Text to be displayed in the menu
+     */
     text: string;
+    /**
+     * Method used to open the label, or close the menu.
+     */
     type: CloseType | LabelRunModeType;
-    isMadeChoice: boolean;
+    /**
+     * This choice is a response
+     */
+    isResponse: boolean;
 };
 
 export { ChoiceMenuOptionClose, type HistoryChoiceMenuOption, type IStoratedChoiceMenuOption, ChoiceMenuOption as default };

package/dist/classes/ChoiceMenuOption.d.ts

@@ -3,15 +3,15 @@ import { CloseType } from '../types/CloseType.js';
 import LabelRunModeType from '../types/LabelRunModeType.js';
 import { StorageObjectType } from '../types/StorageElementType.js';
 import { LabelIdType } from '../types/LabelIdType.js';
+import '../types/StepHistoryDataType.js';
 import '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
-import '../types/StepHistoryDataType.js';
 
 /**
  * ChoiceMenuOption is a class that contains a Label and a text that will be displayed in the menu.
  * @example
  * ```typescript
- * new ChoiceMenuOption("Events Test", EventsTestLabel)
+ * new ChoiceMenuOption("Hello", HelloLabel)
  * ```
  */
 declare class ChoiceMenuOption<T extends StorageObjectType> {
@@ -33,11 +33,11 @@ declare class ChoiceMenuOption<T extends StorageObjectType> {
     props: StorageObjectType;
     /**
      * @param text Text to be displayed in the menu
-     * @param label Label to be opened when the option is selected
-     * @param type Type of the label to be opened
-     * @param props Properties to be passed to the label, when the label is called. it cannot contain functions or classes.
+     * @param label Label to be opened when the option is selected or the id of the label
+     * @param type Type of the label to be opened. @default "call"
+     * @param props Properties to be passed to the label, when the label is called. it cannot contain functions or classes. @default {}
      */
-    constructor(text: string, label: typeof Label<T>, type?: LabelRunModeType, props?: T);
+    constructor(text: string, label: Label<T> | LabelIdType, type?: LabelRunModeType, props?: T);
 }
 /**
  * ChoiceMenuOptionClose is a class that contains a text that will be displayed in the menu.
@@ -78,10 +78,22 @@ type IStoratedChoiceMenuOption = {
     text: string;
     type: CloseType;
 };
+/**
+ * HistoryChoiceMenuOption is a type that contains the history information of a choice menu option.
+ */
 type HistoryChoiceMenuOption = {
+    /**
+     * Text to be displayed in the menu
+     */
     text: string;
+    /**
+     * Method used to open the label, or close the menu.
+     */
     type: CloseType | LabelRunModeType;
-    isMadeChoice: boolean;
+    /**
+     * This choice is a response
+     */
+    isResponse: boolean;
 };
 
 export { ChoiceMenuOptionClose, type HistoryChoiceMenuOption, type IStoratedChoiceMenuOption, ChoiceMenuOption as default };