@drincs/pixi-vn 0.4.7 → 0.4.8

package/dist/managers/StepManager.d.mts

@@ -0,0 +1,210 @@
+import CharacterBaseModel from '../classes/CharacterBaseModel.mjs';
+import Label from '../classes/Label.mjs';
+import DialogueBaseModel from '../classes/DialogueBaseModel.mjs';
+import ExportedStep from '../interface/export/ExportedStep.mjs';
+import IHistoryStep from '../interface/IHistoryStep.mjs';
+import IOpenedLabel from '../interface/IOpenedLabel.mjs';
+import { StepLabelPropsType, StepLabelResultType } from '../types/StepLabelType.mjs';
+import '../classes/StoredClassModel.mjs';
+import '../types/StepHistoryDataType.mjs';
+import '../override/StepLabelProps.mjs';
+import '../override/StepLabelResult.mjs';
+import '../types/StorageElementType.mjs';
+import '../interface/export/ExportedCanvas.mjs';
+import '../interface/canvas/ICanvasBaseMemory.mjs';
+import '../interface/IClassWithArgsHistory.mjs';
+import 'pixi.js';
+import '../TickerBase-CFEJHstJ.mjs';
+import '../types/TickerIdType.mjs';
+import '../interface/export/ExportedStorage.mjs';
+import 'deep-diff';
+import '../classes/ChoiceMenuOptionLabel.mjs';
+import '../enums/LabelRunModeEnum.mjs';
+import '../types/LabelIdType.mjs';
+
+/**
+ * GameStepManager is a class that manages the steps and labels of the game.
+ */
+declare class GameStepManager {
+    private constructor();
+    /**
+     * stepHistory is a list of label events and steps that occurred during the progression of the steps.
+     */
+    private static _stepsHistory;
+    static get stepsHistory(): IHistoryStep<DialogueBaseModel<CharacterBaseModel>>[];
+    private static _lastStepIndex;
+    /**
+     * lastStepIndex is the last step index that occurred during the progression of the steps. **Not is the length of the stepsHistory - 1.**
+     */
+    static get lastStepIndex(): number;
+    /**
+     * Increase the last step index that occurred during the progression of the steps.
+     */
+    private static increaseLastStepIndex;
+    private static _openedLabels;
+    static get openedLabels(): IOpenedLabel[];
+    /**
+     * currentLabelId is the current label id that occurred during the progression of the steps.
+     */
+    private static get currentLabelId();
+    /**
+     * currentLabel is the current label that occurred during the progression of the steps.
+     */
+    static get currentLabel(): Label | undefined;
+    private static get currentLabelStepIndex();
+    /**
+     * currentLabelStep is the current step that occurred during the progression of the steps. It can used to determine the game end.
+     */
+    static get isLastGameStep(): boolean;
+    /**
+     * lastHistoryStep is the last history step that occurred during the progression of the steps.
+     */
+    private static get lastHistoryStep();
+    private static _originalStepData;
+    private static get originalStepData();
+    private static set originalStepData(value);
+    /**
+     * Add a label to the history.
+     * @param label The label to add to the history.
+     */
+    private static addStepHistory;
+    /**
+     * Add a label to the history.
+     * @param label The label to add to the history.
+     */
+    private static pushNewLabel;
+    /**
+     * Close the current label and add it to the history.
+     * @returns
+     */
+    static closeCurrentLabel(): void;
+    /**
+     * Close all labels and add them to the history.
+     */
+    static closeAllLabels(): void;
+    /**
+     * Increase the current step index of the current label.
+     */
+    private static increaseCurrentStepIndex;
+    /**
+     * Execute the next step and add it to the history.
+     * @param props The props to pass to the step.
+     * @returns StepLabelResultType or undefined.
+     * @example
+     * ```typescript
+     *     function nextOnClick() {
+     *     setLoading(true)
+     *     GameStepManager.runNextStep(yourParams)
+     *         .then((result) => {
+     *             setUpdate((p) => p + 1)
+     *             setLoading(false)
+     *             if (result) {
+     *                 // your code
+     *             }
+     *         })
+     *         .catch((e) => {
+     *             setLoading(false)
+     *             console.error(e)
+     *         })
+     * }
+     * ```
+     */
+    static runNextStep(props?: StepLabelPropsType): Promise<StepLabelResultType>;
+    /**
+     * Execute the current step and add it to the history.
+     * @param props The props to pass to the step.
+     * @returns StepLabelResultType or undefined.
+     */
+    private static runCurrentStep;
+    /**
+     * Execute the label and add it to the history.
+     * Is a call function in Ren'Py.
+     * @param label The label to execute.
+     * @param props The props to pass to the label.
+     * @returns StepLabelResultType or undefined.
+     * @example
+     * ```typescript
+     * GameStepManager.callLabel(StartLabel, yourParams).then((result) => {
+     *     if (result) {
+     *         // your code
+     *     }
+     * })
+     * ```
+     * @example
+     * ```typescript
+     * // if you use it in a step label you should return the result.
+     * return GameStepManager.callLabel(StartLabel).then((result) => {
+     *     return result
+     * })
+     * ```
+     */
+    static callLabel(label: typeof Label | Label, props?: StepLabelPropsType): Promise<StepLabelResultType>;
+    /**
+     * Execute the label, close all labels and add them to the history.
+     * Is a jump function in Ren'Py.
+     * @param label The label to execute.
+     * @param props The props to pass to the label.
+     * @returns StepLabelResultType or undefined.
+     * @example
+     * ```typescript
+     * GameStepManager.jumpLabel(StartLabel, yourParams).then((result) => {
+     *     if (result) {
+     *         // your code
+     *     }
+     * })
+     * ```
+     * @example
+     * ```typescript
+     * // if you use it in a step label you should return the result.
+     * return GameStepManager.jumpLabel(StartLabel).then((result) => {
+     *     return result
+     * })
+     * ```
+     */
+    static jumpLabel(label: typeof Label | Label, props?: StepLabelPropsType): Promise<StepLabelResultType>;
+    /**
+     * Go back to the last step and add it to the history.
+     * @param navigate The navigate function.
+     * @param steps The number of steps to go back.
+     * @returns
+     * @example
+     * ```typescript
+     * export function goBack(navigate: (path: string) => void, afterBack?: () => void) {
+     *     GameStepManager.goBack(navigate)
+     *     afterBack && afterBack()
+     * }
+     * ```
+     */
+    static goBack(navigate: (path: string) => void, steps?: number): void;
+    private static goBackInternal;
+    /**
+     * Return true if it is possible to go back.
+     */
+    static get canGoBack(): boolean;
+    /**
+     * Add a label to the history.
+     */
+    static clear(): void;
+    /**
+     * Export the history to a JSON string.
+     * @returns The history in a JSON string.
+     */
+    static exportJson(): string;
+    /**
+     * Export the history to an object.
+     * @returns The history in an object.
+     */
+    static export(): ExportedStep;
+    /**
+     * Import the history from a JSON string.
+     * @param dataString The history in a JSON string.
+     */
+    static importJson(dataString: string): void;
+    /**
+     * Import the history from an object.
+     * @param data The history in an object.
+     */
+    static import(data: object): void;
+}
+
+export { GameStepManager as default };

