@drincs/pixi-vn 0.1.3 → 0.1.4

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import * as pixi_js from 'pixi.js';
 import { ContainerOptions, SpriteOptions, TextOptions, Container, Sprite, ContainerEvents, EventEmitter, Texture, TextureSourceLike, Text, UPDATE_PRIORITY, Ticker, TickerCallback, Application, ApplicationOptions } from 'pixi.js';
+import deepDiff from 'deep-diff';
 
 /**
  * CanvasEventNamesType is a type that is used to define the event names for the canvas.
@@ -33,8 +34,8 @@ declare class CanvasEvent<C> {
  * @example
  * ```typescript
  * export class CharacterModelBase extends StoredClassModel implements ICharacterModelBase {
- *     constructor(tag: string, props: ICharacterModelBase) {
- *         super(tag)
+ *     constructor(id: string, props: ICharacterModelBase) {
+ *         super(id)
  *         this.defaultName = props.name
  *         this.defaultSurname = props.surname
  *     }
@@ -43,14 +44,14 @@ declare class CanvasEvent<C> {
  *         return this.getStorageProperty<string>("name") || this.defaultName
  *     }
  *     set name(value: string) {
- *         this.updateStorage({ ...this, name: value })
+ *         this.updateStorageProperty<string>("name", value)
  *     }
  *     private defaultSurname?: string
  *     get surname(): string | undefined {
  *         return this.getStorageProperty<string>("surname") || this.defaultSurname
  *     }
  *     set surname(value: string | undefined) {
- *         this.updateStorage({ ...this, surname: value })
+ *         this.updateStorageProperty<string>("surname", value)
  *     }
  * }
  * ```
@@ -59,7 +60,7 @@ declare abstract class StoredClassModel {
     id: string;
     constructor(id: string);
     private get nameClass();
-    updateStorage(value: typeof this): void;
+    updateStorageProperty<T>(key: string, value: T | undefined): void;
     getStorageProperty<T>(key: string): T | undefined;
 }
 
@@ -94,7 +95,7 @@ interface ICharacterModelBase {
  * ```
  */
 declare class CharacterModelBase extends StoredClassModel implements ICharacterModelBase {
-    constructor(tag: string, props: ICharacterModelBase);
+    constructor(id: string, props: ICharacterModelBase);
     private defaultName;
     get name(): string;
     set name(value: string);
@@ -104,25 +105,26 @@ declare class CharacterModelBase extends StoredClassModel implements ICharacterM
     private defaultAge?;
     get age(): number | undefined;
     set age(value: number | undefined);
-    icon?: string;
-    color?: string;
+    private _icon?;
+    get icon(): string | undefined;
+    private _color?;
+    get color(): string | undefined;
 }
 
 /**
- * Base class for all dialogue models. I suggest you extend this class to create your own dialogue models.
+ * Enumeration of label modes that occurred during the progression of the steps.
  */
