Adding the ability to interrupt the Display's listeners, see #218 (co…

…mment)
phetsims · Dec 17, 2019 · 9032474 · 9032474
1 parent dc95452
commit 9032474
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/js/display/Display.js b/js/display/Display.js
@@ -1141,6 +1141,24 @@ define( require => {
     },
     get inputListeners() { return this.getInputListeners(); },
 
+    /**
+     * Interrupts all input listeners that are attached to this Display.
+     * @public
+     *
+     * @returns {Display} - For chaining
+     */
+    interruptInput: function() {
+      const listenersCopy = this.inputListeners;
+
+      for ( let i = 0; i < listenersCopy.length; i++ ) {
+        const listener = listenersCopy[ i ];
+
+        listener.interrupt && listener.interrupt();
+      }
+
+      return this;
+    },
+
     ensureNotPainting: function() {
       assert && assert( !this._isPainting,
         'This should not be run in the call tree of updateDisplay(). If you see this, it is likely that either the ' +

diff --git a/js/nodes/Node.js b/js/nodes/Node.js
@@ -1935,7 +1935,7 @@ define( require => {
       for ( let i = 0; i < listenersCopy.length; i++ ) {
         const listener = listenersCopy[ i ];
 
-        listener.interrupt && listener.interrupt(); // TODO: get rid of the event?
+        listener.interrupt && listener.interrupt();
       }
 
       return this;