@drincs/pixi-vn 0.1.4 → 0.2.0

package/dist/index.js

@@ -107,6 +107,7 @@ __export(src_exports, {
   getChoiceMenuOptions: () => getChoiceMenuOptions,
   getDialogue: () => getDialogue,
   getDialogueHistory: () => getDialogueHistory,
+  getFlag: () => getFlag,
   getSaveData: () => getSaveData,
   getSaveJson: () => getSaveJson,
   getTexture: () => getTexture,
@@ -117,6 +118,7 @@ __export(src_exports, {
   saveCharacter: () => saveCharacter,
   setChoiceMenuOptions: () => setChoiceMenuOptions,
   setDialogue: () => setDialogue,
+  setFlag: () => setFlag,
   showCanvasImages: () => showCanvasImages,
   showImageWithDissolveTransition: () => showImageWithDissolveTransition,
   tickerDecorator: () => tickerDecorator
@@ -256,6 +258,26 @@ function getDialogueHistory() {
   return list;
 }
 
+// src/functions/FlagsUtility.ts
+function setFlag(name, value) {
+  let flags = GameStorageManager.getVariable(GameStorageManager.keysSystem.FLAGS_CATEGORY_KEY) || [];
+  if (value) {
+    if (!flags.includes(name)) {
+      flags.push(name);
+    }
+  } else {
+    let index = flags.indexOf(name);
+    if (index > -1) {
+      flags.splice(index, 1);
+    }
+  }
+  GameStorageManager.setVariable(GameStorageManager.keysSystem.FLAGS_CATEGORY_KEY, flags);
+}
+function getFlag(name) {
+  let flags = GameStorageManager.getVariable(GameStorageManager.keysSystem.FLAGS_CATEGORY_KEY) || [];
+  return flags.includes(name);
+}
+
 // src/functions/GameUtility.ts
 function clearAllGameDatas() {
   GameStorageManager.clear();
@@ -299,6 +321,17 @@ function canvasElementDecorator(name) {
 function getCanvasElementInstanceByClassName(canvasName) {
   try {
     let eventType = registeredCanvasElement[canvasName];
+    if (!eventType) {
+      if (canvasName === "CanvasContainer") {
+        eventType = CanvasContainer;
+      } else if (canvasName === "CanvasImage") {
+        eventType = CanvasImage;
+      } else if (canvasName === "CanvasSprite") {
+        eventType = CanvasSprite;
+      } else if (canvasName === "CanvasText") {
+        eventType = CanvasText;
+      }
+    }
     if (!eventType) {
       console.error(`[Pixi'VN] CanvasElement ${canvasName} not found`);
       return;
@@ -311,101 +344,6 @@ function getCanvasElementInstanceByClassName(canvasName) {
   }
 }
 
-// src/decorators/CharacterDecorator.ts
-var registeredCharacters = {};
-function saveCharacter(character) {
-  if (Array.isArray(character)) {
-    character.forEach((c) => saveCharacter(c));
-    return;
-  }
-  if (registeredCharacters[character.id]) {
-    console.warn(`[Pixi'VN] Character id ${character.id} already exists, it will be overwritten`);
-  }
-  registeredCharacters[character.id] = character;
-}
-function getCharacterById(id) {
-  try {
-    let character = registeredCharacters[id];
-    if (!character) {
-      console.error(`[Pixi'VN] Character ${id} not found`);
-      return;
-    }
-    return character;
-  } catch (e) {
-    console.error(`[Pixi'VN] Error while getting Character ${id}`, e);
-    return;
-  }
-}
-
-// src/decorators/EventDecorator.ts
-var registeredEvents = {};
-function eventDecorator(name) {
-  return function(target) {
-    if (!name) {
-      name = target.name;
-    }
-    if (registeredEvents[name]) {
-      console.warn(`[Pixi'VN] Event ${name} already exists, it will be overwritten`);
-    }
-    registeredEvents[name] = target;
-  };
-}
-function getEventTypeByClassName(eventName) {
-  try {
-    let eventType = registeredEvents[eventName];
-    if (!eventType) {
-      console.error(`[Pixi'VN] Event ${eventName} not found`);
-      return;
-    }
-    new eventType();
-    return eventType;
-  } catch (e) {
-    console.error(`[Pixi'VN] Error while getting Event ${eventName}`, e);
-    return;
-  }
-}
-function getEventInstanceByClassName(eventName) {
-  try {
-    let eventType = registeredEvents[eventName];
-    if (!eventType) {
-      console.error(`[Pixi'VN] Event ${eventName} not found`);
-      return;
-    }
-    let event = new eventType();
-    return event;
-  } catch (e) {
-    console.error(`[Pixi'VN] Error while getting Event ${eventName}`, e);
-    return;
-  }
-}
-
-// src/decorators/TickerDecorator.ts
-var registeredTickers = {};
-function tickerDecorator(name) {
-  return function(target) {
-    if (!name) {
-      name = target.name;
-    }
-    if (registeredTickers[name]) {
-      console.warn(`[Pixi'VN] Ticker ${name} already exists, it will be overwritten`);
-    }
-    registeredTickers[name] = target;
-  };
-}
-function geTickerInstanceByClassName(tickerName, args, duration, priority) {
-  try {
-    let ticker = registeredTickers[tickerName];
-    if (!ticker) {
-      console.error(`[Pixi'VN] Ticker ${tickerName} not found`);
-      return;
-    }
-    return new ticker(args, duration, priority);
-  } catch (e) {
-    console.error(`[Pixi'VN] Error while getting Ticker ${tickerName}`, e);
-    return;
-  }
-}
-
 // src/functions/CanvasUtility.ts
 function getTextureMemory(texture) {
   let sourceTexture = texture.source;
@@ -422,7 +360,7 @@ function importCanvasElement(memory) {
   if (element) {
     element.memory = memory;
   } else {
-    throw new Error("[Pixi'VN] The element " + memory.className + "could not be created");
+    throw new Error("[Pixi'VN] The element " + memory.className + " could not be created");
   }
   return element;
 }
@@ -443,9 +381,6 @@ var CanvasContainer = class extends import_pixi2.Container {
     });
   }
 };
-CanvasContainer = __decorateClass([
-  canvasElementDecorator()
-], CanvasContainer);
 function getMemoryContainer(element) {
   return {
     className: "CanvasContainer",
@@ -570,7 +505,51 @@ function getTextStyle(style) {
 
 // src/classes/canvas/CanvasSprite.ts
 var import_pixi4 = require("pixi.js");
-var CanvasSprite = class extends import_pixi4.Sprite {
+
+// src/decorators/EventDecorator.ts
+var registeredEvents = {};
+function eventDecorator(name) {
+  return function(target) {
+    if (!name) {
+      name = target.name;
+    }
+    if (registeredEvents[name]) {
+      console.warn(`[Pixi'VN] Event ${name} already exists, it will be overwritten`);
+    }
+    registeredEvents[name] = target;
+  };
+}
+function getEventTypeByClassName(eventName) {
+  try {
+    let eventType = registeredEvents[eventName];
+    if (!eventType) {
+      console.error(`[Pixi'VN] Event ${eventName} not found`);
+      return;
+    }
+    new eventType();
+    return eventType;
+  } catch (e) {
+    console.error(`[Pixi'VN] Error while getting Event ${eventName}`, e);
+    return;
+  }
+}
+function getEventInstanceByClassName(eventName) {
+  try {
+    let eventType = registeredEvents[eventName];
+    if (!eventType) {
+      console.error(`[Pixi'VN] Event ${eventName} not found`);
+      return;
+    }
+    let event = new eventType();
+    return event;
+  } catch (e) {
+    console.error(`[Pixi'VN] Error while getting Event ${eventName}`, e);
+    return;
+  }
+}
+
+// src/classes/canvas/CanvasSprite.ts
+var CanvasSprite = class _CanvasSprite extends import_pixi4.Sprite {
   constructor() {
     super(...arguments);
     this._onEvents = {};
@@ -637,14 +616,11 @@ var CanvasSprite = class extends import_pixi4.Sprite {
   }
   static from(source, skipCache) {
     let sprite = import_pixi4.Sprite.from(source, skipCache);
-    let mySprite = new CanvasSprite();
+    let mySprite = new _CanvasSprite();
     mySprite.texture = sprite.texture;
     return mySprite;
   }
 };
-CanvasSprite = __decorateClass([
-  canvasElementDecorator()
-], CanvasSprite);
 function getMemorySprite(element) {
   let temp = getMemoryContainer(element);
   return __spreadProps(__spreadValues({}, temp), {
@@ -680,7 +656,7 @@ function setMemorySprite(element, memory) {
 }
 
 // src/classes/canvas/CanvasImage.ts
-var CanvasImage = class extends CanvasSprite {
+var CanvasImage = class _CanvasImage extends CanvasSprite {
   constructor() {
     super(...arguments);
     this.imageLink = "";
@@ -696,7 +672,7 @@ var CanvasImage = class extends CanvasSprite {
   }
   static from(source, skipCache) {
     let sprite = import_pixi5.Sprite.from(source, skipCache);
-    let mySprite = new CanvasImage();
+    let mySprite = new _CanvasImage();
     mySprite.texture = sprite.texture;
     return mySprite;
   }
@@ -716,9 +692,6 @@ var CanvasImage = class extends CanvasSprite {
     });
   }
 };
-CanvasImage = __decorateClass([
-  canvasElementDecorator()
-], CanvasImage);
 
 // src/classes/canvas/CanvasText.ts
 var import_pixi6 = require("pixi.js");
@@ -788,9 +761,6 @@ var CanvasText = class extends import_pixi6.Text {
     return super.on(event, fn, context);
   }
 };
-CanvasText = __decorateClass([
-  canvasElementDecorator()
-], CanvasText);
 function getMemoryText(element) {
   let temp = getMemoryContainer(element);
   return __spreadProps(__spreadValues({}, temp), {
@@ -846,6 +816,61 @@ var TickerBase = class {
 
 // src/classes/ticker/TickerFadeAlpha.ts
 var import_pixi7 = require("pixi.js");
+
+// src/decorators/CharacterDecorator.ts
+var registeredCharacters = {};
+function saveCharacter(character) {
+  if (Array.isArray(character)) {
+    character.forEach((c) => saveCharacter(c));
+    return;
+  }
+  if (registeredCharacters[character.id]) {
+    console.warn(`[Pixi'VN] Character id ${character.id} already exists, it will be overwritten`);
+  }
+  registeredCharacters[character.id] = character;
+}
+function getCharacterById(id) {
+  try {
+    let character = registeredCharacters[id];
+    if (!character) {
+      console.error(`[Pixi'VN] Character ${id} not found`);
+      return;
+    }
+    return character;
+  } catch (e) {
+    console.error(`[Pixi'VN] Error while getting Character ${id}`, e);
+    return;
+  }
+}
+
+// src/decorators/TickerDecorator.ts
+var registeredTickers = {};
+function tickerDecorator(name) {
+  return function(target) {
+    if (!name) {
+      name = target.name;
+    }
+    if (registeredTickers[name]) {
+      console.warn(`[Pixi'VN] Ticker ${name} already exists, it will be overwritten`);
+    }
+    registeredTickers[name] = target;
+  };
+}
+function geTickerInstanceByClassName(tickerName, args, duration, priority) {
+  try {
+    let ticker = registeredTickers[tickerName];
+    if (!ticker) {
+      console.error(`[Pixi'VN] Ticker ${tickerName} not found`);
+      return;
+    }
+    return new ticker(args, duration, priority);
+  } catch (e) {
+    console.error(`[Pixi'VN] Error while getting Ticker ${tickerName}`, e);
+    return;
+  }
+}
+
+// src/classes/ticker/TickerFadeAlpha.ts
 var TickerFadeAlpha = class extends TickerBase {
   /**
    * The method that will be called every frame to fade the alpha of the canvas element of the canvas.
@@ -1024,12 +1049,12 @@ function showImageWithDissolveTransition(tag, imageUrl, speed, priority) {
 }
 
 // src/constants.ts
-var PIXIVM_VERSION = "0.1.4";
+var PIXIVN_VERSION = "0.1.5";
 
 // src/functions/SavesUtility.ts
 function getSaveData() {
   return {
-    version: PIXIVM_VERSION,
+    pixivn_version: PIXIVN_VERSION,
     stepData: GameStepManager.export(),
     storageData: GameStorageManager.export(),
     canvasData: GameWindowManager.export(),
@@ -1125,7 +1150,8 @@ var _GameStorageManager = class _GameStorageManager {
       LAST_DIALOGUE_ADDED_IN_STEP_MEMORY_KEY: "___last_dialogue_added_in_step_memory_key___",
       CURRENT_MENU_OPTIONS_MEMORY_KEY: "___current_menu_options_memory_key___",
       LAST_MENU_OPTIONS_ADDED_IN_STEP_MEMORY_KEY: "___last_menu_options_added_in_step_memory_key___",
-      CHARACTER_PREKEY: "___character___"
+      CHARACTER_CATEGORY_KEY: "___character___",
+      FLAGS_CATEGORY_KEY: "___flags___"
     };
   }
   /**
@@ -1136,7 +1162,7 @@ var _GameStorageManager = class _GameStorageManager {
    */
   static setVariable(key, value) {
     key = key.toLowerCase();
-    if (value === void 0) {
+    if (value === void 0 || value === null) {
       if (_GameStorageManager.storage.hasOwnProperty(key)) {
         delete _GameStorageManager.storage[key];
       }
@@ -1202,6 +1228,17 @@ var GameStorageManager = _GameStorageManager;
 // src/managers/WindowManager.ts
 var import_pixi9 = require("pixi.js");
 
+// src/functions/EasterEgg.ts
+function asciiArtLog() {
+  console.log(`
+    ____  _      _ ___     ___   _ 
+    |  _ (_)_  _(_| )    / /  | |
+    | |_) |  / / |/   / /|  | |
+    |  __/| |>  <| |    V / | |  |
+    |_|   |_/_/__|    _/  |_| _|
+    `);
+}
+
 // src/types/PauseType.ts
 var PauseValueType = "Pause";
 function Pause(duration) {
@@ -1270,6 +1307,7 @@ var _GameWindowManager = class _GameWindowManager {
         this.addCanvasIntoElement(element);
         window.addEventListener("resize", _GameWindowManager.resize);
         _GameWindowManager.resize();
+        asciiArtLog();
       });
     });
   }
@@ -1802,9 +1840,9 @@ var _GameStepManager = class _GameStepManager {
     return _GameStepManager._openedLabels;
   }
   /**
-   * currentLabel is the current label that occurred during the progression of the steps.
+   * currentLabelId is the current label id that occurred during the progression of the steps.
    */
-  static get currentLabel() {
+  static get currentLabelId() {
     if (_GameStepManager._openedLabels.length > 0) {
       let item = _GameStepManager._openedLabels[_GameStepManager._openedLabels.length - 1];
       return item.label;
@@ -1812,8 +1850,13 @@ var _GameStepManager = class _GameStepManager {
     return void 0;
   }
   /**
-   * is the current step index of the current label that occurred during the progression of the steps.
+   * currentLabel is the current label that occurred during the progression of the steps.
    */
+  static get currentLabel() {
+    if (_GameStepManager.currentLabelId) {
+      return getLabelInstanceByClassName(_GameStepManager.currentLabelId);
+    }
+  }
   static get currentLabelStepIndex() {
     if (_GameStepManager._openedLabels.length > 0) {
       let item = _GameStepManager._openedLabels[_GameStepManager._openedLabels.length - 1];
@@ -1821,6 +1864,17 @@ var _GameStepManager = class _GameStepManager {
     }
     return null;
   }
+  /**
+   * currentLabelStep is the current step that occurred during the progression of the steps. It can used to determine the game end.
+   */
+  static get isLastGameStep() {
+    var _a;
+    let stepLabel = (_a = _GameStepManager.currentLabel) == null ? void 0 : _a.steps;
+    if (stepLabel) {
+      return _GameStepManager.currentLabelStepIndex === stepLabel.length;
+    }
+    return false;
+  }
   /**
    * lastHistoryStep is the last history step that occurred during the progression of the steps.
    */
@@ -1888,7 +1942,7 @@ var _GameStepManager = class _GameStepManager {
       }
       _GameStepManager._stepsHistory.push({
         diff: data,
-        currentLabel: _GameStepManager.currentLabel,
+        currentLabel: _GameStepManager.currentLabelId,
         dialoge,
         choices: requiredChoices,
         stepSha1: stepHistory,
@@ -1917,12 +1971,11 @@ var _GameStepManager = class _GameStepManager {
    * @returns 
    */
   static closeCurrentLabel() {
-    if (!_GameStepManager.currentLabel) {
+    if (!_GameStepManager.currentLabelId) {
       console.warn("[Pixi'VN] No label to close");
       return;
     }
-    let currentLabel = getLabelInstanceByClassName(_GameStepManager.currentLabel);
-    if (!currentLabel) {
+    if (!_GameStepManager.currentLabel) {
       console.error("[Pixi'VN] Label not found");
       return;
     }
@@ -1981,13 +2034,13 @@ var _GameStepManager = class _GameStepManager {
    */
   static runCurrentStep() {
     return __async(this, null, function* () {
-      if (_GameStepManager.currentLabel) {
+      if (_GameStepManager.currentLabelId) {
         let lasteStepsLength = _GameStepManager.currentLabelStepIndex;
         if (lasteStepsLength === null) {
           console.error("[Pixi'VN] currentLabelStepIndex is null");
           return;
         }
-        let currentLabel = getLabelInstanceByClassName(_GameStepManager.currentLabel);
+        let currentLabel = _GameStepManager.currentLabel;
         if (!currentLabel) {
           console.error("[Pixi'VN] Label not found");
           return;
@@ -2168,6 +2221,12 @@ var _GameStepManager = class _GameStepManager {
       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.
    */
@@ -2245,27 +2304,54 @@ var GameStepManager = _GameStepManager;
 
 // src/classes/StoredClassModel.ts
 var StoredClassModel = class {
-  constructor(id) {
-    this.id = id;
+  /**
+   * @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;
   }
-  get nameClass() {
-    return this.constructor.name + "Storage";
+  /**
+   * Is id of the stored class. is unique for this class.
+   */
+  get id() {
+    return this._id;
   }
-  updateStorageProperty(key, value) {
-    let storage = GameStorageManager.getVariable(this.nameClass);
+  /**
+   * 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 = {};
     }
-    storage[this.id] = __spreadProps(__spreadValues({}, storage[this.id]), { [key]: value });
-    GameStorageManager.setVariable(this.nameClass, storage);
-  }
-  getStorageProperty(key) {
-    let storage = GameStorageManager.getVariable(this.nameClass);
-    if (!storage) {
-      return void 0;
+    if (!storage.hasOwnProperty(this.id)) {
+      storage[this.id] = {};
     }
-    if (storage[this.id].hasOwnProperty(key)) {
-      return storage[this.id][key];
+    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;
   }
@@ -2274,7 +2360,7 @@ var StoredClassModel = class {
 // src/classes/CharacterModelBase.ts
 var CharacterModelBase2 = class extends StoredClassModel {
   constructor(id, props) {
-    super(GameStorageManager.keysSystem.CHARACTER_PREKEY + id);
+    super(GameStorageManager.keysSystem.CHARACTER_CATEGORY_KEY, id);
     this.defaultName = "";
     this.defaultName = props.name;
     this.defaultSurname = props.surname;
@@ -2286,19 +2372,19 @@ var CharacterModelBase2 = class extends StoredClassModel {
     return this.getStorageProperty("name") || this.defaultName;
   }
   set name(value) {
-    this.updateStorageProperty("name", value);
+    this.setStorageProperty("name", value);
   }
   get surname() {
     return this.getStorageProperty("surname") || this.defaultSurname;
   }
   set surname(value) {
-    this.updateStorageProperty("surname", value);
+    this.setStorageProperty("surname", value);
   }
   get age() {
     return this.getStorageProperty("age") || this.defaultAge;
   }
   set age(value) {
-    this.updateStorageProperty("age", value);
+    this.setStorageProperty("age", value);
   }
   get icon() {
     return this._icon;
@@ -2402,6 +2488,7 @@ var Label = class {
   getChoiceMenuOptions,
   getDialogue,
   getDialogueHistory,
+  getFlag,
   getSaveData,
   getSaveJson,
   getTexture,
@@ -2412,6 +2499,7 @@ var Label = class {
   saveCharacter,
   setChoiceMenuOptions,
   setDialogue,
+  setFlag,
   showCanvasImages,
   showImageWithDissolveTransition,
   tickerDecorator