@drincs/pixi-vn 0.6.4 → 0.6.6

package/dist/interface/IHistoryStep.d.mts

@@ -1,15 +1,17 @@
 import deepDiff from 'deep-diff';
 import { IStoratedChoiceMenuOption } from '../classes/ChoiceMenuOption.mjs';
+import { LabelIdType } from '../types/LabelIdType.mjs';
 import IOpenedLabel from './IOpenedLabel.mjs';
 import ExportedCanvas from './export/ExportedCanvas.mjs';
 import ExportedStorage from './export/ExportedStorage.mjs';
 import DialogueBaseModel from '../classes/DialogueBaseModel.mjs';
-import { LabelIdType } from '../types/LabelIdType.mjs';
 import { StepHistoryDataType } from '../types/StepHistoryDataType.mjs';
 import '../types/StorageElementType.mjs';
 import '../classes/Label.mjs';
 import '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.mjs';
+import './LabelProps.mjs';
 import '../types/CloseType.mjs';
 import '../types/LabelRunModeType.mjs';
 import './canvas/ICanvasBaseMemory.mjs';

package/dist/interface/IHistoryStep.d.ts

@@ -1,15 +1,17 @@
 import deepDiff from 'deep-diff';
 import { IStoratedChoiceMenuOption } from '../classes/ChoiceMenuOption.js';
+import { LabelIdType } from '../types/LabelIdType.js';
 import IOpenedLabel from './IOpenedLabel.js';
 import ExportedCanvas from './export/ExportedCanvas.js';
 import ExportedStorage from './export/ExportedStorage.js';
 import DialogueBaseModel from '../classes/DialogueBaseModel.js';
-import { LabelIdType } from '../types/LabelIdType.js';
 import { StepHistoryDataType } from '../types/StepHistoryDataType.js';
 import '../types/StorageElementType.js';
 import '../classes/Label.js';
 import '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.js';
+import './LabelProps.js';
 import '../types/CloseType.js';
 import '../types/LabelRunModeType.js';
 import './canvas/ICanvasBaseMemory.js';

package/dist/interface/ISaveData.d.mts

@@ -15,9 +15,11 @@ import 'deep-diff';
 import '../classes/ChoiceMenuOption.mjs';
 import '../types/LabelIdType.mjs';
 import '../classes/Label.mjs';
-import '../types/StepHistoryDataType.mjs';
 import '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.mjs';
+import '../types/StepHistoryDataType.mjs';
+import './LabelProps.mjs';
 import '../types/CloseType.mjs';
 import '../types/LabelRunModeType.mjs';
 import './IOpenedLabel.mjs';

package/dist/interface/ISaveData.d.ts

@@ -15,9 +15,11 @@ import 'deep-diff';
 import '../classes/ChoiceMenuOption.js';
 import '../types/LabelIdType.js';
 import '../classes/Label.js';
-import '../types/StepHistoryDataType.js';
 import '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.js';
+import '../types/StepHistoryDataType.js';
+import './LabelProps.js';
 import '../types/CloseType.js';
 import '../types/LabelRunModeType.js';
 import './IOpenedLabel.js';

package/dist/interface/LabelProps.d.mts

@@ -0,0 +1,38 @@
+interface LabelProps<T> {
+    /**
+     * Is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached.
+     * @param stepIndex Step index
+     * @param label Label
+     * @returns
+     * @example
+     * ```typescript
+     * newLabel("id", [], {
+     *     onStepStart: async (stepIndex, label) => {
+     *         await Assets.load('path/to/image1.png')
+     *         await Assets.load('path/to/image2.png')
+     *     }
+     * })
+     * ```
+     */
+    onStepStart?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.
+     * @param stepIndex Step index
+     * @param label Label
+     * @returns
+     */
+    onLoadStep?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * Is a function that will be executed when the step ends.
+     * @param stepIndex Step index
+     * @param label Label
+     * @returns
+     */
+    onStepEnd?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * Is the index of the choice that the label will perform. This variable is used in the system.
+     */
+    choiseIndex?: number;
+}
+
+export type { LabelProps as default };

package/dist/interface/LabelProps.d.ts

@@ -0,0 +1,38 @@
+interface LabelProps<T> {
+    /**
+     * Is a function that will be executed before any step is executed, is useful for example to make sure all images used have been cached.
+     * @param stepIndex Step index
+     * @param label Label
+     * @returns
+     * @example
+     * ```typescript
+     * newLabel("id", [], {
+     *     onStepStart: async (stepIndex, label) => {
+     *         await Assets.load('path/to/image1.png')
+     *         await Assets.load('path/to/image2.png')
+     *     }
+     * })
+     * ```
+     */
+    onStepStart?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * Is a function that will be executed in {@link Label#onStepStart} and when the user goes back to it or when the user laods a save file.
+     * @param stepIndex Step index
+     * @param label Label
+     * @returns
+     */
+    onLoadStep?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * Is a function that will be executed when the step ends.
+     * @param stepIndex Step index
+     * @param label Label
+     * @returns
+     */
+    onStepEnd?: (stepIndex: number, label: T) => void | Promise<void>;
+    /**
+     * Is the index of the choice that the label will perform. This variable is used in the system.
+     */
+    choiseIndex?: number;
+}
+
+export type { LabelProps as default };

package/dist/interface/LabelProps.js

@@ -0,0 +1,4 @@
+'use strict';
+
+//# sourceMappingURL=LabelProps.js.map
+//# sourceMappingURL=LabelProps.js.map

package/dist/interface/LabelProps.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"LabelProps.js"}

package/dist/interface/LabelProps.mjs

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=LabelProps.mjs.map
+//# sourceMappingURL=LabelProps.mjs.map