-declare class DialogueModelBase {
-    constructor(text: string, characterTag: string | undefined);
-    /**
-     * The text of the dialogue.
-     */
-    text: string;
-    /**
-     * The tag of the character that is speaking.
-     */
-    characterTag?: string;
+declare enum LabelRunModeEnum {
+    OpenByCall = "openbycall",
+    OpenByJump = "openbyjump"
 }
 
+/**
+ * is a string containing the name of the label.
+ * It is used to GameStepManager.registeredLabels to get the label class.
+ */
+type LabelIdType = string;
+
 /**
  * StepHistoryData is a string that will be stored in the history of the game.
  * It is a function converted to string.
@@ -148,9 +150,9 @@ type StepLabelType = (() => void | Promise<void>);
  *             () => {
  *                 GameWindowManager.clear()
  *                 setDialogue({ character: liam, text: "Which test do you want to perform?" })
- *                 setMenuOptions([
- *                     new MenuOptionLabel("Events Test", EventsTestLabel),
- *                     new MenuOptionLabel("Show Image Test", ShowImageTest),
+ *                 setChoiceMenuOptions([
+ *                     new ChoiceMenuOptionLabel("Events Test", EventsTestLabel),
+ *                     new ChoiceMenuOptionLabel("Show Image Test", ShowImageTest),
  *                 ])
  *             },
  *             () => GameStepManager.jumpLabel(StartLabel),
@@ -176,26 +178,52 @@ declare class Label {
 }
 
 /**
- * Enumeration of label modes that occurred during the progression of the steps.
- */
-declare enum LabelRunModeEnum {
-    OpenByCall = "openbycall",
-    OpenByJump = "openbyjump"
-}
-
-/**
- * MenuOptionLabel is a class that contains a Label and a text that will be displayed in the menu.
+ * ChoiceMenuOptionLabel is a class that contains a Label and a text that will be displayed in the menu.
  * @example
  * ```typescript
- * new MenuOptionLabel("Events Test", EventsTestLabel)
+ * new ChoiceMenuOptionLabel("Events Test", EventsTestLabel)
  * ```
  */
-declare class MenuOptionLabel {
+declare class ChoiceMenuOptionLabel {
+    /**
+     * Text to be displayed in the menu
+     */
     text: string;
+    /**
+     * Label to be opened when the option is selected
+     */
     label: typeof Label;
+    /**
+     * Type of the label to be opened
+     */
     type: LabelRunModeEnum;
+    /**
+     * @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
+     */
     constructor(text: string, label: typeof Label, type?: LabelRunModeEnum);
 }
+interface IStoratedChoiceMenuOptionLabel {
+    text: string;
+    label: LabelIdType;
+    type: LabelRunModeEnum;
+}
+
+/**
+ * Base class for all dialogue models. I suggest you extend this class to create your own dialogue models.
+ */
+declare class DialogueModelBase {
+    constructor(text: string, characterId: string | undefined);
+    /**
+     * The text of the dialogue.
+     */
+    text: string;
+    /**
+     * The id of the character that is speaking.
+     */
+    characterId?: string;
+}
 
 /**
  * Interface for the canvas base memory
@@ -211,7 +239,7 @@ interface ICanvasContainerMemory extends ContainerOptions, ICanvasBaseMemory {
     elements: ICanvasBaseMemory[];
 }
 
-type EventTagType = string;
+type EventIdType = string;
 
 /**
  * Interface for texture memory
@@ -223,7 +251,7 @@ interface ITextureMemory {
 interface ICanvasSpriteBaseMemory extends SpriteOptions, ICanvasBaseMemory {
     textureImage: ITextureMemory;
     onEvents: {
-        [name: CanvasEventNamesType]: EventTagType;
+        [name: CanvasEventNamesType]: EventIdType;
     };
 }
 /**
@@ -246,7 +274,7 @@ interface ICanvasImageMemory extends ICanvasSpriteBaseMemory {
 interface ICanvasTextMemory extends TextOptions, ICanvasBaseMemory {
     className: "CanvasText";
     onEvents: {
-        [name: CanvasEventNamesType]: EventTagType;
+        [name: CanvasEventNamesType]: EventIdType;
     };
 }
 
@@ -285,7 +313,7 @@ declare class CanvasBase<T2 extends ICanvasBaseMemory> extends Container {
 
 /**
  * This class is a extension of the [PIXI.Container class](https://pixijs.com/8.x/examples/basic/container), it has the same properties and methods,
- * but it has the ability to be saved and loaded by the Pixi'VM library.
+ * but it has the ability to be saved and loaded by the Pixi'VN library.
  * @example
  * ```typescript
  *  const container = new CanvasContainer();
@@ -307,7 +335,7 @@ declare class CanvasContainer extends Container implements CanvasBase<ICanvasCon
 
 /**
  * This class is a extension of the [PIXI.Sprite class](https://pixijs.com/8.x/examples/sprite/basic), it has the same properties and methods,
- * but it has the ability to be saved and loaded by the Pixi'VM library.
+ * but it has the ability to be saved and loaded by the Pixi'VN library.
  * @example
  * ```typescript
  * const texture = await Assets.load('https://pixijs.com/assets/bunny.png');
@@ -387,7 +415,7 @@ declare class CanvasSprite<Memory extends SpriteOptions & ICanvasBaseMemory = IC
  * This class is a extension of the CanvasSprite class, it has the same properties and methods,
  * but it has some features that make texture management easier.
  * You need to use CanvasImage.load() to show the image in the canvas.
- * This class is used for functions like addImage, showCanvasImages and showImageWithDisolveEffect.
+ * This class is used for functions like addImage, showCanvasImages and showImageWithDissolveTransition.
  * @example
  * ```typescript
  * let alien = addImage("alien", 'https://pixijs.com/assets/eggHead.png')
@@ -411,7 +439,7 @@ declare class CanvasImage extends CanvasSprite<ICanvasImageMemory> {
 
 /**
  * This class is a extension of the [PIXI.Text class](https://pixijs.com/8.x/examples/text/pixi-text), it has the same properties and methods,
- * but it has the ability to be saved and loaded by the Pixi'VM library.
+ * but it has the ability to be saved and loaded by the Pixi'VN library.
  * @example
  * ```typescript
  * const text = new CanvasText();
@@ -498,7 +526,7 @@ interface ITicker<TArgs extends TickerArgsType> {
 type StorageElementType = string | number | boolean | object | undefined | null;
 
 type TickerArgsType = {
-    [tag: string]: StorageElementType;
+    [id: string]: StorageElementType;
 };
 /**
  * A class is used to create a ticker element to add into a Pixi Application.
@@ -664,15 +692,15 @@ declare function canvasElementDecorator(name?: CanvasElementTagType): (target: t
  */
 declare function saveCharacter<T extends CharacterModelBase = CharacterModelBase>(character: T | T[]): void;
 /**
- * is a function that returns the character by the tag
- * @param tag is the tag of the character
+ * is a function that returns the character by the id
+ * @param id is the id of the character
  * @returns the character
  * @example
  * ```typescript
- * const liam = getCharacterByTag('liam');
+ * const liam = getCharacterById('liam');
  * ```
  */
-declare function getCharacterByTag<T extends CharacterModelBase>(tag: string): T | undefined;
+declare function getCharacterById<T extends CharacterModelBase>(id: string): T | undefined;
 
 /**
  * Is a decorator that register a event in the game.
@@ -681,13 +709,7 @@ declare function getCharacterByTag<T extends CharacterModelBase>(tag: string): T
  * @param name is th identifier of the event, by default is the name of the class
  * @returns
  */
-declare function eventDecorator(name?: EventTagType): (target: typeof CanvasEvent<any>) => void;
-
-/**
- * LabelTagType is a string containing the name of the label.
- * It is used to GameStepManager.registeredLabels to get the label class.
- */
-type LabelTagType = string;
+declare function eventDecorator(name?: EventIdType): (target: typeof CanvasEvent<any>) => void;
 
 /**
  * Is a decorator that register a label in the game.
@@ -696,13 +718,13 @@ type LabelTagType = string;
  * @param name is th identifier of the label, by default is the name of the class
  * @returns
  */
-declare function labelDecorator(name?: LabelTagType): (target: typeof Label) => void;
+declare function labelDecorator(name?: LabelIdType): (target: typeof Label) => void;
 
 /**
- * TickerTagType is a string that represents a ticker tag.
+ * is a string that represents a ticker id.
  * It is used to GameWindowManager.tickers to get the ticker class.
  */
-type TickerTagType = string;
+type TickerIdType = string;
 
 /**
  * Is a decorator that register a ticker in the game.
@@ -711,13 +733,178 @@ type TickerTagType = string;
  * @param name is th identifier of the label, by default is the name of the class
  * @returns
  */
-declare function tickerDecorator(name?: TickerTagType): (target: typeof TickerBase<any>) => void;
+declare function tickerDecorator(name?: TickerIdType): (target: typeof TickerBase<any>) => void;
+
+/**
+ * IClassWithArgsHistory is a class that contains the name of a class and the arguments that were used to create it.
+ */
+interface IClassWithArgsHistory<TArgs extends TickerArgsType> {
+    fn: TickerCallback<any>;
+    className: TickerIdType;
+    args: TArgs;
+    canvasElementTags: string[];
+    priority?: UPDATE_PRIORITY;
+    duration?: number;
+}
+interface IClassWithArgsHistoryForExport<TArgs extends TickerArgsType> {
+    className: TickerIdType;
+    args: TArgs;
+    canvasElementTags: string[];
+    priority?: UPDATE_PRIORITY;
+    duration?: number;
+}
+
+interface IDialogueHistory<T extends DialogueModelBase = DialogueModelBase> {
+    /**
+     * Dialogue to be shown in the game
+     */
+    dialoge?: T;
+    /**
+     * List of choices asked of the player
+     */
+    choices?: IStoratedChoiceMenuOptionLabel[];
+    /**
+     * Choice made by the player
+     */
+    choiceMade?: IStoratedChoiceMenuOptionLabel;
+    /**
+     * The index of the step in the history.
+     */
+    stepIndex: number;
+}
+
+/**
+ * Interface exported canvas
+ */
+interface ExportedCanvas {
+    currentTickers: IClassWithArgsHistoryForExport<any>[];
+    currentElements: {
+        [tag: string]: ICanvasBaseMemory;
+    };
+    childrenTagsOrder: string[];
+}
+
+/**
+ * Interface exported storage data
+ */
+interface ExportedStorage {
+    [key: string]: StorageElementType;
+}
+
+interface IOpenedLabel {
+    label: LabelIdType;
+    currentStepIndex: number;
+}
+
+/**
+ * IHistoryStep is a interface that contains the information of a step in the history.
+ */
+interface IHistoryStepData {
+    /**
+     * The browser path that occurred during the progression of the steps.
+     */
+    path: string;
+    /**
+     * The storage that occurred during the progression of the steps.
+     */
+    storage: ExportedStorage;
+    /**
+     * The index of the label that occurred during the progression of the steps.
+     */
+    labelIndex: number;
+    /**
+     * The canvas that occurred during the progression of the steps.
+     */
+    canvas: ExportedCanvas;
+    /**
+     * The opened labels that occurred during the progression of the steps.
+     */
+    openedLabels: IOpenedLabel[];
+}
+interface IHistoryStep<T extends DialogueModelBase = DialogueModelBase> {
+    /**
+     * The difference between the previous step and the current step.
+     */
+    diff: deepDiff.Diff<IHistoryStepData, IHistoryStepData>[];
+    /**
+     * The label id of the current step.
+     */
+    currentLabel?: LabelIdType;
+    /**
+     * The sha1 of the step function.
+     */
+    stepSha1: StepHistoryDataType;
+    /**
+     * The index of the step in the history.
+     */
+    index: number;
+    /**
+     * Dialogue to be shown in the game
+     */
+    dialoge?: T;
+    /**
+     * List of choices asked of the player
+     */
+    choices?: IStoratedChoiceMenuOptionLabel[];
+}
+
+/**
+ * Interface exported step data
+ */
+interface ExportedStep {
+    stepsHistory: IHistoryStep[];
+    openedLabels: IOpenedLabel[];
+    lastStepIndex: number;
+    originalStepData: IHistoryStepData | undefined;
+}
+
+interface ISaveData {
+    version: string;
+    stepData: ExportedStep;
+    storageData: ExportedStorage;
+    canvasData: ExportedCanvas;
+    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
+     */
+    ticker: string;
+    /**
+     * Duration in milliseconds
+     */
+    duration: number;
+}
+/**
+ * The steps of the tickers
+ */
+interface ITickersSteps {
+    /**
+     * The step number
+     */
+    currentStepNumber: number;
+    /**
+     * The steps of the tickers
+     */
+    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 MenuOptionsType = MenuOptionLabel[];
+type ChoiceMenuOptionsType = ChoiceMenuOptionLabel[];
 
 /**
  * Set the dialogue to be shown in the game
@@ -726,20 +913,20 @@ type MenuOptionsType = MenuOptionLabel[];
  * ```typescript
  * setDialogue("Hello World")
  * setDialogue({
- *       character: "characterTag",
+ *       character: "characterId",
  *       text: "Hello World"
  * })
  * ```
  */
-declare function setDialogue(props: {
-    character: string | CharacterModelBase;
+declare function setDialogue<T extends CharacterModelBase = CharacterModelBase>(props: {
+    character: string | T;
     text: string;
 } | string): void;
 /**
  * Get the dialogue to be shown in the game
  * @returns Dialogue to be shown in the game
  */
-declare function getDialogue(): DialogueModelBase | undefined;
+declare function getDialogue<T extends DialogueModelBase = DialogueModelBase>(): T | undefined;
 /**
  * Clear the dialogue to be shown in the game
  */
@@ -749,30 +936,30 @@ declare function clearDialogue(): void;
  * @param options Options to be shown in the game
  * @example
  * ```typescript
- * setMenuOptions([
- *     new MenuOptionLabel("Events Test", EventsTestLabel),
- *     new MenuOptionLabel("Show Image Test", ShowImageTest),
- *     new MenuOptionLabel("Ticker Test", TickerTestLabel),
- *     new MenuOptionLabel("Tinting Test", TintingTestLabel),
- *     new MenuOptionLabel("Base Canvas Element Test Label", BaseCanvasElementTestLabel)
+ * setChoiceMenuOptions([
+ *     new ChoiceMenuOptionLabel("Events Test", EventsTestLabel),
+ *     new ChoiceMenuOptionLabel("Show Image Test", ShowImageTest),
+ *     new ChoiceMenuOptionLabel("Ticker Test", TickerTestLabel),
+ *     new ChoiceMenuOptionLabel("Tinting Test", TintingTestLabel),
+ *     new ChoiceMenuOptionLabel("Base Canvas Element Test Label", BaseCanvasElementTestLabel)
  * ])
  * ```
  */
-declare function setMenuOptions(options: MenuOptionsType): void;
+declare function setChoiceMenuOptions(options: ChoiceMenuOptionsType): void;
 /**
  * Get the options to be shown in the game
  * @returns Options to be shown in the game
  */
-declare function getMenuOptions(): MenuOptionsType | undefined;
+declare function getChoiceMenuOptions(): ChoiceMenuOptionsType | undefined;
 /**
  * Clear the options to be shown in the game
  */
-declare function clearMenuOptions(): void;
+declare function clearChoiceMenuOptions(): void;
 /**
  * Get the history of the dialogues
  * @returns the history of the dialogues
  */
-declare function getDialogueHistory(): DialogueModelBase[];
+declare function getDialogueHistory<T extends DialogueModelBase = DialogueModelBase>(): IDialogueHistory<T>[];
 
 /**
  * Clear all game data. This function is used to reset the game.
@@ -815,84 +1002,7 @@ declare function removeCanvasElement(tag: string | string[]): void;
  * @param priority The priority of the effect
  * @returns The sprite of the image.
  */
-declare function showImageWithDisolveEffect(tag: string, imageUrl: string, speed: number, priority?: UPDATE_PRIORITY): Promise<void>;
-
-/**
- * IClassWithArgsHistory is a class that contains the name of a class and the arguments that were used to create it.
- */
-interface IClassWithArgsHistory<TArgs extends TickerArgsType> {
-    fn: TickerCallback<any>;
-    className: TickerTagType;
-    args: TArgs;
-    canvasElementTags: string[];
-    priority?: UPDATE_PRIORITY;
-    duration?: number;
-}
-interface IClassWithArgsHistoryForExport<TArgs extends TickerArgsType> {
-    className: TickerTagType;
-    args: TArgs;
-    canvasElementTags: string[];
-    priority?: UPDATE_PRIORITY;
-    duration?: number;
-}
-
-/**
- * Interface exported canvas
- */
-interface ExportedCanvas {
-    currentTickers: IClassWithArgsHistoryForExport<any>[];
-    currentElements: {
-        [tag: string]: ICanvasBaseMemory;
-    };
-    childrenTagsOrder: string[];
-}
-
-/**
- * Interface exported storage data
- */
-interface ExportedStorage {
-    storage: {
-        [key: string]: StorageElementType;
-    };
-    stepOidUsedList: string[];
-}
-
-interface IOpenedLabel {
-    label: LabelTagType;
-    currentStepIndex: number;
-}
-
-/**
- * IHistoryStep is a interface that contains:
- * - the browser path that occurred during the progression of the steps.
- * - the storage that occurred during the progression of the steps.
- * - the step data.
- * - the canvas that occurred during the progression of the steps.
- */
-interface IHistoryStep {
-    path: string;
-    storage: ExportedStorage;
-    stepSha1: StepHistoryDataType;
-    stepIndex: number;
-    canvas: ExportedCanvas;
-    openedLabels: IOpenedLabel[];
-}
-
-/**
- * Interface exported step data
- */
-interface ExportedStep {
-    stepsHistory: IHistoryStep[];
-    openedLabels: IOpenedLabel[];
-}
-
-interface ISaveData {
-    version: string;
-    stepData: ExportedStep;
-    storageData: ExportedStorage;
-    canvasData: ExportedCanvas;
-    path: string;
-}
+declare function showImageWithDissolveTransition(tag: string, imageUrl: string, speed: number, priority?: UPDATE_PRIORITY): Promise<void>;
 
 /**
  * Get the save data
@@ -921,7 +1031,7 @@ declare function getSaveJson(): string;
  * @param data The save data
  * @param navigate The function to navigate to a path
  */
-declare function loadSave(data: ISaveData, navigate: (path: string) => void): void;
+declare function loadSaveData(data: ISaveData, navigate: (path: string) => void): void;
 /**
  * Load the save data from a JSON string
  * @param dataString The save data as a JSON string
@@ -940,7 +1050,7 @@ declare function loadSave(data: ISaveData, navigate: (path: string) => void): vo
  *             reader.onload = (e) => {
  *                 const jsonString = e.target?.result as string;
  *                 // load the save data from the JSON string
- *                 loadSaveJsonString(jsonString, navigate);
+ *                 loadSaveJson(jsonString, navigate);
  *                 afterLoad && afterLoad();
  *             };
  *             reader.readAsText(file);
@@ -950,7 +1060,7 @@ declare function loadSave(data: ISaveData, navigate: (path: string) => void): vo
  * }
  * ```
  */
-declare function loadSaveJsonString(dataString: string, navigate: (path: string) => void): void;
+declare function loadSaveJson(dataString: string, navigate: (path: string) => void): void;
 
 /**
  * Get a texture from a url.
@@ -959,42 +1069,8 @@ declare function loadSaveJsonString(dataString: string, navigate: (path: string)
  */
 declare function getTexture(imageUrl: string): Promise<Texture | void>;
 
-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
-     */
-    ticker: string;
-    /**
-     * Duration in milliseconds
-     */
-    duration: number;
-}
-/**
- * The steps of the tickers
- */
-interface ITickersSteps {
-    /**
-     * The step number
-     */
-    currentStepNumber: number;
-    /**
-     * The steps of the tickers
-     */
-    steps: (ITickersStep<any> | RepeatType | PauseType)[];
-}
-
 /**
- * GameHistoryManager is a class that contains the history of the game.
+ * GameStepManager is a class that manages the steps and labels of the game.
  */
 declare class GameStepManager {
     private constructor();
@@ -1002,8 +1078,16 @@ declare class GameStepManager {
      * stepHistory is a list of label events and steps that occurred during the progression of the steps.
      */
     private static _stepsHistory;
-    static get stepsHistory(): IHistoryStep[];
+    static get stepsHistory(): IHistoryStep<DialogueModelBase>[];
+    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[];
     /**
@@ -1011,13 +1095,16 @@ declare class GameStepManager {
      */
     private static get currentLabel();
     /**
-     * currentLabelStepIndex is the current step index of the current label that occurred during the progression of the steps.
+     * is the current step index of the current label that occurred during the progression of the steps.
      */
     private static get currentLabelStepIndex();
     /**
      * 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.
@@ -1032,11 +1119,11 @@ declare class GameStepManager {
      * Close the current label and add it to the history.
      * @returns
      */
-    private static closeLabel;
+    static closeCurrentLabel(): void;
     /**
      * Close all labels and add them to the history.
      */
-    private static closeAllLabels;
+    static closeAllLabels(): void;
     /**
      * Increase the current step index of the current label.
      */
@@ -1102,7 +1189,7 @@ declare class GameStepManager {
      * ```
      */
     static goBack(navigate: (path: string) => void, steps?: number): void;
-    private static goBackInstrnal;
+    private static goBackInternal;
     /**
      * Add a label to the history.
      */
@@ -1130,19 +1217,15 @@ declare class GameStepManager {
 }
 
 declare class GameStorageManager {
-    private static oidsUsed;
     private static storage;
     private constructor();
     static get keysSystem(): {
         CURRENT_DIALOGUE_MEMORY_KEY: string;
         LAST_DIALOGUE_ADDED_IN_STEP_MEMORY_KEY: string;
         CURRENT_MENU_OPTIONS_MEMORY_KEY: string;
+        LAST_MENU_OPTIONS_ADDED_IN_STEP_MEMORY_KEY: string;
+        CHARACTER_PREKEY: string;
     };
-    /**
-     * Get a new oid that is not used yet
-     * @returns A new oid that is not used yet
-     */
-    static getNewOid(): string;
     /**
      * Set a variable in the storage
      * @param key The key of the variable
@@ -1221,7 +1304,7 @@ declare class GameWindowManager {
      * Add the canvas into a html element.
      * @param element it is the html element where I will put the canvas. Example: document.body
      */
-    static addCanvasIntoElement(element: HTMLElement): void;
+    private static addCanvasIntoElement;
     /**
      * Initialize the interface div and add it into a html element.
      * @param element it is the html element where I will put the interface div. Example: document.getElementById('root')
@@ -1424,4 +1507,4 @@ declare class GameWindowManager {
     static import(data: object): void;
 }
 
-export { CanvasBase, CanvasContainer, CanvasEvent, type CanvasEventNamesType, CanvasImage, CanvasSprite, CanvasText, CharacterModelBase, DialogueModelBase, type ExportedCanvas, type ExportedStep, type ExportedStorage, GameStepManager, GameStorageManager, GameWindowManager, type ICanvasBaseMemory, type ICanvasContainerMemory, type ICanvasImageMemory, type ICanvasSpriteBaseMemory, type ICanvasSpriteMemory, type ICanvasTextMemory as ICanvasTextTextMemory, type IClassWithArgsHistory, type IClassWithArgsHistoryForExport, type IHistoryStep, type IOpenedLabel, type ISaveData, type ITextureMemory, type ITicker, type ITickersSteps, Label, LabelRunModeEnum, MenuOptionLabel, type MenuOptionsType, Pause, type PauseType, PauseValueType, Repeat, type RepeatType, type StepLabelType, type StorageElementType, StoredClassModel, TickerBase, TickerFadeAlpha, type TickerProgrationType, TickerRotate, addImage, canvasElementDecorator, clearAllGameDatas, clearDialogue, clearMenuOptions, eventDecorator, getCharacterByTag, getDialogue, getDialogueHistory, getMenuOptions, getSaveData, getSaveJson, getTexture, labelDecorator, loadSave, loadSaveJsonString, removeCanvasElement, saveCharacter, setDialogue, setMenuOptions, showCanvasImages, showImageWithDisolveEffect, tickerDecorator };
+export { CanvasBase, CanvasContainer, CanvasEvent, type CanvasEventNamesType, CanvasImage, CanvasSprite, CanvasText, CharacterModelBase, ChoiceMenuOptionLabel, type ChoiceMenuOptionsType, DialogueModelBase, type ExportedCanvas, type ExportedStep, type ExportedStorage, GameStepManager, GameStorageManager, GameWindowManager, type ICanvasBaseMemory, type ICanvasContainerMemory, type ICanvasImageMemory, type ICanvasSpriteBaseMemory, type ICanvasSpriteMemory, type ICanvasTextMemory as ICanvasTextTextMemory, type IClassWithArgsHistory, type IClassWithArgsHistoryForExport, type IDialogueHistory, type IHistoryStep, type IHistoryStepData, type IOpenedLabel, type ISaveData, type ITextureMemory, type ITicker, type ITickersSteps, Label, LabelRunModeEnum, Pause, type PauseType, PauseValueType, Repeat, type RepeatType, type StepLabelType, type StorageElementType, StoredClassModel, TickerBase, TickerFadeAlpha, type TickerProgrationType, TickerRotate, addImage, canvasElementDecorator, clearAllGameDatas, clearChoiceMenuOptions, clearDialogue, eventDecorator, getCharacterById, getChoiceMenuOptions, getDialogue, getDialogueHistory, getSaveData, getSaveJson, getTexture, labelDecorator, loadSaveData, loadSaveJson, removeCanvasElement, saveCharacter, setChoiceMenuOptions, setDialogue, showCanvasImages, showImageWithDissolveTransition, tickerDecorator };