@melonjs/debug-plugin 14.6.2 → 14.6.4

package/dist/@melonjs/debug-plugin.d.ts

@@ -0,0 +1,91 @@
+/**
+ * @classdesc
+ * a simple debug panel plugin <br>
+ * <img src="images/debugPanel.png"/> <br>
+ * <b>usage : </b><br>
+ * &bull; upon loading the debug panel, it will be automatically registered under me.plugins.debugPanel <br>
+ * &bull; you can then press the default "s" key to show or hide the panel, or use me.plugins.debugPanel.show() and me.plugins.debugPanel.show(), or add #debug as a parameter to your URL e.g. http://myURL/index.html#debug <br>
+ * &bull; default key can be configured using the following parameters in the url : e.g. http://myURL/index.html#debugToggleKey=d <br>
+ * <b>the debug panel provides the following information : </b><br>
+ * &bull; amount of total objects currently active in the current stage <br>
+ * &bull; amount of draws operation <br>
+ * &bull; amount of body shape (for collision) <br>
+ * &bull; amount of bounding box <br>
+ * &bull; amount of sprites objects <br>
+ * &bull; amount of objects currently inactive in the the object pool <br>
+ * &bull; memory usage (Heap Memory information is only available under Chrome) <br>
+ * &bull; frame update time (in ms) <br>
+ * &bull; frame draw time (in ms) <br>
+ * &bull; current fps rate vs target fps <br>
+ * additionally, using the checkbox in the panel it is also possible to display : <br>
+ * &bull; the hitbox or bounding box for all objects <br>
+ * &bull; current velocity vector <br>
+ * &bull; quadtree spatial visualization <br>
+ * @augments plugin.BasePlugin
+ */
+export class DebugPanelPlugin extends plugin.BasePlugin {
+    constructor(debugToggle: any);
+    panel: DebugPanel;
+    /**
+     * show the debug panel
+     */
+    show(): void;
+    /**
+     * hide the debug panel
+     */
+    hide(): void;
+    /**
+     * toggle the debug panel visibility state
+     */
+    toggle(): void;
+}
+import { plugin } from 'melonjs';
+declare class DebugPanel extends Renderable {
+    constructor(debugToggle?: number);
+    checkbox: {};
+    counters: Counters;
+    visible: boolean;
+    frameUpdateTime: number;
+    frameDrawTime: number;
+    version: string;
+    canvas: HTMLCanvasElement | OffscreenCanvas;
+    font_size: number;
+    mod: number;
+    font: BitmapText;
+    debugToggle: number;
+    keyHandler: import("eventemitter3").EventEmitter<string | symbol, any>;
+    help_str: string;
+    help_str_len: number;
+    fps_str_len: number;
+    memoryPositionX: number;
+    frameUpdateStartTime: number;
+    frameDrawStartTime: number;
+    /**
+     * patch system fn to draw debug information
+     */
+    patchSystemFn(): void;
+    /**
+     * show the debug panel
+     */
+    show(): void;
+    /**
+     * hide the debug panel
+     */
+    hide(): void;
+    update(): boolean;
+    onClick(e: any): void;
+    drawQuadTreeNode(renderer: any, node: any): void;
+    drawQuadTree(renderer: any): void;
+    /** @private */
+    private drawMemoryGraph;
+    draw(renderer: any): void;
+}
+import { Renderable } from 'melonjs';
+declare class Counters {
+    stats: any[];
+    reset(): void;
+    inc(stat: any, value: any): void;
+    get(stat: any): any;
+}
+import { BitmapText } from 'melonjs';
+export {};

package/dist/@melonjs/debug-plugin.js

@@ -1,5 +1,5 @@
 /*!
- * melonJS debug plugin - v14.6.2
+ * melonJS debug plugin - v14.6.4
  * http://www.melonjs.org
  * @melonjs/debug-plugin is licensed under the MIT License.
  * http://www.opensource.org/licenses/mit-license
@@ -71,7 +71,7 @@ class DebugPanel extends Renderable {
         this.name = "debugPanel";
 
         // the debug panel version
-        this.version = "14.6.2";
+        this.version = "14.6.4";
 
         // persistent
         this.isPersistent = true;
@@ -588,16 +588,16 @@ class DebugPanel extends Renderable {
  * &bull; the hitbox or bounding box for all objects <br>
  * &bull; current velocity vector <br>
  * &bull; quadtree spatial visualization <br>
- * @augments plugin.Base
+ * @augments plugin.BasePlugin
  */
-class DebugPanelPlugin extends plugin.Base {
+class DebugPanelPlugin extends plugin.BasePlugin {
 
     constructor(debugToggle) {
         // call the super constructor
         super();
 
         // minimum melonJS version expected
-        this.version = "15.1.5";
+        this.version = "15.2.0";
 
         this.panel = new DebugPanel(debugToggle);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@melonjs/debug-plugin",
-  "version": "14.6.2",
+  "version": "14.6.4",
   "description": "melonJS debug plugin",
   "type": "module",
   "keywords": [
@@ -41,14 +41,14 @@
   "types": "dist/@melonjs/debug-plugin.d.ts",
   "sideEffects": false,
   "files": [
-    "dist/@melonjs/debug-plugin.js",
+    "dist/",
     "src/",
     "package.json",
     "README.md",
     "LICENSE"
   ],
   "peerDependencies": {
-    "melonjs": "^15.1.6"
+    "melonjs": "^15.2.0"
   },
   "devDependencies": {
     "@babel/eslint-parser": "^7.21.8",
@@ -59,7 +59,7 @@
     "@rollup/plugin-replace": "^5.0.2",
     "del-cli": "^5.0.0",
     "eslint": "^8.40.0",
-    "eslint-plugin-jsdoc": "^44.2.2",
+    "eslint-plugin-jsdoc": "^44.2.3",
     "rollup": "^3.21.6",
     "rollup-plugin-bundle-size": "^1.0.3",
     "rollup-plugin-string": "^3.0.0",

package/src/index.js

@@ -24,16 +24,16 @@ import { DebugPanel } from "./debugPanel";
  * &bull; the hitbox or bounding box for all objects <br>
  * &bull; current velocity vector <br>
  * &bull; quadtree spatial visualization <br>
- * @augments plugin.Base
+ * @augments plugin.BasePlugin
  */
-export class DebugPanelPlugin extends plugin.Base {
+export class DebugPanelPlugin extends plugin.BasePlugin {
 
     constructor(debugToggle) {
         // call the super constructor
         super();
 
         // minimum melonJS version expected
-        this.version = "15.1.5";
+        this.version = "15.2.0";
 
         this.panel = new DebugPanel(debugToggle);