@drincs/pixi-vn 0.4.7 → 0.4.8

package/dist/managers/StorageManager.mjs

@@ -0,0 +1,99 @@
+// src/functions/ExportUtility.ts
+function createExportableElement(element) {
+  try {
+    let elementString = JSON.stringify(element);
+    return JSON.parse(elementString);
+  } catch (e) {
+    console.error("[Pixi'VN] Error creating exportable element", e);
+    throw new Error("[Pixi'VN] Error creating exportable element");
+  }
+}
+
+// src/managers/StorageManager.ts
+var _GameStorageManager = class _GameStorageManager {
+  constructor() {
+  }
+  static get keysSystem() {
+    return {
+      CURRENT_DIALOGUE_MEMORY_KEY: "___current_dialogue_memory___",
+      LAST_DIALOGUE_ADDED_IN_STEP_MEMORY_KEY: "___last_dialogue_added_in_step_memory___",
+      CURRENT_MENU_OPTIONS_MEMORY_KEY: "___current_menu_options_memory___",
+      LAST_MENU_OPTIONS_ADDED_IN_STEP_MEMORY_KEY: "___last_menu_options_added_in_step_memory___",
+      CHARACTER_CATEGORY_KEY: "___character___",
+      FLAGS_CATEGORY_KEY: "___flags___"
+    };
+  }
+  /**
+   * Set a variable in the storage
+   * @param key The key of the variable
+   * @param value The value of the variable. If undefined, the variable will be removed
+   * @returns
+   */
+  static setVariable(key, value) {
+    key = key.toLowerCase();
+    if (value === void 0 || value === null) {
+      if (_GameStorageManager.storage.hasOwnProperty(key)) {
+        delete _GameStorageManager.storage[key];
+      }
+      return;
+    }
+    _GameStorageManager.storage[key] = value;
+  }
+  /**
+   * Get a variable from the storage
+   * @param key The key of the variable
+   * @returns The value of the variable. If the variable does not exist, it will return undefined
+   */
+  static getVariable(key) {
+    key = key.toLowerCase();
+    if (_GameStorageManager.storage.hasOwnProperty(key)) {
+      return _GameStorageManager.storage[key];
+    }
+    return void 0;
+  }
+  /**
+   * Remove a variable from the storage
+   * @param key The key of the variable
+   * @returns
+   */
+  static removeVariable(key) {
+    key = key.toLowerCase();
+    if (_GameStorageManager.storage.hasOwnProperty(key)) {
+      delete _GameStorageManager.storage[key];
+    }
+  }
+  /**
+   * Clear the storage and the oidsUsed
+   * @returns
+   */
+  static clear() {
+    _GameStorageManager.storage = {};
+  }
+  static exportJson() {
+    return JSON.stringify(this.export());
+  }
+  static export() {
+    return createExportableElement(_GameStorageManager.storage);
+  }
+  static importJson(dataString) {
+    _GameStorageManager.import(JSON.parse(dataString));
+  }
+  static import(data) {
+    _GameStorageManager.clear();
+    try {
+      if (data) {
+        _GameStorageManager.storage = data;
+      } else {
+        console.warn("[Pixi'VN] No storage data found");
+      }
+    } catch (e) {
+      console.error("[Pixi'VN] Error importing data", e);
+    }
+  }
+};
+_GameStorageManager.storage = {};
+var GameStorageManager = _GameStorageManager;
+
+export { GameStorageManager as default };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=StorageManager.mjs.map