package/dist/interface/LabelProps.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"LabelProps.mjs"}

package/dist/interface/export/ExportedStep.d.mts

@@ -15,9 +15,11 @@ import 'deep-diff';
 import '../../classes/ChoiceMenuOption.mjs';
 import '../../types/LabelIdType.mjs';
 import '../../classes/Label.mjs';
-import '../../types/StepHistoryDataType.mjs';
 import '../../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../../classes/LabelAbstract.mjs';
+import '../../types/StepHistoryDataType.mjs';
+import '../LabelProps.mjs';
 import '../../types/CloseType.mjs';
 import '../../types/LabelRunModeType.mjs';
 import '../../classes/DialogueBaseModel.mjs';

package/dist/interface/export/ExportedStep.d.ts

@@ -15,9 +15,11 @@ import 'deep-diff';
 import '../../classes/ChoiceMenuOption.js';
 import '../../types/LabelIdType.js';
 import '../../classes/Label.js';
-import '../../types/StepHistoryDataType.js';
 import '../../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../../classes/LabelAbstract.js';
+import '../../types/StepHistoryDataType.js';
+import '../LabelProps.js';
 import '../../types/CloseType.js';
 import '../../types/LabelRunModeType.js';
 import '../../classes/DialogueBaseModel.js';

package/dist/interface/export/index.d.mts

@@ -15,9 +15,11 @@ import 'deep-diff';
 import '../../classes/ChoiceMenuOption.mjs';
 import '../../types/LabelIdType.mjs';
 import '../../classes/Label.mjs';
-import '../../types/StepHistoryDataType.mjs';
 import '../../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../../classes/LabelAbstract.mjs';
+import '../../types/StepHistoryDataType.mjs';
+import '../LabelProps.mjs';
 import '../../types/CloseType.mjs';
 import '../../types/LabelRunModeType.mjs';
 import '../IOpenedLabel.mjs';

package/dist/interface/export/index.d.ts

@@ -15,9 +15,11 @@ import 'deep-diff';
 import '../../classes/ChoiceMenuOption.js';
 import '../../types/LabelIdType.js';
 import '../../classes/Label.js';
-import '../../types/StepHistoryDataType.js';
 import '../../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../../classes/LabelAbstract.js';
+import '../../types/StepHistoryDataType.js';
+import '../LabelProps.js';
 import '../../types/CloseType.js';
 import '../../types/LabelRunModeType.js';
 import '../IOpenedLabel.js';

package/dist/interface/index.d.mts

@@ -5,6 +5,7 @@ export { default as IOpenedLabel } from './IOpenedLabel.mjs';
 export { default as ISaveData } from './ISaveData.mjs';
 export { I as ITicker } from '../TickerBase-DKYzbzro.mjs';
 export { default as ITickersSteps } from './ITickersSteps.mjs';
+export { default as LabelProps } from './LabelProps.mjs';
 export { default as TickerHistory, TickerHistoryForExport } from './TickerHistory.mjs';
 export { TickerProgrationType } from './TickerProgrationType.mjs';
 export { default as TickerTimeoutHistory } from './TickerTimeoutHistory.mjs';
@@ -19,9 +20,10 @@ import 'deep-diff';
 import '../classes/ChoiceMenuOption.mjs';
 import '../types/LabelIdType.mjs';
 import '../classes/Label.mjs';
-import '../types/StepHistoryDataType.mjs';
 import '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.mjs';
+import '../types/StepHistoryDataType.mjs';
 import './export/ExportedCanvas.mjs';
 import './canvas/ICanvasBaseMemory.mjs';
 import './export/ExportedStorage.mjs';

package/dist/interface/index.d.ts

@@ -5,6 +5,7 @@ export { default as IOpenedLabel } from './IOpenedLabel.js';
 export { default as ISaveData } from './ISaveData.js';
 export { I as ITicker } from '../TickerBase-3rLpDpmb.js';
 export { default as ITickersSteps } from './ITickersSteps.js';
+export { default as LabelProps } from './LabelProps.js';
 export { default as TickerHistory, TickerHistoryForExport } from './TickerHistory.js';
 export { TickerProgrationType } from './TickerProgrationType.js';
 export { default as TickerTimeoutHistory } from './TickerTimeoutHistory.js';
@@ -19,9 +20,10 @@ import 'deep-diff';
 import '../classes/ChoiceMenuOption.js';
 import '../types/LabelIdType.js';
 import '../classes/Label.js';
-import '../types/StepHistoryDataType.js';
 import '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.js';
+import '../types/StepHistoryDataType.js';
 import './export/ExportedCanvas.js';
 import './canvas/ICanvasBaseMemory.js';
 import './export/ExportedStorage.js';

package/dist/labels/BaseCanvasElementTestLabel.d.mts

@@ -1,8 +1,10 @@
 import Label from '../classes/Label.mjs';
 import '../types/LabelIdType.mjs';
-import '../types/StepHistoryDataType.mjs';
 import '../types/StepLabelType.mjs';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.mjs';
+import '../types/StepHistoryDataType.mjs';
+import '../interface/LabelProps.mjs';
 
 declare const baseCanvasElementTestLabel: Label<{}>;
 

package/dist/labels/BaseCanvasElementTestLabel.d.ts

@@ -1,8 +1,10 @@
 import Label from '../classes/Label.js';
 import '../types/LabelIdType.js';
-import '../types/StepHistoryDataType.js';
 import '../types/StepLabelType.js';
 import '@drincs/pixi-vn/dist/override';
+import '../classes/LabelAbstract.js';
+import '../types/StepHistoryDataType.js';
+import '../interface/LabelProps.js';
 
 declare const baseCanvasElementTestLabel: Label<{}>;