@drincs/pixi-vn 0.6.7 → 0.6.9

package/dist/types/LabelJsonType.d.mts

@@ -1,15 +1,6 @@
 import StepLabelJsonType from './StepLabelJsonType.mjs';
-import './ChoiceMenuOptionsType.mjs';
-import '../classes/ChoiceMenuOption.mjs';
 import './LabelIdType.mjs';
 import './StorageElementType.mjs';
-import '../classes/Label.mjs';
-import './StepLabelType.mjs';
-import '@drincs/pixi-vn/dist/override';
-import '../classes/LabelAbstract.mjs';
-import './StepHistoryDataType.mjs';
-import '../interface/LabelProps.mjs';
-import './CloseType.mjs';
 import './LabelRunModeType.mjs';
 
 /**

package/dist/types/LabelJsonType.d.ts

@@ -1,15 +1,6 @@
 import StepLabelJsonType from './StepLabelJsonType.js';
-import './ChoiceMenuOptionsType.js';
-import '../classes/ChoiceMenuOption.js';
 import './LabelIdType.js';
 import './StorageElementType.js';
-import '../classes/Label.js';
-import './StepLabelType.js';
-import '@drincs/pixi-vn/dist/override';
-import '../classes/LabelAbstract.js';
-import './StepHistoryDataType.js';
-import '../interface/LabelProps.js';
-import './CloseType.js';
 import './LabelRunModeType.js';
 
 /**

package/dist/types/StepLabelJsonType.d.mts

@@ -1,29 +1,63 @@
-import { ChoiceMenuOptionsType } from './ChoiceMenuOptionsType.mjs';
-import '../classes/ChoiceMenuOption.mjs';
-import './LabelIdType.mjs';
-import './StorageElementType.mjs';
-import '../classes/Label.mjs';
-import './StepLabelType.mjs';
-import '@drincs/pixi-vn/dist/override';
-import '../classes/LabelAbstract.mjs';
-import './StepHistoryDataType.mjs';
-import '../interface/LabelProps.mjs';
-import './CloseType.mjs';
-import './LabelRunModeType.mjs';
+import { LabelIdType } from './LabelIdType.mjs';
+import { StorageObjectType } from './StorageElementType.mjs';
+import LabelRunModeType from './LabelRunModeType.mjs';
 
 /**
  * Step label JSON type
  */
 type StepLabelJsonType = {
-    currentChoiceMenuOptions?: ChoiceMenuOptionsType<{}>;
+    /**
+     * Variable used to display a choice menu.
+     */
+    currentChoiceMenuOptions?: {
+        /**
+         * The text to be displayed.
+         */
+        text: string | string[];
+        /**
+         * The label id to be opened.
+         */
+        label: LabelIdType;
+        /**
+         * Label opening mode
+         */
+        type: LabelRunModeType;
+        /**
+         * The properties to be passed to the label.
+         */
+        props: StorageObjectType;
+    }[];
+    /**
+     * Variable used to display a dialog.
+     */
     dialog?: {
+        /**
+         * The character id that will speak.
+         */
         character: string;
+        /**
+         * The text to be displayed.
+         */
         text: string;
     } | string;
+    /**
+     * Variable used to open a label.
+     */
     labelToOpen?: {
+        /**
+         * The id of the label to open.
+         */
         labelId: string;
-        type: "jump" | "call";
+        /**
+         * Label opening mode
+         */
+        type: LabelRunModeType;
     };
+    /**
+     * Variable used to end some elements of the narrative.
+     * - game_end: ends the game
+     * - label_end: ends the label
+     */
     end?: "game_end" | "label_end";
 };
 

package/dist/types/StepLabelJsonType.d.ts

@@ -1,29 +1,63 @@
-import { ChoiceMenuOptionsType } from './ChoiceMenuOptionsType.js';
-import '../classes/ChoiceMenuOption.js';
-import './LabelIdType.js';
-import './StorageElementType.js';
-import '../classes/Label.js';
-import './StepLabelType.js';
-import '@drincs/pixi-vn/dist/override';
-import '../classes/LabelAbstract.js';
-import './StepHistoryDataType.js';
-import '../interface/LabelProps.js';
-import './CloseType.js';
-import './LabelRunModeType.js';
+import { LabelIdType } from './LabelIdType.js';
+import { StorageObjectType } from './StorageElementType.js';
+import LabelRunModeType from './LabelRunModeType.js';
 
 /**
  * Step label JSON type
  */
 type StepLabelJsonType = {
-    currentChoiceMenuOptions?: ChoiceMenuOptionsType<{}>;
+    /**
+     * Variable used to display a choice menu.
+     */
+    currentChoiceMenuOptions?: {
+        /**
+         * The text to be displayed.
+         */
+        text: string | string[];
+        /**
+         * The label id to be opened.
+         */
+        label: LabelIdType;
+        /**
+         * Label opening mode
+         */
+        type: LabelRunModeType;
+        /**
+         * The properties to be passed to the label.
+         */
+        props: StorageObjectType;
+    }[];
+    /**
+     * Variable used to display a dialog.
+     */
     dialog?: {
+        /**
+         * The character id that will speak.
+         */
         character: string;
+        /**
+         * The text to be displayed.
+         */
         text: string;
     } | string;
+    /**
+     * Variable used to open a label.
+     */
     labelToOpen?: {
+        /**
+         * The id of the label to open.
+         */
         labelId: string;
-        type: "jump" | "call";
+        /**
+         * Label opening mode
+         */
+        type: LabelRunModeType;
     };
+    /**
+     * Variable used to end some elements of the narrative.
+     * - game_end: ends the game
+     * - label_end: ends the label
+     */
     end?: "game_end" | "label_end";
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@drincs/pixi-vn",
-  "version": "0.6.7",
+  "version": "0.6.9",
   "description": "Pixi'VN is a npm package that provides various features for creating visual novels.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -24,7 +24,7 @@
   "homepage": "https://pixi-vn.web.app/",
   "funding": "https://github.com/DRincs-Productions/pixi-vn?sponsor=1",
   "devDependencies": {
-    "@drincs/pixi-vn": "^0.6.6",
+    "@drincs/pixi-vn": "^0.6.8",
     "@types/crypto-js": "^4.2.2",
     "@types/css-font-loading-module": "^0.0.13",
     "@types/deep-diff": "^1.0.5",