package/dist/managers/StepManager.d.ts

@@ -0,0 +1,210 @@
+import CharacterBaseModel from '../classes/CharacterBaseModel.js';
+import Label from '../classes/Label.js';
+import DialogueBaseModel from '../classes/DialogueBaseModel.js';
+import ExportedStep from '../interface/export/ExportedStep.js';
+import IHistoryStep from '../interface/IHistoryStep.js';
+import IOpenedLabel from '../interface/IOpenedLabel.js';
+import { StepLabelPropsType, StepLabelResultType } from '../types/StepLabelType.js';
+import '../classes/StoredClassModel.js';
+import '../types/StepHistoryDataType.js';
+import '../override/StepLabelProps.js';
+import '../override/StepLabelResult.js';
+import '../types/StorageElementType.js';
+import '../interface/export/ExportedCanvas.js';
+import '../interface/canvas/ICanvasBaseMemory.js';
+import '../interface/IClassWithArgsHistory.js';
+import 'pixi.js';
+import '../TickerBase-CjfyD6j5.js';
+import '../types/TickerIdType.js';
+import '../interface/export/ExportedStorage.js';
+import 'deep-diff';
+import '../classes/ChoiceMenuOptionLabel.js';
+import '../enums/LabelRunModeEnum.js';
+import '../types/LabelIdType.js';
+
+/**
+ * GameStepManager is a class that manages the steps and labels of the game.
+ */
+declare class GameStepManager {
+    private constructor();
+    /**
+     * stepHistory is a list of label events and steps that occurred during the progression of the steps.
+     */
+    private static _stepsHistory;
+    static get stepsHistory(): IHistoryStep<DialogueBaseModel<CharacterBaseModel>>[];
+    private static _lastStepIndex;
+    /**
+     * lastStepIndex is the last step index that occurred during the progression of the steps. **Not is the length of the stepsHistory - 1.**
+     */
+    static get lastStepIndex(): number;
+    /**
+     * Increase the last step index that occurred during the progression of the steps.
+     */
+    private static increaseLastStepIndex;
+    private static _openedLabels;
+    static get openedLabels(): IOpenedLabel[];
+    /**
+     * currentLabelId is the current label id that occurred during the progression of the steps.
+     */
+    private static get currentLabelId();
+    /**
+     * currentLabel is the current label that occurred during the progression of the steps.
+     */
+    static get currentLabel(): Label | undefined;
+    private static get currentLabelStepIndex();
+    /**
+     * currentLabelStep is the current step that occurred during the progression of the steps. It can used to determine the game end.
+     */
+    static get isLastGameStep(): boolean;
+    /**
+     * lastHistoryStep is the last history step that occurred during the progression of the steps.
+     */
+    private static get lastHistoryStep();
+    private static _originalStepData;
+    private static get originalStepData();
+    private static set originalStepData(value);
+    /**
+     * Add a label to the history.
+     * @param label The label to add to the history.
+     */
+    private static addStepHistory;
+    /**
+     * Add a label to the history.
+     * @param label The label to add to the history.
+     */
+    private static pushNewLabel;
+    /**
+     * Close the current label and add it to the history.
+     * @returns
+     */
+    static closeCurrentLabel(): void;
+    /**
+     * Close all labels and add them to the history.
+     */
+    static closeAllLabels(): void;
+    /**
+     * Increase the current step index of the current label.
+     */
+    private static increaseCurrentStepIndex;
+    /**
+     * Execute the next step and add it to the history.
+     * @param props The props to pass to the step.
+     * @returns StepLabelResultType or undefined.
+     * @example
+     * ```typescript
+     *     function nextOnClick() {
+     *     setLoading(true)
+     *     GameStepManager.runNextStep(yourParams)
+     *         .then((result) => {
+     *             setUpdate((p) => p + 1)
+     *             setLoading(false)
+     *             if (result) {
+     *                 // your code
+     *             }
+     *         })
+     *         .catch((e) => {
+     *             setLoading(false)
+     *             console.error(e)
+     *         })
+     * }
+     * ```
+     */
+    static runNextStep(props?: StepLabelPropsType): Promise<StepLabelResultType>;
+    /**
+     * Execute the current step and add it to the history.
+     * @param props The props to pass to the step.
+     * @returns StepLabelResultType or undefined.
+     */
+    private static runCurrentStep;
+    /**
+     * Execute the label and add it to the history.
+     * Is a call function in Ren'Py.
+     * @param label The label to execute.
+     * @param props The props to pass to the label.
+     * @returns StepLabelResultType or undefined.
+     * @example
+     * ```typescript
+     * GameStepManager.callLabel(StartLabel, yourParams).then((result) => {
+     *     if (result) {
+     *         // your code
+     *     }
+     * })
+     * ```
+     * @example
+     * ```typescript
+     * // if you use it in a step label you should return the result.
+     * return GameStepManager.callLabel(StartLabel).then((result) => {
+     *     return result
+     * })
+     * ```
+     */
+    static callLabel(label: typeof Label | Label, props?: StepLabelPropsType): Promise<StepLabelResultType>;
+    /**
+     * Execute the label, close all labels and add them to the history.
+     * Is a jump function in Ren'Py.
+     * @param label The label to execute.
+     * @param props The props to pass to the label.
+     * @returns StepLabelResultType or undefined.
+     * @example
+     * ```typescript
+     * GameStepManager.jumpLabel(StartLabel, yourParams).then((result) => {
+     *     if (result) {
+     *         // your code
+     *     }
+     * })
+     * ```
+     * @example
+     * ```typescript
+     * // if you use it in a step label you should return the result.
+     * return GameStepManager.jumpLabel(StartLabel).then((result) => {
+     *     return result
+     * })
+     * ```
+     */
+    static jumpLabel(label: typeof Label | Label, props?: StepLabelPropsType): Promise<StepLabelResultType>;
+    /**
+     * Go back to the last step and add it to the history.
+     * @param navigate The navigate function.
+     * @param steps The number of steps to go back.
+     * @returns
+     * @example
+     * ```typescript
+     * export function goBack(navigate: (path: string) => void, afterBack?: () => void) {
+     *     GameStepManager.goBack(navigate)
+     *     afterBack && afterBack()
+     * }
+     * ```
+     */
+    static goBack(navigate: (path: string) => void, steps?: number): void;
+    private static goBackInternal;
+    /**
+     * Return true if it is possible to go back.
+     */
+    static get canGoBack(): boolean;
+    /**
+     * Add a label to the history.
+     */
+    static clear(): void;
+    /**
+     * Export the history to a JSON string.
+     * @returns The history in a JSON string.
+     */
+    static exportJson(): string;
+    /**
+     * Export the history to an object.
+     * @returns The history in an object.
+     */
+    static export(): ExportedStep;
+    /**
+     * Import the history from a JSON string.
+     * @param dataString The history in a JSON string.
+     */
+    static importJson(dataString: string): void;
+    /**
+     * Import the history from an object.
+     * @param data The history in an object.
+     */
+    static import(data: object): void;
+}
+
+export { GameStepManager as default };