package/dist/managers/StorageManager.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/functions/ExportUtility.ts","../../src/managers/StorageManager.ts"],"names":[],"mappings":";AAKO,SAAS,wBAA2B,SAAe;AACtD,MAAI;AACA,QAAI,gBAAgB,KAAK,UAAU,OAAO;AAC1C,WAAO,KAAK,MAAM,aAAa;AAAA,EACnC,SACO,GAAG;AACN,YAAQ,MAAM,+CAA+C,CAAC;AAC9D,UAAM,IAAI,MAAM,6CAA6C;AAAA,EACjE;AACJ;;;ACVA,IAAqB,sBAArB,MAAqB,oBAAmB;AAAA,EAE5B,cAAc;AAAA,EAAE;AAAA,EACxB,WAAkB,aAAa;AAC3B,WAAO;AAAA,MACH,6BAA6B;AAAA,MAC7B,wCAAwC;AAAA,MACxC,iCAAiC;AAAA,MACjC,4CAA4C;AAAA,MAC5C,wBAAwB;AAAA,MACxB,oBAAoB;AAAA,IACxB;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAc,YAAY,KAAa,OAA2B;AAC9D,UAAM,IAAI,YAAY;AACtB,QAAI,UAAU,UAAa,UAAU,MAAM;AACvC,UAAI,oBAAmB,QAAQ,eAAe,GAAG,GAAG;AAChD,eAAO,oBAAmB,QAAQ,GAAG;AAAA,MACzC;AACA;AAAA,IACJ;AACA,wBAAmB,QAAQ,GAAG,IAAI;AAAA,EACtC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAc,YAA0C,KAA4B;AAChF,UAAM,IAAI,YAAY;AACtB,QAAI,oBAAmB,QAAQ,eAAe,GAAG,GAAG;AAChD,aAAO,oBAAmB,QAAQ,GAAG;AAAA,IACzC;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAc,eAAe,KAAa;AACtC,UAAM,IAAI,YAAY;AACtB,QAAI,oBAAmB,QAAQ,eAAe,GAAG,GAAG;AAChD,aAAO,oBAAmB,QAAQ,GAAG;AAAA,IACzC;AAAA,EACJ;AAAA;AAAA;AAAA;AAAA;AAAA,EAKA,OAAc,QAAQ;AAClB,wBAAmB,UAAU,CAAC;AAAA,EAClC;AAAA,EACA,OAAc,aAAqB;AAC/B,WAAO,KAAK,UAAU,KAAK,OAAO,CAAC;AAAA,EACvC;AAAA,EACA,OAAc,SAA0B;AACpC,WAAO,wBAAwB,oBAAmB,OAAO;AAAA,EAC7D;AAAA,EACA,OAAc,WAAW,YAAoB;AACzC,wBAAmB,OAAO,KAAK,MAAM,UAAU,CAAC;AAAA,EACpD;AAAA,EACA,OAAc,OAAO,MAAc;AAC/B,wBAAmB,MAAM;AACzB,QAAI;AACA,UAAI,MAAM;AACN,4BAAmB,UAAW;AAAA,MAClC,OACK;AACD,gBAAQ,KAAK,iCAAiC;AAAA,MAClD;AAAA,IACJ,SACO,GAAG;AACN,cAAQ,MAAM,kCAAkC,CAAC;AAAA,IACrD;AAAA,EACJ;AACJ;AAlFqB,oBACF,UAAiD,CAAC;AADrE,IAAqB,qBAArB","sourcesContent":["/**\n * This function is used to create a deep copy of the element\n * @param element The element to be copied\n * @returns The copied element\n */\nexport function createExportableElement<T>(element: T): T {\n    try {\n        let elementString = JSON.stringify(element)\n        return JSON.parse(elementString)\n    }\n    catch (e) {\n        console.error(\"[Pixi'VN] Error creating exportable element\", e)\n        throw new Error(\"[Pixi'VN] Error creating exportable element\")\n    }\n}\n","import { createExportableElement } from \"../functions/ExportUtility\"\nimport { ExportedStorage } from \"../interface/export\"\nimport { StorageElementType } from \"../types/StorageElementType\"\n\nexport default class GameStorageManager {\n    private static storage: { [key: string]: StorageElementType } = {}\n    private constructor() { }\n    public static get keysSystem() {\n        return {\n            CURRENT_DIALOGUE_MEMORY_KEY: \"___current_dialogue_memory___\",\n            LAST_DIALOGUE_ADDED_IN_STEP_MEMORY_KEY: \"___last_dialogue_added_in_step_memory___\",\n            CURRENT_MENU_OPTIONS_MEMORY_KEY: \"___current_menu_options_memory___\",\n            LAST_MENU_OPTIONS_ADDED_IN_STEP_MEMORY_KEY: \"___last_menu_options_added_in_step_memory___\",\n            CHARACTER_CATEGORY_KEY: \"___character___\",\n            FLAGS_CATEGORY_KEY: \"___flags___\",\n        }\n    }\n    /**\n     * Set a variable in the storage\n     * @param key The key of the variable\n     * @param value The value of the variable. If undefined, the variable will be removed\n     * @returns\n     */\n    public static setVariable(key: string, value: StorageElementType) {\n        key = key.toLowerCase()\n        if (value === undefined || value === null) {\n            if (GameStorageManager.storage.hasOwnProperty(key)) {\n                delete GameStorageManager.storage[key]\n            }\n            return\n        }\n        GameStorageManager.storage[key] = value\n    }\n    /**\n     * Get a variable from the storage\n     * @param key The key of the variable\n     * @returns The value of the variable. If the variable does not exist, it will return undefined\n     */\n    public static getVariable<T extends StorageElementType>(key: string): T | undefined {\n        key = key.toLowerCase()\n        if (GameStorageManager.storage.hasOwnProperty(key)) {\n            return GameStorageManager.storage[key] as T\n        }\n        return undefined\n    }\n    /**\n     * Remove a variable from the storage\n     * @param key The key of the variable\n     * @returns\n     */\n    public static removeVariable(key: string) {\n        key = key.toLowerCase()\n        if (GameStorageManager.storage.hasOwnProperty(key)) {\n            delete GameStorageManager.storage[key]\n        }\n    }\n    /**\n     * Clear the storage and the oidsUsed\n     * @returns\n     */\n    public static clear() {\n        GameStorageManager.storage = {}\n    }\n    public static exportJson(): string {\n        return JSON.stringify(this.export())\n    }\n    public static export(): ExportedStorage {\n        return createExportableElement(GameStorageManager.storage)\n    }\n    public static importJson(dataString: string) {\n        GameStorageManager.import(JSON.parse(dataString))\n    }\n    public static import(data: object) {\n        GameStorageManager.clear()\n        try {\n            if (data) {\n                GameStorageManager.storage = (data as ExportedStorage)\n            }\n            else {\n                console.warn(\"[Pixi'VN] No storage data found\")\n            }\n        }\n        catch (e) {\n            console.error(\"[Pixi'VN] Error importing data\", e)\n        }\n    }\n}\n"]}

package/dist/managers/WindowManager.d.mts

@@ -0,0 +1,265 @@
+import * as pixi_js from 'pixi.js';
+import { Application, ApplicationOptions, Container } from 'pixi.js';
+import CanvasBase from '../classes/canvas/CanvasBase.mjs';
+import { a as TickerArgsType, T as TickerBase, I as ITicker } from '../TickerBase-CFEJHstJ.mjs';
+import { IClassWithArgsHistory } from '../interface/IClassWithArgsHistory.mjs';
+import { PauseType } from '../types/PauseType.mjs';
+import { RepeatType } from '../types/RepeatType.mjs';
+import ExportedCanvas from '../interface/export/ExportedCanvas.mjs';
+import ITickersSteps from '../interface/ITickersSteps.mjs';
+import '../interface/canvas/ICanvasBaseMemory.mjs';
+import '../types/StorageElementType.mjs';
+import '../types/TickerIdType.mjs';
+
+/**
+ * This class is responsible for managing the canvas, the tickers, the events, and the window size and the children of the window.
+ */
+declare class GameWindowManager {
+    private constructor();
+    private static _app;
+    /**
+     * The PIXI Application instance.
+     * It not recommended to use this property directly.
+     */
+    static get app(): Application<pixi_js.Renderer>;
+    private static _isInitialized;
+    /**
+     * If the manager is initialized.
+     */
+    static get isInitialized(): boolean;
+    /**
+     * This is the div that have same size of the canvas.
+     * This is useful to put interface elements.
+     * You can use React or other framework to put elements in this div.
+     */
+    static htmlLayout: HTMLElement;
+    static canvasWidth: number;
+    static canvasHeight: number;
+    static get screen(): pixi_js.Rectangle;
+    /**
+     * Initialize the PIXI Application and the interface div.
+     * This method should be called before any other method.
+     * @param element The html element where I will put the canvas. Example: document.body
+     * @param width The width of the canvas
+     * @param height The height of the canvas
+     * @param options The options of PIXI Application
+     * @example
+     * ```typescript
+     * const body = document.body
+     * if (!body) {
+     *     throw new Error('body element not found')
+     * }
+     * await GameWindowManager.initialize(body, 1920, 1080, {
+     *     backgroundColor: "#303030"
+     * })
+     * ```
+     */
+    static initialize(element: HTMLElement, width: number, height: number, options?: Partial<ApplicationOptions>): Promise<void>;
+    /**
+     * Add the canvas into a html element.
+     * @param element it is the html element where I will put the canvas. Example: document.body
+     */
+    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')
+     * @example
+     * ```typescript
+     * const root = document.getElementById('root')
+     * if (!root) {
+     *     throw new Error('root element not found')
+     * }
+     * GameWindowManager.initializeHTMLLayout(root)
+     * const reactRoot = createRoot(GameWindowManager.htmlLayout)
+     * reactRoot.render(
+     *     <App />
+     * )
+     * ```
+     */
+    static initializeHTMLLayout(element: HTMLElement): void;
+    /**
+     * This method returns the scale of the screen.
+     */
+    static get screenScale(): number;
+    /**
+     * This method returns the width of the screen enlarged by the scale.
+     */
+    static get screenWidth(): number;
+    /**
+     * This method returns the height of the screen enlarged by the scale.
+     */
+    static get screenHeight(): number;
+    /**
+     * This method returns the horizontal margin of the screen.
+     */
+    static get horizontalMargin(): number;
+    /**
+     * This method returns the vertical margin of the screen.
+     */
+    static get verticalMargin(): number;
+    /**
+     * This method is called when the screen is resized.
+     */
+    private static resize;
+    /**
+     * This is a dictionary that contains all Canvas Elements of Canvas, currently.
+     */
+    static get currentCanvasElements(): {
+        [tag: string]: CanvasBase<any>;
+    };
+    private static _children;
+    /**
+     * The order of the children tags.
+     */
+    private static childrenTagsOrder;
+    /**
+     * Add a canvas element to the canvas.
+     * If there is a canvas element with the same tag, it will be removed.
+     * @param tag The tag of the canvas element.
+     * @param canvasElement The canvas elements to be added.
+     * @example
+     * ```typescript
+     * const texture = await Assets.load('https://pixijs.com/assets/bunny.png');
+     * const sprite = CanvasSprite.from(texture);
+     * GameWindowManager.addCanvasElement("bunny", sprite);
+     * ```
+     */
+    static addCanvasElement(tag: string, canvasElement: CanvasBase<any>): void;
+    /**
+     * Remove a canvas element from the canvas.
+     * And remove all tickers that are not connected to any canvas element.
+     * @param tag The tag of the canvas element to be removed.
+     * @returns
+     * @example
+     * ```typescript
+     * GameWindowManager.removeCanvasElement("bunny");
+     * ```
+     */
+    static removeCanvasElement(tag: string | string[]): void;
+    /**
+     * Get a canvas element by the tag.
+     * @param tag The tag of the canvas element.
+     * @returns The canvas element.
+     * @example
+     * ```typescript
+     * const sprite = GameWindowManager.getCanvasElement<CanvasSprite>("bunny");
+     * ```
+     */
+    static getCanvasElement<T extends CanvasBase<any>>(tag: string): T | undefined;
+    /**
+     * Check if a DisplayObject is on the canvas.
+     * @param pixiElement The DisplayObject to be checked.
+     * @returns If the DisplayObject is on the canvas.
+     */
+    static canvasElementIsOnCanvas<T extends Container>(pixiElement: T): boolean;
+    /**
+     * Remove all canvas elements from the canvas.
+     * And remove all tickers that are not connected to any canvas element.
+     */
+    static removeCanvasElements(): void;
+    /**
+     * Edit the tag of a canvas element.
+     * @param oldTag The old tag of the canvas element.
+     * @param newTag The new tag of the canvas element.
+     */
+    static editTagCanvasElement(oldTag: string, newTag: string): void;
+    /** Edit Tickers Methods */
+    /**
+     * Currently tickers that are running.
+     */
+    static get currentTickers(): IClassWithArgsHistory<any>[];
+    private static _currentTickers;
+    /**
+     * The steps of the tickers
+     */
+    static get currentTickersSteps(): {
+        [tag: string]: ITickersSteps;
+    };
+    private static _currentTickersSteps;
+    static currentTickersTimeouts: {
+        [timeout: string]: {
+            tags: string[];
+            ticker: string;
+        };
+    };
+    /**
+     * Run a ticker.
+     * @param canvasEslementTag The tag of the canvas element that will use the ticker.
+     * @param ticker The ticker class to be run.
+     * @param args The arguments to be used in the ticker.
+     * @param duration The time to be used in the ticker. This number is in milliseconds. If it is undefined, the ticker will run forever.
+     * @param priority The priority to be used in the ticker.
+     * @returns
+     * @example
+     * ```typescript
+     * GameWindowManager.addTicker("alien", new TickerRotate({ speed: 0.2 }))
+     * ```
+     */
+    static addTicker<TArgs extends TickerArgsType>(canvasElementTag: string | string[], ticker: TickerBase<TArgs>): void;
+    private static pushTicker;
+    /**
+     * Run a sequence of tickers.
+     * @param tag The tag of canvas element that will use the tickers.
+     * @param steps The steps of the tickers.
+     * @returns
+     * @example
+     * ```typescript
+     * GameWindowManager.addTickersSteps("alien", [
+     *     new TickerRotate({ speed: 0.1, clockwise: true }, 2000),
+     *     Pause(500),
+     *     new TickerRotate({ speed: 0.2, clockwise: false }, 2000),
+     *     Repeat,
+     * ])
+     * ```
+     */
+    static addTickersSteps<TArgs extends TickerArgsType>(tag: string, steps: (ITicker<TArgs> | RepeatType | PauseType)[]): void;
+    private static runTickersSteps;
+    private static nextTickerStep;
+    /**
+     * Remove a connection between a canvas element and a ticker.
+     * And remove the ticker if there is no canvas element connected to it.
+     * @param tag The tag of the canvas element that will use the ticker.
+     * @param ticker The ticker class to be removed.
+     * @example
+     * ```typescript
+     * GameWindowManager.removeAssociationBetweenTickerCanvasElement("alien", TickerRotate)
+     * ```
+     */
+    static removeAssociationBetweenTickerCanvasElement(tag: string | string[], ticker: typeof TickerBase<any> | TickerBase<any>): void;
+    /**
+     * Remove all tickers that are not connected to any existing canvas element.
+     */
+    private static removeTickersWithoutAssociatedCanvasElement;
+    private static addTickerTimeoutInfo;
+    private static removeTickerTimeoutInfo;
+    /**
+     * Remove all tickers from the canvas.
+     */
+    static removeTickers(): void;
+    /**
+     * Clear the canvas and the tickers.
+     */
+    static clear(): void;
+    /**
+     * Export the canvas and the tickers to a JSON string.
+     * @returns The JSON string.
+     */
+    static exportJson(): string;
+    /**
+     * Export the canvas and the tickers to an object.
+     * @returns The object.
+     */
+    static export(): ExportedCanvas;
+    /**
+     * Import the canvas and the tickers from a JSON string.
+     * @param dataString The JSON string.
+     */
+    static importJson(dataString: string): void;
+    /**
+     * Import the canvas and the tickers from an object.
+     * @param data The object.
+     */
+    static import(data: object): void;
+}
+
+export { GameWindowManager as default };

package/dist/managers/WindowManager.d.ts

@@ -0,0 +1,265 @@
+import * as pixi_js from 'pixi.js';
+import { Application, ApplicationOptions, Container } from 'pixi.js';
+import CanvasBase from '../classes/canvas/CanvasBase.js';
+import { a as TickerArgsType, T as TickerBase, I as ITicker } from '../TickerBase-CjfyD6j5.js';
+import { IClassWithArgsHistory } from '../interface/IClassWithArgsHistory.js';
+import { PauseType } from '../types/PauseType.js';
+import { RepeatType } from '../types/RepeatType.js';
+import ExportedCanvas from '../interface/export/ExportedCanvas.js';
+import ITickersSteps from '../interface/ITickersSteps.js';
+import '../interface/canvas/ICanvasBaseMemory.js';
+import '../types/StorageElementType.js';
+import '../types/TickerIdType.js';
+
+/**
+ * This class is responsible for managing the canvas, the tickers, the events, and the window size and the children of the window.
+ */
+declare class GameWindowManager {
+    private constructor();
+    private static _app;
+    /**
+     * The PIXI Application instance.
+     * It not recommended to use this property directly.
+     */
+    static get app(): Application<pixi_js.Renderer>;
+    private static _isInitialized;
+    /**
+     * If the manager is initialized.
+     */
+    static get isInitialized(): boolean;
+    /**
+     * This is the div that have same size of the canvas.
+     * This is useful to put interface elements.
+     * You can use React or other framework to put elements in this div.
+     */
+    static htmlLayout: HTMLElement;
+    static canvasWidth: number;
+    static canvasHeight: number;
+    static get screen(): pixi_js.Rectangle;
+    /**
+     * Initialize the PIXI Application and the interface div.
+     * This method should be called before any other method.
+     * @param element The html element where I will put the canvas. Example: document.body
+     * @param width The width of the canvas
+     * @param height The height of the canvas
+     * @param options The options of PIXI Application
+     * @example
+     * ```typescript
+     * const body = document.body
+     * if (!body) {
+     *     throw new Error('body element not found')
+     * }
+     * await GameWindowManager.initialize(body, 1920, 1080, {
+     *     backgroundColor: "#303030"
+     * })
+     * ```
+     */
+    static initialize(element: HTMLElement, width: number, height: number, options?: Partial<ApplicationOptions>): Promise<void>;
+    /**
+     * Add the canvas into a html element.
+     * @param element it is the html element where I will put the canvas. Example: document.body
+     */
+    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')
+     * @example
+     * ```typescript
+     * const root = document.getElementById('root')
+     * if (!root) {
+     *     throw new Error('root element not found')
+     * }
+     * GameWindowManager.initializeHTMLLayout(root)
+     * const reactRoot = createRoot(GameWindowManager.htmlLayout)
+     * reactRoot.render(
+     *     <App />
+     * )
+     * ```
+     */
+    static initializeHTMLLayout(element: HTMLElement): void;
+    /**
+     * This method returns the scale of the screen.
+     */
+    static get screenScale(): number;
+    /**
+     * This method returns the width of the screen enlarged by the scale.
+     */
+    static get screenWidth(): number;
+    /**
+     * This method returns the height of the screen enlarged by the scale.
+     */
+    static get screenHeight(): number;
+    /**
+     * This method returns the horizontal margin of the screen.
+     */
+    static get horizontalMargin(): number;
+    /**
+     * This method returns the vertical margin of the screen.
+     */
+    static get verticalMargin(): number;
+    /**
+     * This method is called when the screen is resized.
+     */
+    private static resize;
+    /**
+     * This is a dictionary that contains all Canvas Elements of Canvas, currently.
+     */
+    static get currentCanvasElements(): {
+        [tag: string]: CanvasBase<any>;
+    };
+    private static _children;
+    /**
+     * The order of the children tags.
+     */
+    private static childrenTagsOrder;
+    /**
+     * Add a canvas element to the canvas.
+     * If there is a canvas element with the same tag, it will be removed.
+     * @param tag The tag of the canvas element.
+     * @param canvasElement The canvas elements to be added.
+     * @example
+     * ```typescript
+     * const texture = await Assets.load('https://pixijs.com/assets/bunny.png');
+     * const sprite = CanvasSprite.from(texture);
+     * GameWindowManager.addCanvasElement("bunny", sprite);
+     * ```
+     */
+    static addCanvasElement(tag: string, canvasElement: CanvasBase<any>): void;
+    /**
+     * Remove a canvas element from the canvas.
+     * And remove all tickers that are not connected to any canvas element.
+     * @param tag The tag of the canvas element to be removed.
+     * @returns
+     * @example
+     * ```typescript
+     * GameWindowManager.removeCanvasElement("bunny");
+     * ```
+     */
+    static removeCanvasElement(tag: string | string[]): void;
+    /**
+     * Get a canvas element by the tag.
+     * @param tag The tag of the canvas element.
+     * @returns The canvas element.
+     * @example
+     * ```typescript
+     * const sprite = GameWindowManager.getCanvasElement<CanvasSprite>("bunny");
+     * ```
+     */
+    static getCanvasElement<T extends CanvasBase<any>>(tag: string): T | undefined;
+    /**
+     * Check if a DisplayObject is on the canvas.
+     * @param pixiElement The DisplayObject to be checked.
+     * @returns If the DisplayObject is on the canvas.
+     */
+    static canvasElementIsOnCanvas<T extends Container>(pixiElement: T): boolean;
+    /**
+     * Remove all canvas elements from the canvas.
+     * And remove all tickers that are not connected to any canvas element.
+     */
+    static removeCanvasElements(): void;
+    /**
+     * Edit the tag of a canvas element.
+     * @param oldTag The old tag of the canvas element.
+     * @param newTag The new tag of the canvas element.
+     */
+    static editTagCanvasElement(oldTag: string, newTag: string): void;
+    /** Edit Tickers Methods */
+    /**
+     * Currently tickers that are running.
+     */
+    static get currentTickers(): IClassWithArgsHistory<any>[];
+    private static _currentTickers;
+    /**
+     * The steps of the tickers
+     */
+    static get currentTickersSteps(): {
+        [tag: string]: ITickersSteps;
+    };
+    private static _currentTickersSteps;
+    static currentTickersTimeouts: {
+        [timeout: string]: {
+            tags: string[];
+            ticker: string;
+        };
+    };
+    /**
+     * Run a ticker.
+     * @param canvasEslementTag The tag of the canvas element that will use the ticker.
+     * @param ticker The ticker class to be run.
+     * @param args The arguments to be used in the ticker.
+     * @param duration The time to be used in the ticker. This number is in milliseconds. If it is undefined, the ticker will run forever.
+     * @param priority The priority to be used in the ticker.
+     * @returns
+     * @example
+     * ```typescript
+     * GameWindowManager.addTicker("alien", new TickerRotate({ speed: 0.2 }))
+     * ```
+     */
+    static addTicker<TArgs extends TickerArgsType>(canvasElementTag: string | string[], ticker: TickerBase<TArgs>): void;
+    private static pushTicker;
+    /**
+     * Run a sequence of tickers.
+     * @param tag The tag of canvas element that will use the tickers.
+     * @param steps The steps of the tickers.
+     * @returns
+     * @example
+     * ```typescript
+     * GameWindowManager.addTickersSteps("alien", [
+     *     new TickerRotate({ speed: 0.1, clockwise: true }, 2000),
+     *     Pause(500),
+     *     new TickerRotate({ speed: 0.2, clockwise: false }, 2000),
+     *     Repeat,
+     * ])
+     * ```
+     */
+    static addTickersSteps<TArgs extends TickerArgsType>(tag: string, steps: (ITicker<TArgs> | RepeatType | PauseType)[]): void;
+    private static runTickersSteps;
+    private static nextTickerStep;
+    /**
+     * Remove a connection between a canvas element and a ticker.
+     * And remove the ticker if there is no canvas element connected to it.
+     * @param tag The tag of the canvas element that will use the ticker.
+     * @param ticker The ticker class to be removed.
+     * @example
+     * ```typescript
+     * GameWindowManager.removeAssociationBetweenTickerCanvasElement("alien", TickerRotate)
+     * ```
+     */
+    static removeAssociationBetweenTickerCanvasElement(tag: string | string[], ticker: typeof TickerBase<any> | TickerBase<any>): void;
+    /**
+     * Remove all tickers that are not connected to any existing canvas element.
+     */
+    private static removeTickersWithoutAssociatedCanvasElement;
+    private static addTickerTimeoutInfo;
+    private static removeTickerTimeoutInfo;
+    /**
+     * Remove all tickers from the canvas.
+     */
+    static removeTickers(): void;
+    /**
+     * Clear the canvas and the tickers.
+     */
+    static clear(): void;
+    /**
+     * Export the canvas and the tickers to a JSON string.
+     * @returns The JSON string.
+     */
+    static exportJson(): string;
+    /**
+     * Export the canvas and the tickers to an object.
+     * @returns The object.
+     */
+    static export(): ExportedCanvas;
+    /**
+     * Import the canvas and the tickers from a JSON string.
+     * @param dataString The JSON string.
+     */
+    static importJson(dataString: string): void;
+    /**
+     * Import the canvas and the tickers from an object.
+     * @param data The object.
+     */
+    static import(data: object): void;
+}
+
+export { GameWindowManager as default };