@drincs/pixi-vn 0.6.2 → 0.6.3

package/dist/labels/BaseCanvasElementTestLabel.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var pixi_js = require('pixi.js');
-require('deep-diff');
+var deepDiff = require('deep-diff');
 var sha1 = require('crypto-js/sha1');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
@@ -77,17 +77,19 @@ function getTexture(imageUrl) {
     });
   });
 }
-function getTextStyle(style) {
-  let fill = style.fill;
-  if (fill instanceof Object) {
-    console.warn("[Pixi'VN] CanvasText.style.fill is a FillGradient or FillPattern, this is not supported yet.", fill);
-    fill = "#00FF00";
+function getFillGradientFillPattern(prop, propName) {
+  if (!(prop instanceof Object)) {
+    return prop;
   }
+  console.warn(`[Pixi'VN] CanvasText.style.${propName} is a FillGradient or FillPattern, this is not supported yet.`, prop);
+  return void 0;
+}
+function getTextStyle(style) {
   return {
     align: style.align,
     breakWords: style.breakWords,
     dropShadow: style.dropShadow,
-    fill,
+    fill: getFillGradientFillPattern(style.stroke, "fill"),
     fontFamily: style.fontFamily,
     fontSize: style.fontSize,
     fontStyle: style.fontStyle,
@@ -97,7 +99,7 @@ function getTextStyle(style) {
     letterSpacing: style.letterSpacing,
     lineHeight: style.lineHeight,
     padding: style.padding,
-    stroke: style.stroke,
+    stroke: getFillGradientFillPattern(style.stroke, "stroke"),
     textBaseline: style.textBaseline,
     trim: style.trim,
     whiteSpace: style.whiteSpace,
@@ -144,7 +146,7 @@ var CanvasSprite = class _CanvasSprite extends pixi_js.Sprite {
     super(options);
     this.pixivnId = CANVAS_SPRITE_ID;
     this._onEvents = {};
-    this.pixivnId = this.constructor.prototype.pixivnId;
+    this.pixivnId = this.constructor.prototype.pixivnId || CANVAS_SPRITE_ID;
   }
   get memory() {
     return getMemorySprite(this);
@@ -300,7 +302,7 @@ var CanvasText = class extends pixi_js.Text {
     super(options);
     this.pixivnId = CANVAS_TEXT_ID;
     this._onEvents = {};
-    this.pixivnId = this.constructor.prototype.pixivnId;
+    this.pixivnId = this.constructor.prototype.pixivnId || CANVAS_TEXT_ID;
   }
   get memory() {
     return getMemoryText(this);
@@ -452,7 +454,7 @@ var CanvasContainer = class extends pixi_js.Container {
   constructor(options) {
     super(options);
     this.pixivnId = CANVAS_CONTAINER_ID;
-    this.pixivnId = this.constructor.prototype.pixivnId;
+    this.pixivnId = this.constructor.prototype.pixivnId || CANVAS_CONTAINER_ID;
   }
   get memory() {
     let memory = getMemoryContainer(this);
@@ -490,7 +492,6 @@ function getMemoryContainer(element) {
     position: { x: element.position.x, y: element.position.y },
     skew: { x: element.skew.x, y: element.skew.y },
     visible: element.visible,
-    culled: element.culled,
     x: element.x,
     y: element.y,
     boundsArea: element.boundsArea,
@@ -528,7 +529,6 @@ function setMemoryContainer(element, memory) {
   memory.position && element.position.set(memory.position.x, memory.position.y);
   memory.skew && element.skew.set(memory.skew.x, memory.skew.y);
   memory.visible && (element.visible = memory.visible);
-  memory.culled && (element.culled = memory.culled);
   memory.x && (element.x = memory.x);
   memory.y && (element.y = memory.y);
   memory.boundsArea && (element.boundsArea = memory.boundsArea);
@@ -538,6 +538,23 @@ function setMemoryContainer(element, memory) {
   memory.interactiveChildren && (element.interactiveChildren = memory.interactiveChildren);
   memory.hitArea && (element.hitArea = memory.hitArea);
 }
+
+// src/decorators/CharacterDecorator.ts
+var registeredCharacters = {};
+function saveCharacter(character) {
+  if (Array.isArray(character)) {
+    character.forEach((c) => saveCharacter(c));
+    return;
+  }
+  if (registeredCharacters[character.id]) {
+    console.info(`[Pixi'VN] Character id ${character.id} already exists, it will be overwritten`);
+  }
+  registeredCharacters[character.id] = character;
+}
+function getStepSha1(step) {
+  let sha1String = sha1__default.default(step.toString().toLocaleLowerCase());
+  return sha1String.toString();
+}
 function checkIfStepsIsEqual(step1, step2) {
   return step1 === step2;
 }
@@ -608,8 +625,70 @@ var Label = class {
     return this._choiseIndex;
   }
 };
-function clearDialogue() {
-  GameStorageManager.setVariable(GameStorageManager.keysSystem.CURRENT_DIALOGUE_MEMORY_KEY, void 0);
+
+// src/classes/CloseLabel.ts
+var CLOSE_LABEL_ID = "__close-label-id__";
+function newCloseLabel(choiseIndex) {
+  return new Label(CLOSE_LABEL_ID, [], void 0, choiseIndex);
+}
+
+// src/types/CloseType.ts
+var Close = "close";
+
+// src/functions/DialogueUtility.ts
+function setDialogue(props) {
+  let text = "";
+  let character = void 0;
+  let dialogue;
+  if (typeof props === "string") {
+    text = props;
+    dialogue = new DialogueBaseModel(text, character);
+  } else if (!(props instanceof DialogueBaseModel)) {
+    text = props.text;
+    if (props.character) {
+      if (typeof props.character === "string") {
+        character = props.character;
+      } else {
+        character = props.character.id;
+      }
+    }
+    dialogue = new DialogueBaseModel(text, character);
+  } else {
+    dialogue = props;
+  }
+  GameStorageManager.setVariable(GameStorageManager.keysSystem.CURRENT_DIALOGUE_MEMORY_KEY, dialogue);
+  GameStorageManager.setVariable(GameStorageManager.keysSystem.LAST_DIALOGUE_ADDED_IN_STEP_MEMORY_KEY, GameStepManager.lastStepIndex);
+}
+function getDialogue() {
+  return GameStorageManager.getVariable(GameStorageManager.keysSystem.CURRENT_DIALOGUE_MEMORY_KEY);
+}
+function getChoiceMenuOptions() {
+  let d = GameStorageManager.getVariable(GameStorageManager.keysSystem.CURRENT_MENU_OPTIONS_MEMORY_KEY);
+  if (d) {
+    let options = [];
+    d.forEach((option, index) => {
+      if (option.type === Close) {
+        let itemLabel = newCloseLabel(index);
+        options.push({
+          text: option.text,
+          label: itemLabel,
+          type: Close,
+          closeCurrentLabel: option.closeCurrentLabel,
+          props: {}
+        });
+        return;
+      }
+      let label = getLabelById(option.label);
+      if (label) {
+        let itemLabel = new Label(label.id, label.steps, label.onStepRun, index);
+        options.push(__spreadProps(__spreadValues({}, option), {
+          label: itemLabel
+        }));
+      }
+    });
+    return options;
+  }
+  return void 0;
 }
 
 // src/functions/TickerUtility.ts
@@ -795,6 +874,47 @@ function createExportableElement(element) {
   }
 }
 
+// src/functions/DiffUtility.ts
+function restoreDeepDiffChanges(data, differences) {
+  let result = createExportableElement(data);
+  differences.forEach((diff2) => {
+    let dataToEdit = result;
+    if (diff2.path && diff2.path.length > 0) {
+      diff2.path.forEach((path, index) => {
+        if (diff2.path && index === diff2.path.length - 1) {
+          if (diff2.kind === "E" || diff2.kind === "D") {
+            dataToEdit[path] = diff2.lhs;
+          } else if (diff2.kind === "N") {
+            if (Number.isInteger(path)) {
+              if (Array.isArray(dataToEdit)) {
+                dataToEdit.splice(path, 1);
+              }
+            } else if (typeof path === "string") {
+              delete dataToEdit[path];
+            }
+          } else if (diff2.kind === "A") {
+            let index2 = diff2.index;
+            if (diff2.item.kind === "N") {
+              dataToEdit[path].splice(index2, 1);
+            } else if (diff2.item.kind === "E" || diff2.item.kind === "D") {
+              dataToEdit[path][index2] = diff2.item.lhs;
+            } else if (diff2.item.kind === "A") {
+              console.warn("[Pixi'VN] Nested array found, skipping diff", diff2);
+            } else {
+              console.warn("[Pixi'VN] No array found, skipping diff", diff2);
+            }
+          }
+        } else {
+          dataToEdit = dataToEdit[path];
+        }
+      });
+    } else {
+      console.warn("[Pixi'VN] No path found, skipping diff", diff2);
+    }
+  });
+  return result;
+}
+
 // src/managers/StorageManager.ts
 var _GameStorageManager = class _GameStorageManager {
   constructor() {
@@ -975,7 +1095,7 @@ var _GameWindowManager = class _GameWindowManager {
         height
       }, options)).then(() => {
         _GameWindowManager._isInitialized = true;
-        this.addCanvasIntoElement(element);
+        this.addCanvasIntoHTMLElement(element);
         window.addEventListener("resize", _GameWindowManager.resize);
         _GameWindowManager.resize();
         asciiArtLog();
@@ -986,7 +1106,7 @@ var _GameWindowManager = 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) {
+  static addCanvasIntoHTMLElement(element) {
     if (_GameWindowManager.isInitialized) {
       element.appendChild(_GameWindowManager.app.canvas);
     } else {
@@ -1644,6 +1764,752 @@ _GameWindowManager._currentTickersSteps = {};
 _GameWindowManager._currentTickersTimeouts = {};
 var GameWindowManager = _GameWindowManager;
 
+// src/managers/StepManager.ts
+var _GameStepManager = class _GameStepManager {
+  constructor() {
+  }
+  static get stepsHistory() {
+    return _GameStepManager._stepsHistory;
+  }
+  /**
+   * 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() {
+    return _GameStepManager._lastStepIndex;
+  }
+  /**
+   * Increase the last step index that occurred during the progression of the steps.
+   */
+  static increaseLastStepIndex() {
+    _GameStepManager._lastStepIndex++;
+  }
+  static get openedLabels() {
+    return _GameStepManager._openedLabels;
+  }
+  /**
+   * currentLabelId is the current label id that occurred during the progression of the steps.
+   */
+  static get currentLabelId() {
+    if (_GameStepManager._openedLabels.length > 0) {
+      let item = _GameStepManager._openedLabels[_GameStepManager._openedLabels.length - 1];
+      return item.label;
+    }
+    return void 0;
+  }
+  /**
+   * currentLabel is the current label that occurred during the progression of the steps.
+   */
+  static get currentLabel() {
+    if (_GameStepManager.currentLabelId) {
+      return getLabelById(_GameStepManager.currentLabelId);
+    }
+  }
+  static get currentLabelStepIndex() {
+    if (_GameStepManager._openedLabels.length > 0) {
+      let item = _GameStepManager._openedLabels[_GameStepManager._openedLabels.length - 1];
+      return item.currentStepIndex;
+    }
+    return null;
+  }
+  /**
+   * lastHistoryStep is the last history step that occurred during the progression of the steps.
+   */
+  static get lastHistoryStep() {
+    if (_GameStepManager._stepsHistory.length > 0) {
+      return _GameStepManager._stepsHistory[_GameStepManager._stepsHistory.length - 1];
+    }
+    return null;
+  }
+  static get originalStepData() {
+    if (!_GameStepManager._originalStepData) {
+      return {
+        path: "",
+        storage: {},
+        canvas: {
+          childrenTagsOrder: [],
+          currentElements: {},
+          currentTickers: {},
+          currentTickersSteps: {}
+        },
+        labelIndex: -1,
+        openedLabels: []
+      };
+    }
+    return createExportableElement(_GameStepManager._originalStepData);
+  }
+  static set originalStepData(value) {
+    _GameStepManager._originalStepData = createExportableElement(value);
+  }
+  /* Edit History Methods */
+  /**
+   * Add a label to the history.
+   * @param label The label to add to the history.
+   */
+  static addStepHistory(step, choiseMade) {
+    let stepHistory = getStepSha1(step);
+    let historyStep = {
+      path: window.location.pathname,
+      storage: GameStorageManager.export(),
+      canvas: GameWindowManager.export(),
+      labelIndex: _GameStepManager.currentLabelStepIndex || 0,
+      openedLabels: createExportableElement(_GameStepManager._openedLabels)
+    };
+    if (_GameStepManager.originalStepData) {
+      if (_GameStepManager.originalStepData.openedLabels.length === historyStep.openedLabels.length) {
+        try {
+          let lastStepDataOpenedLabelsString = JSON.stringify(_GameStepManager.originalStepData.openedLabels);
+          let historyStepOpenedLabelsString = JSON.stringify(historyStep.openedLabels);
+          if (lastStepDataOpenedLabelsString === historyStepOpenedLabelsString && _GameStepManager.originalStepData.path === historyStep.path && _GameStepManager.originalStepData.labelIndex === historyStep.labelIndex) {
+            return;
+          }
+        } catch (e) {
+          console.error("[Pixi'VN] Error comparing openedLabels", e);
+        }
+      }
+    }
+    let data = deepDiff.diff(_GameStepManager.originalStepData, historyStep);
+    if (data) {
+      let dialoge = void 0;
+      let requiredChoices = void 0;
+      if (GameStorageManager.getVariable(GameStorageManager.keysSystem.LAST_DIALOGUE_ADDED_IN_STEP_MEMORY_KEY) === _GameStepManager.lastStepIndex) {
+        dialoge = getDialogue();
+      }
+      if (GameStorageManager.getVariable(GameStorageManager.keysSystem.LAST_MENU_OPTIONS_ADDED_IN_STEP_MEMORY_KEY) === _GameStepManager.lastStepIndex) {
+        requiredChoices = GameStorageManager.getVariable(GameStorageManager.keysSystem.CURRENT_MENU_OPTIONS_MEMORY_KEY);
+      }
+      _GameStepManager._stepsHistory.push({
+        diff: data,
+        currentLabel: _GameStepManager.currentLabelId,
+        dialoge,
+        choices: requiredChoices,
+        stepSha1: stepHistory,
+        index: _GameStepManager.lastStepIndex,
+        choiceIndexMade: choiseMade
+      });
+      _GameStepManager.originalStepData = historyStep;
+    }
+    _GameStepManager.increaseLastStepIndex();
+  }
+  /**
+   * Add a label to the history.
+   * @param label The label to add to the history.
+   */
+  static pushNewLabel(label) {
+    let currentLabel = getLabelById(label);
+    if (!currentLabel) {
+      throw new Error(`[Pixi'VN] Label ${label} not found`);
+    }
+    _GameStepManager._openedLabels.push({
+      label,
+      currentStepIndex: 0
+    });
+  }
+  /**
+   * Close the current label and add it to the history.
+   * @returns 
+   */
+  static closeCurrentLabel() {
+    if (!_GameStepManager.currentLabelId) {
+      console.warn("[Pixi'VN] No label to close");
+      return;
+    }
+    if (!_GameStepManager.currentLabel) {
+      console.error("[Pixi'VN] currentLabel not found");
+      return;
+    }
+    _GameStepManager._openedLabels.pop();
+  }
+  /**
+   * Close all labels and add them to the history. **Attention: This method can cause an unhandled game ending.**
+   */
+  static closeAllLabels() {
+    while (_GameStepManager._openedLabels.length > 0) {
+      _GameStepManager.closeCurrentLabel();
+    }
+  }
+  /**
+   * Increase the current step index of the current label.
+   */
+  static increaseCurrentStepIndex() {
+    let item = _GameStepManager._openedLabels[_GameStepManager._openedLabels.length - 1];
+    _GameStepManager._openedLabels[_GameStepManager._openedLabels.length - 1] = __spreadProps(__spreadValues({}, item), {
+      currentStepIndex: item.currentStepIndex + 1
+    });
+  }
+  static restorLastLabelList() {
+    _GameStepManager._openedLabels = _GameStepManager.originalStepData.openedLabels;
+  }
+  /* Run Methods */
+  static get canGoNext() {
+    let options = getChoiceMenuOptions();
+    if (options && options.length > 0) {
+      return false;
+    }
+    return true;
+  }
+  /**
+   * Execute the next step and add it to the history.
+   * @param props The props to pass to the step.
+   * @param choiseMade The index of the choise made by the player. (This params is used in the choice menu)
+   * @returns StepLabelResultType or undefined.
+   * @example
+   * ```typescript
+   *     function nextOnClick() {
+   *     setLoading(true)
+   *     GameStepManager.goNext(yourParams)
+   *         .then((result) => {
+   *             setUpdate((p) => p + 1)
+   *             setLoading(false)
+   *             if (result) {
+   *                 // your code
+   *             }
+   *         })
+   *         .catch((e) => {
+   *             setLoading(false)
+   *             console.error(e)
+   *         })
+   * }
+   * ```
+   */
+  static goNext(props, choiseMade) {
+    return __async(this, null, function* () {
+      if (!_GameStepManager.canGoNext) {
+        console.warn("[Pixi'VN] The player must make a choice");
+        return;
+      }
+      _GameStepManager.increaseCurrentStepIndex();
+      return yield _GameStepManager.runCurrentStep(props, choiseMade);
+    });
+  }
+  /**
+   * Execute the current step and add it to the history.
+   * @param props The props to pass to the step.
+   * @param choiseMade The choise made by the player.
+   * @returns StepLabelResultType or undefined.
+   */
+  static runCurrentStep(props, choiseMade) {
+    return __async(this, null, function* () {
+      if (_GameStepManager.currentLabelId) {
+        let currentLabelStepIndex = _GameStepManager.currentLabelStepIndex;
+        if (currentLabelStepIndex === null) {
+          console.error("[Pixi'VN] currentLabelStepIndex is null");
+          return;
+        }
+        let currentLabel = _GameStepManager.currentLabel;
+        if (!currentLabel) {
+          console.error("[Pixi'VN] currentLabel not found");
+          return;
+        }
+        if (currentLabel.steps.length > currentLabelStepIndex) {
+          let step = currentLabel.steps[currentLabelStepIndex];
+          let result = yield step(props);
+          _GameStepManager.addStepHistory(step, choiseMade);
+          return result;
+        } else if (_GameStepManager.openedLabels.length > 1) {
+          _GameStepManager.closeCurrentLabel();
+          return yield _GameStepManager.goNext(props, choiseMade);
+        } else {
+          _GameStepManager.restorLastLabelList();
+          console.error("[Pixi'VN] The end of the game is not managed, so the game is blocked. Read this documentation to know how to manage the end of the game: https://pixi-vn.web.app/start/labels.html#how-manage-the-end-of-the-game");
+          return;
+        }
+      }
+    });
+  }
+  /**
+   * Execute the label and add it to the history. (It's similar to Ren'Py's call function)
+   * @param label The label to execute or the id of the label
+   * @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, props) {
+    return __async(this, null, function* () {
+      let choiseMade = void 0;
+      let labelId;
+      if (typeof label === "string") {
+        labelId = label;
+      } else {
+        labelId = label.id;
+        if (typeof label.choiseIndex === "number") {
+          choiseMade = label.choiseIndex;
+        }
+      }
+      try {
+        if (labelId === CLOSE_LABEL_ID) {
+          let closeCurrentLabel = newCloseLabel(choiseMade);
+          let choice = {
+            label: closeCurrentLabel,
+            text: "",
+            closeCurrentLabel: false,
+            type: "close",
+            props: {}
+          };
+          return _GameStepManager.closeChoiceMenu(choice, props);
+        }
+        let tempLabel = getLabelById(labelId);
+        if (!tempLabel) {
+          throw new Error(`[Pixi'VN] Label ${labelId} not found`);
+        }
+        _GameStepManager.pushNewLabel(tempLabel.id);
+      } catch (e) {
+        console.error("[Pixi'VN] Error calling label", e);
+        return;
+      }
+      return yield _GameStepManager.runCurrentStep(props, choiseMade);
+    });
+  }
+  /**
+   * Execute the label, close the current label, execute the new label and add the new label to the history. (It's similar to Ren'Py's jump function)
+   * @param label The label to execute.
+   * @param props The props to pass to the label or the id of 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, props) {
+    return __async(this, null, function* () {
+      _GameStepManager.closeCurrentLabel();
+      let choiseMade = void 0;
+      let labelId;
+      if (typeof label === "string") {
+        labelId = label;
+      } else {
+        labelId = label.id;
+        if (typeof label.choiseIndex === "number") {
+          choiseMade = label.choiseIndex;
+        }
+      }
+      try {
+        if (labelId === CLOSE_LABEL_ID) {
+          let closeCurrentLabel = newCloseLabel(choiseMade);
+          let choice = {
+            label: closeCurrentLabel,
+            text: "",
+            closeCurrentLabel: false,
+            type: "close",
+            props: {}
+          };
+          return _GameStepManager.closeChoiceMenu(choice, props);
+        }
+        let tempLabel = getLabelById(labelId);
+        if (!tempLabel) {
+          throw new Error(`[Pixi'VN] Label ${labelId} not found`);
+        }
+        _GameStepManager.pushNewLabel(tempLabel.id);
+      } catch (e) {
+        console.error("[Pixi'VN] Error jumping label", e);
+        return;
+      }
+      return yield _GameStepManager.runCurrentStep(props, choiseMade);
+    });
+  }
+  /**
+   * When the player is in a choice menu, can use this function to exit to the choice menu.
+   * @param choice
+   * @param props
+   * @returns StepLabelResultType or undefined.
+   * @example
+   * ```typescript
+   * GameStepManager.closeChoiceMenu(yourParams).then((result) => {
+   *     if (result) {
+   *         // your code
+   *     }
+   * })
+   * ```
+   */
+  static closeChoiceMenu(choice, props) {
+    return __async(this, null, function* () {
+      let label = choice.label;
+      let choiseMade = void 0;
+      if (typeof label.choiseIndex === "number") {
+        choiseMade = label.choiseIndex;
+      }
+      if (choice.closeCurrentLabel) {
+        _GameStepManager.closeCurrentLabel();
+      }
+      return _GameStepManager.goNext(props, choiseMade);
+    });
+  }
+  /* After Update Methods */
+  // /**
+  //  * After the update or code edit, some steps or labels may no longer match.
+  //  * - In case of step mismatch, the game will be updated to the last matching step.
+  //  * - In case of label mismatch, the game gives an error.
+  //  * @returns 
+  //  */
+  // private static afterUpdate() {
+  //     // TODO: implement
+  //     if (!GameStepManager.currentLabel) {
+  //         // TODO: implement
+  //         return
+  //     }
+  //     let currentLabel = getLabelInstanceByClassName(GameStepManager.currentLabel)
+  //     if (!currentLabel) {
+  //         console.error("Label not found")
+  //         return
+  //     }
+  //     let oldSteps = GameStepManager.stepsAfterLastHistoryLabel
+  //     let currentStepIndex = currentLabel.getCorrespondingStepsNumber(oldSteps)
+  //     let stepToRemove = oldSteps.length - currentStepIndex
+  //     GameStepManager.removeLastHistoryNodes(stepToRemove)
+  //     GameStepManager.loadLastStep()
+  // }
+  // private static loadLastStep() {
+  //     // TODO: implement
+  // }
+  // /**
+  //  * Remove a number of items from the last of the history.
+  //  * @param itemNumber The number of items to remove from the last of the history.
+  //  */
+  // private static removeLastHistoryNodes(itemNumber: number) {
+  //     // TODO: implement
+  //     for (let i = 0; i < itemNumber; i++) {
+  //         GameStepManager._stepsHistory.pop()
+  //     }
+  // }
+  // /**
+  //  * stepsAfterLastHistoryLabel is a list of steps that occurred after the last history label.
+  //  */
+  // private static get stepsAfterLastHistoryLabel(): StepHistoryDataType[] {
+  //     let length = GameStepManager._stepsHistory.length
+  //     let steps: StepHistoryDataType[] = []
+  //     for (let i = length - 1; i >= 0; i--) {
+  //         let element = GameStepManager._stepsHistory[i]
+  //         if (typeof element === "object" && "stepSha1" in element) {
+  //             steps.push(element.stepSha1)
+  //         }
+  //         else {
+  //             break
+  //         }
+  //     }
+  //     steps = steps.reverse()
+  //     return steps
+  // }
+  /* Go Back & Refresh Methods */
+  /**
+   * 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, steps = 1) {
+    if (steps <= 0) {
+      console.warn("[Pixi'VN] Steps must be greater than 0");
+      return;
+    }
+    if (_GameStepManager._stepsHistory.length <= 1) {
+      console.warn("[Pixi'VN] No steps to go back");
+      return;
+    }
+    let restoredStep = _GameStepManager.goBackInternal(steps, _GameStepManager.originalStepData);
+    if (restoredStep) {
+      _GameStepManager._originalStepData = restoredStep;
+      _GameStepManager._openedLabels = createExportableElement(restoredStep.openedLabels);
+      GameStorageManager.import(createExportableElement(restoredStep.storage));
+      GameWindowManager.import(createExportableElement(restoredStep.canvas));
+      navigate(restoredStep.path);
+    } else {
+      console.error("[Pixi'VN] Error going back");
+    }
+  }
+  static goBackInternal(steps, restoredStep) {
+    if (steps <= 0) {
+      return restoredStep;
+    }
+    if (_GameStepManager._stepsHistory.length == 0) {
+      return restoredStep;
+    }
+    let lastHistoryStep = _GameStepManager.lastHistoryStep;
+    if (lastHistoryStep) {
+      try {
+        let result = restoreDeepDiffChanges(restoredStep, lastHistoryStep.diff);
+        _GameStepManager._lastStepIndex = lastHistoryStep.index;
+        _GameStepManager._stepsHistory.pop();
+        return _GameStepManager.goBackInternal(steps - 1, result);
+      } catch (e) {
+        console.error("[Pixi'VN] Error applying diff", e);
+        return restoredStep;
+      }
+    } else {
+      return restoredStep;
+    }
+  }
+  /**
+   * Return true if it is possible to go back.
+   */
+  static get canGoBack() {
+    return _GameStepManager._stepsHistory.length > 1;
+  }
+  /**
+   * Add a label to the history.
+   */
+  static clear() {
+    _GameStepManager._stepsHistory = [];
+    _GameStepManager._openedLabels = [];
+  }
+  /* Export and Import Methods */
+  /**
+   * Export the history to a JSON string.
+   * @returns The history in a JSON string.
+   */
+  static exportJson() {
+    return JSON.stringify(this.export());
+  }
+  /**
+   * Export the history to an object.
+   * @returns The history in an object.
+   */
+  static export() {
+    return {
+      stepsHistory: _GameStepManager._stepsHistory,
+      openedLabels: _GameStepManager._openedLabels,
+      lastStepIndex: _GameStepManager._lastStepIndex,
+      originalStepData: _GameStepManager._originalStepData
+    };
+  }
+  /**
+   * Import the history from a JSON string.
+   * @param dataString The history in a JSON string.
+   */
+  static importJson(dataString) {
+    _GameStepManager.import(JSON.parse(dataString));
+  }
+  /**
+   * Import the history from an object.
+   * @param data The history in an object.
+   */
+  static import(data) {
+    _GameStepManager.clear();
+    try {
+      if (data.hasOwnProperty("stepsHistory")) {
+        _GameStepManager._stepsHistory = data["stepsHistory"];
+      } else {
+        console.warn("[Pixi'VN] Could not import stepsHistory data, so will be ignored");
+      }
+      if (data.hasOwnProperty("openedLabels")) {
+        _GameStepManager._openedLabels = data["openedLabels"];
+      } else {
+        console.warn("[Pixi'VN] Could not import openedLabels data, so will be ignored");
+      }
+      if (data.hasOwnProperty("lastStepIndex")) {
+        _GameStepManager._lastStepIndex = data["lastStepIndex"];
+      } else {
+        console.warn("[Pixi'VN] Could not import lastStepIndex data, so will be ignored");
+      }
+      if (data.hasOwnProperty("originalStepData")) {
+        _GameStepManager._originalStepData = data["originalStepData"];
+      } else {
+        console.warn("[Pixi'VN] Could not import originalStepData data, so will be ignored");
+      }
+    } catch (e) {
+      console.error("[Pixi'VN] Error importing data", e);
+    }
+  }
+};
+/**
+ * stepHistory is a list of label events and steps that occurred during the progression of the steps.
+ */
+_GameStepManager._stepsHistory = [];
+_GameStepManager._lastStepIndex = 0;
+_GameStepManager._openedLabels = [];
+_GameStepManager._originalStepData = void 0;
+var GameStepManager = _GameStepManager;
+
+// src/classes/StoredClassModel.ts
+var StoredClassModel = class {
+  /**
+   * @param categoryId The id of the category. For example if you are storing a character class, you can use "characters" as categoryId. so all instances of the character class will be stored in the "characters" category.
+   * @param id The id of instance of the class. This id must be unique for the category.
+   */
+  constructor(categoryId, id) {
+    this.categoryId = categoryId;
+    this._id = id;
+  }
+  /**
+   * Is id of the stored class. is unique for this class.
+   */
+  get id() {
+    return this._id;
+  }
+  /**
+   * Update a property in the storage.
+   * @param propertyName The name of the property to set.
+   * @param value The value to set. If is undefined, the property will be removed from the storage.
+   */
+  setStorageProperty(propertyName, value) {
+    let storage = GameStorageManager.getVariable(this.categoryId);
+    if (!storage) {
+      storage = {};
+    }
+    if (!storage.hasOwnProperty(this.id)) {
+      storage[this.id] = {};
+    }
+    if (value === void 0 || value === null) {
+      if (storage[this.id].hasOwnProperty(propertyName)) {
+        delete storage[this.id][propertyName];
+      }
+    } else {
+      storage[this.id] = __spreadProps(__spreadValues({}, storage[this.id]), { [propertyName]: value });
+    }
+    if (Object.keys(storage[this.id]).length === 0) {
+      delete storage[this.id];
+    }
+    GameStorageManager.setVariable(this.categoryId, storage);
+  }
+  /**
+   * Get a property from the storage.
+   * @param propertyName The name of the property to get.
+   * @returns The value of the property. If the property is not found, returns undefined.
+   */
+  getStorageProperty(propertyName) {
+    let storage = GameStorageManager.getVariable(this.categoryId);
+    if (storage && storage.hasOwnProperty(this.id) && storage[this.id].hasOwnProperty(propertyName)) {
+      return storage[this.id][propertyName];
+    }
+    return void 0;
+  }
+};
+
+// src/classes/CharacterBaseModel.ts
+var CharacterBaseModel2 = class extends StoredClassModel {
+  /**
+   * @param id The id of the character.
+   * @param props The properties of the character.
+   */
+  constructor(id, props) {
+    super(GameStorageManager.keysSystem.CHARACTER_CATEGORY_KEY, id);
+    this.defaultName = "";
+    this.defaultName = props.name;
+    this.defaultSurname = props.surname;
+    this.defaultAge = props.age;
+    this._icon = props.icon;
+    this._color = props.color;
+  }
+  /***
+   * The name of the character.
+   * If you set undefined, it will return the default name.
+   */
+  get name() {
+    return this.getStorageProperty("name") || this.defaultName;
+  }
+  set name(value) {
+    this.setStorageProperty("name", value);
+  }
+  /**
+   * The surname of the character.
+   * If you set undefined, it will return the default surname.
+   */
+  get surname() {
+    return this.getStorageProperty("surname") || this.defaultSurname;
+  }
+  set surname(value) {
+    this.setStorageProperty("surname", value);
+  }
+  /**
+   * The age of the character.
+   * If you set undefined, it will return the default age.
+   */
+  get age() {
+    return this.getStorageProperty("age") || this.defaultAge;
+  }
+  set age(value) {
+    this.setStorageProperty("age", value);
+  }
+  /**
+   * The icon of the character.
+   */
+  get icon() {
+    return this._icon;
+  }
+  /**
+   * The color of the character.
+   */
+  get color() {
+    return this._color;
+  }
+};
+
+// src/classes/DialogueBaseModel.ts
+var DialogueBaseModel = class {
+  /**
+   * @param text The text of the dialogue.
+   * @param character The id of the character that is speaking. 
+   * @param oltherParams Other parameters that can be stored in the dialogue.
+   */
+  constructor(text, character, oltherParams = {}) {
+    /**
+     * The text of the dialogue.
+     */
+    this.text = "";
+    /**
+     * Other parameters that can be stored in the dialogue.
+     */
+    this.oltherParams = {};
+    if (typeof text === "string") {
+      this.text = text;
+      if (typeof character === "string") {
+        this.character = character;
+      } else {
+        this.character = character == null ? void 0 : character.id;
+      }
+      this.oltherParams = oltherParams;
+    } else {
+      this.text = text.text;
+      if (text.character) {
+        this.character = text.character;
+      }
+      this.oltherParams = text.oltherParams || {};
+    }
+  }
+  /**
+   * Export the dialogue to a DialogueBaseData object.
+   * 
+   * @returns The data of the dialogue.
+   */
+  export() {
+    return {
+      text: this.text,
+      character: this.character,
+      oltherParams: this.oltherParams
+    };
+  }
+};
+
 // src/decorators/LabelDecorator.ts
 var registeredLabels = {};
 function newLabel(id, steps, onStepRun) {
@@ -1654,6 +2520,14 @@ function newLabel(id, steps, onStepRun) {
   registeredLabels[id] = label;
   return label;
 }
+function getLabelById(id) {
+  let label = registeredLabels[id];
+  if (!label) {
+    console.error(`[Pixi'VN] Label ${id} not found`);
+    return;
+  }
+  return label;
+}
 
 // src/classes/ticker/FadeAlphaTicker.ts
 var FadeAlphaTicker = class extends TickerBase {
@@ -1800,16 +2674,31 @@ RotateTicker = __decorateClass([
   tickerDecorator()
 ], RotateTicker);
 
+// src/labels/TestConstant.ts
+var juliette = new CharacterBaseModel2("___pixivn_juliette___", {
+  name: "Juliette",
+  age: 25,
+  icon: "https://firebasestorage.googleapis.com/v0/b/pixi-vn.appspot.com/o/public%2Fcharacters%2Fjuliette-square.webp?alt=media&token=5856ae7b-d99e-4563-86ec-cbc48cc9c6b4",
+  color: "#ac0086"
+});
+saveCharacter(juliette);
+var bunnyImage = "https://pixijs.com/assets/bunny.png";
+
 // src/labels/BaseCanvasElementTestLabel.ts
+var BASE_CANVAS_ELEMENT_LABEL = "___pixi_vn_base_canvas_element_label___";
 var baseCanvasElementTestLabel = newLabel(
-  "BaseCanvasElementTestLabel",
+  BASE_CANVAS_ELEMENT_LABEL,
   [
     () => __async(void 0, null, function* () {
-      clearDialogue();
+      let number = 25;
+      setDialogue({
+        character: juliette,
+        text: `Here's what's going to happen: I'm going to create ${number} bunnies (CanvasSprites) and put them in a CanvasContainer.`
+      });
       const container = new CanvasContainer();
       GameWindowManager.addCanvasElement("container", container);
-      const texture = yield pixi_js.Assets.load("https://pixijs.com/assets/bunny.png");
-      for (let i = 0; i < 25; i++) {
+      const texture = yield pixi_js.Assets.load(bunnyImage);
+      for (let i = 0; i < number; i++) {
         const bunny = new CanvasSprite(texture);
         bunny.x = i % 5 * 40;
         bunny.y = Math.floor(i / 5) * 40;
@@ -1819,10 +2708,15 @@ var baseCanvasElementTestLabel = newLabel(
       container.y = GameWindowManager.screen.height / 2;
       container.pivot.x = container.width / 2;
       container.pivot.y = container.height / 2;
-      GameWindowManager.addTicker("container", new RotateTicker({ speed: 0.01 }));
+      GameWindowManager.addTicker("container", new RotateTicker({ speed: 1 }));
     }),
     () => __async(void 0, null, function* () {
       removeCanvasElement("container");
+      setDialogue({
+        character: juliette,
+        text: `Here's what's going to happen: I'm going to create some text elements with different styles and put them on the stage.
+But it will generate a warn message, because the FillGradient or FillPattern has not yet been supported by the Pixi\u2019VN ( you can see the status of the issue here: [#76](https://github.com/DRincs-Productions/pixi-vn/issues/76)).`
+      });
       const basicText = new CanvasText({ text: "Basic text in pixi" });
       basicText.x = 50;
       basicText.y = 100;
@@ -1884,5 +2778,5 @@ var baseCanvasElementTestLabel = newLabel(
 );
 
 exports.baseCanvasElementTestLabel = baseCanvasElementTestLabel;
-//# sourceMappingURL=out.js.map
+//# sourceMappingURL=BaseCanvasElementTestLabel.js.map
 //# sourceMappingURL=BaseCanvasElementTestLabel.js.map