cleanup and doc

Author: shakty

lib/GameWindow.js

@@ -22,7 +22,7 @@
     var DOM;
 
     var constants, windowLevels, screenLevels;
-    var CB_EXECUTED, WIN_LOADING, lockedUpdate;
+    var CB_EXECUTED, WIN_LOADING;
 
     if (!J) throw new Error('GameWindow: JSUS not found');
     DOM = J.require('DOM');
@@ -36,9 +36,6 @@
 
     WIN_LOADING = windowLevels.LOADING;
 
-    // Allows just one update at the time to the counter of loading frames.
-    lockedUpdate = false;
-
     GameWindow.prototype = DOM;
     GameWindow.prototype.constructor = GameWindow;
 
@@ -62,10 +59,7 @@
         var iframeWin;
         iframeWin = iframe.contentWindow;
 
-        function completed(event) {
-            var iframeDoc;
-            iframeDoc = J.getIFrameDocument(iframe);
-
+        function completed() {
             // Detaching the function to avoid double execution.
             iframe.removeEventListener('load', completed, false);
             iframeWin.removeEventListener('load', completed, false);
@@ -853,16 +847,22 @@
      *
      * Appends a configurable div element at to "top" of the page
      *
-     * @param {object} opts Optional. Configuration options: TODO
+     * @param {object} opts Optional. Configuration options:
      *
-     *    - toggleBtn
-     *    - toggleBtnLabel
-     *    - toggleBtnRoot:
-     *    - force: destroys current Info Panel
+     *    - root: The HTML element (or its id) under which the Info Panel
+     *        will be appended. Default: above the main frame, or below the
+     *        the header, or under document.body.
+     *    - innerHTML: the content of the Info Panel.
+     *    - force: It destroys current frame, if existing.
+     *    - toggleBtn: If TRUE, it creates a button to toggle the Info Panel.
+     *        Default: TRUE.
+     *    - toggleBtnRoot: the HTML element (or its id) under which the button
+     *        to toggle the Info Panel will be appended. Default: the header.
+     *    - toggleBtnLabel: The text on the button to toggle the Info Panel.
+     *        Default: 'Info'.
      *
-     * @param {boolean} force Optional. Will create the frame even if an
-     *   existing one is found. Deprecated, use force flag in options.
-     *   Default: FALSE
+     * @param {boolean} force Optional. Deprecated, use force flag in
+     *    options. Default: FALSE
      *
      * @return {InfoPanel} A reference to the InfoPanel object
      *
@@ -898,6 +898,7 @@
 
         root = opts.root;
         if (root) {
+            if ('string' === typeof root) root = W.gid(root);
             if (!J.isElement(root)) {
                 throw new Error('GameWindow.generateInfoPanel: root must be ' +
                                 'undefined or HTMLElement. Found: ' + root);
@@ -2365,8 +2366,6 @@
      * @param {GameWindow} that A reference to the GameWindow instance
      * @param {number} update The number to add to the counter
      *
-     * @see GameWindow.lockedUpdate
-     *
      * @api private
      */
     function updateAreLoading(that, update) {

lib/InfoPanel.js

@@ -1,6 +1,6 @@
 /**
  * # InfoPanel
- * Copyright(c) 2017 Stefano Balietti <ste@nodegame.org>
+ * Copyright(c) 2021 Stefano Balietti <ste@nodegame.org>
  * MIT Licensed
  *
  * Adds a configurable extra panel at the top of the screen
@@ -336,4 +336,4 @@
 })(
     ('undefined' !== typeof node) ? node : module.parent.exports.node,
     ('undefined' !== typeof window) ? window : module.parent.exports.window
-);;
+);