waitScreen texts are all parameters now, countdown may be hidden

Author: shakty

build/nodegame-window.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
      *
@@ -888,11 +888,7 @@
                     opts.toggleBtn = false;
                 }
             }
-            // if (!force) {
-            //     throw new Error('GameWindow.generateInfoPanel: info panel is ' +
-            //                     'already existing. Use force to regenerate.');
-            // }
-
+            node.warn('W.generateInfoPanel: Info Panel already existing.')
         }
         else {
             this.infoPanel = new node.InfoPanel(opts);
@@ -902,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);
@@ -2369,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) {
@@ -2911,7 +2906,6 @@
                                 countdown);
         }
         this.setScreenLevel('LOCKING');
-        text = text || 'Screen locked. Please wait...';
         this.waitScreen.lock(text, countdown);
         this.setScreenLevel('LOCKED');
     };
@@ -3082,7 +3076,7 @@
 
 /**
  * # WaitScreen
- * Copyright(c) 2018 Stefano Balietti
+ * Copyright(c) 2021 Stefano Balietti
  * MIT Licensed
  *
  * Overlays the screen, disables inputs, and displays a message/timer
@@ -3098,8 +3092,8 @@
 
     // ## Meta-data
 
-    WaitScreen.version = '0.9.0';
-    WaitScreen.description = 'Shows a standard waiting screen';
+    WaitScreen.version = '0.10.0';
+    WaitScreen.description = 'Shows a waiting screen';
 
     // ## Helper functions
 
@@ -3206,10 +3200,10 @@
      *
      * Instantiates a new WaitScreen object
      *
-     * @param {object} options Optional. Configuration options
+     * @param {object} opts Optional. Configuration options
      */
-    function WaitScreen(options) {
-        options = options || {};
+    function WaitScreen(opts) {
+        opts = opts || {};
 
         /**
          * ### WaitScreen.id
@@ -3218,7 +3212,7 @@
          *
          * @see WaitScreen.waitingDiv
          */
-        this.id = options.id || 'ng_waitScreen';
+        this.id = opts.id || 'ng_waitScreen';
 
         /**
          * ### WaitScreen.root
@@ -3227,7 +3221,7 @@
          *
          * @see WaitScreen.waitingDiv
          */
-        this.root = options.root || null;
+        this.root = opts.root || null;
 
         /**
          * ### WaitScreen.waitingDiv
@@ -3285,23 +3279,60 @@
          * ### WaitScreen.countdown
          *
          * Countdown of max waiting time
-         *
-         * @see WaitScreen.countdown
          */
         this.countdown = null;
 
+        /**
+         * ### WaitScreen.displayCountdown
+         *
+         * If FALSE, countdown is never displayed by lock
+         *
+         * @see WaitScreen.lock
+         */
+        this.displayCountdown =
+            'undefined' !== typeof opts.displayCountdown ?
+                !!opts.displayCountdown : true;
+
         /**
          * ### WaitScreen.text
          *
          * Default texts for default events
          */
         this.defaultTexts = {
-            waiting: options.waitingText ||
+
+            // Default text for locked screen.
+            locked: opts.lockedText ||
+                'Screen locked. Please wait...',
+
+            // When player is DONE and waiting for others.
+            waiting: opts.waitingText ||
                 'Waiting for other players to be done...',
-            stepping: options.steppingText ||
+
+            // When entering a new step after DONE (displayed quickly usually).
+            stepping: opts.steppingText ||
                 'Initializing game step, will be ready soon...',
-            paused: options.pausedText ||
-                'Game is paused. Please wait.'
+
+            // Game paused.
+            paused: opts.pausedText ||
+                'Game is paused. Please wait.',
+
+            // Countdown text displayed under waiting text.
+            countdown: opts.countdownResumingText ||
+                '<br>Do not refresh the page!<br>Maximum Waiting Time: ',
+
+            // Displayed after resuming from waiting.
+            countdownResuming: opts.countdownResumingText ||
+                'Resuming soon...',
+
+            // Formats the countdown in minutes and seconds.
+            formatCountdown: function(time) {
+                var out;
+                out = '';
+                time = J.parseMilliseconds(time);
+                if (time[2]) out += time[2] + ' min ';
+                if (time[3]) out += time[3] + ' sec';
+                return out || 0;
+            }
         };
 
         /**
@@ -3368,9 +3399,11 @@
      * @see WaitScren.updateText
      */
     WaitScreen.prototype.lock = function(text, countdown) {
-        var frameDoc;
+        var frameDoc, t;
+        t = this.defaultTexts;
+        if ('undefined' === typeof text) text = t.locked;
         if ('undefined' === typeof document.getElementsByTagName) {
-            node.warn('WaitScreen.lock: cannot lock inputs.');
+            node.warn('WaitScreen.lock: cannot lock inputs');
         }
         // Disables all input forms in the page.
         lockUnlockedInputs(document);
@@ -3392,20 +3425,20 @@
         }
         this.contentDiv.innerHTML = text;
 
-        if (countdown) {
+        if (this.displayCountdown && countdown) {
+
             if (!this.countdownDiv) {
                 this.countdownDiv = W.add('div', this.waitingDiv,
                                           'ng_waitscreen-countdown-div');
 
-                this.countdownDiv.innerHTML = '<br>Do not refresh the page!' +
-                    '<br>Maximum Waiting Time: ';
+                this.countdownDiv.innerHTML = t.countdown;
 
                 this.countdownSpan = W.add('span', this.countdownDiv,
                                            'ng_waitscreen-countdown-span');
             }
 
             this.countdown = countdown;
-            this.countdownSpan.innerHTML = formatCountdown(countdown);
+            this.countdownSpan.innerHTML = t.formatCountdown(countdown);
             this.countdownDiv.style.display = '';
 
             this.countdownInterval = setInterval(function() {
@@ -3420,10 +3453,10 @@
                 if (w.countdown < 0) {
                     clearInterval(w.countdownInterval);
                     w.countdownDiv.style.display = 'none';
-                    w.contentDiv.innerHTML = 'Resuming soon...';
+                    w.contentDiv.innerHTML = t.countdownResuming;
                 }
                 else {
-                    w.countdownSpan.innerHTML = formatCountdown(w.countdown);
+                    w.countdownSpan.innerHTML = t.formatCountdown(w.countdown);
                 }
             }, 1000);
         }
@@ -3505,27 +3538,14 @@
         this.disable();
     };
 
-
-    // ## Helper functions.
-
-    function formatCountdown(time) {
-        var out;
-        out = '';
-        time = J.parseMilliseconds(time);
-        if (time[2]) out += time[2] + ' min ';
-        if (time[3]) out += time[3] + ' sec';
-        return out || 0;
-    }
-
-
 })(
     ('undefined' !== typeof node) ? node : module.parent.exports.node,
     ('undefined' !== typeof window) ? window : module.parent.exports.window
 );
 
 /**
  * # 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
@@ -3834,7 +3854,7 @@
      * @see InfoPanel.toggleBtn
      * @see InfoPanel.toggle
      */
-    InfoPanel.prototype.createToggleBtn = 
+    InfoPanel.prototype.createToggleBtn =
     InfoPanel.prototype.createToggleButton = function(label) {
         var that, button;
 
@@ -3861,7 +3881,7 @@
 })(
     ('undefined' !== typeof node) ? node : module.parent.exports.node,
     ('undefined' !== typeof window) ? window : module.parent.exports.window
-);;
+);
 
 /**
  * # selector