Immediately show the exit dialog when interrupted in the practice trials

Author: NicholasM365

public/src/embedContext/InteruptionsHandler.js

@@ -18,9 +18,8 @@ export default class InteruptionsHandler {
 
         // scenario 1 - interupted during practice rounds before main trials - restart from practice with no increment to attempt count
         if (cache.practiceComplete == false && cache.trialNumber == 0) {
-            console.log('1A');
-            // show exit task dialog to let the user know they need to exit and return to the task from the beginning of the practice rounds
-            context.interruptionExitTaskDialog = true;
+            // show the exit dialog immedately after an interruption
+            context.showExitDialogAfterInterruption();
             return;
         }
 

public/src/scenes/practiceTask.js

@@ -140,6 +140,8 @@ export default class PracticeTask extends BaseScene {
 
         this.interruptionExitTaskDialog = false;
         this.bottomScreenPanel = null;
+        this.powerPanel = null;
+        this.interruptionOccured = false;
 
         ////////////////////////CREATE WORLD//////////////////////////////////////
         // game world created in Tiled (https://www.mapeditor.org/)
@@ -317,6 +319,69 @@ export default class PracticeTask extends BaseScene {
             this.launchNextScene();
         }
     }
+
+    showExitDialogAfterInterruption() {
+        // a user was interrupted whilst in the middle of an individual trial, in this scenario we won't allow them to
+        // continue to the next practice trial.
+        // In all scenarios we will show the exit dialog and the user will need to restart from the beginning of the practice task.
+    
+        /*
+            1. If current animation playing is the walking animation before the route selector apears
+            2. If the route selector panel is visible,
+            3. If the power up scene is active
+            4. If the user has already completed the trial and is crossing the bridge, show the dialog once pickle reaches the end of the bridge
+        */
+            let isLastPracticeTrial = pracTrial == nPracTrials - 1;
+
+            if (this.player.sprite.x <= decisionPointX && this.player.sprite.anims.currentAnim.key == 'run' && !isLastPracticeTrial) {
+            console.log('1A-A');
+
+            // no active panel, stop the player and show the dialog
+            stopPlayer(this);
+            showExitTaskDialog(this);
+        } else if (this.instructionsPanel != null && this.player.sprite.body.velocity.x == 0 && this.player.sprite.anims.currentAnim.key == 'wait' && !isLastPracticeTrial) {
+            console.log('1A-B');
+
+            // remove any active feedback message
+            if (feedbackMessage) {
+                clearTimeout(routeSelectionTransitionTimer);
+                feedbackMessage.destroy();
+                feedbackMessage = null;
+            }
+
+            // remove the route selector panel
+            this.instructionsPanel.destroy();
+            this.instructionsPanel = null;
+
+            // show the exit task dialog in its place
+            stopPlayer(this);
+            showExitTaskDialog(this);
+        } else if (this.powerPanel != null && ['powerup', 'wait'].includes(this.player.sprite.anims.currentAnim.key) && !isLastPracticeTrial) {
+            console.log('1A-C');
+
+            // mark that an interruption occured so the feedback message dismiss handler doesn't run
+            this.interruptionOccured = true;
+
+            // remove any active feedback message
+            if (feedbackMessage) {
+                clearTimeout(routeSelectionTransitionTimer);
+                feedbackMessage.destroy();
+                feedbackMessage = null;
+            }
+
+            // remove the power panel
+            this.powerPanel.destroy();
+            this.powerPanel = null;
+            
+            // show the exit task dialog in its place
+            stopPlayer(this);
+            showExitTaskDialog(this);  
+        } else {
+            // do nothing, player will be walking across the bridge, the exit dialog will be shown at the end of the bridge
+            console.log('1A-D');
+            this.interruptionExitTaskDialog = true;
+        }
+    }
 }
 
 ///////////////////////////////FUNCTIONS FOR CONTROLLING TRIAL SEQUENCE/////////////////////////////////////
@@ -530,7 +595,9 @@ var effortOutcome = function() {
         // then play powerup fail anim and progress via slow route
         this.time.addEvent({delay: pracFeedbackTime + 250, 
                             callback: function(){
-                                feedbackMessage.destroy();
+                                if (this.interruptionOccured) { return; }
+
+                                feedbackMessage?.destroy();
                                 // then play short 'powerup fail' anim:
                                 this.player.sprite.anims.play('powerupfail', true);
                                 // and progress via bridge route (with sad face)
@@ -587,6 +654,8 @@ var effortOutcome = function() {
             // then player floats across 'high route' and collects coins
             this.time.addEvent({delay: pracFeedbackTime + 250, 
                 callback: function(){
+                    if (this.interruptionOccured) { return; }
+
                     let playerSpeedAdjustment = window.innerHeight < 800 ? 4 : 3; // slow down the player a bit more on the smaller screens so they dont miss the coins
                     feedbackMessage?.destroy();
                     this.player.sprite.anims.play('float', true);    
@@ -601,6 +670,8 @@ var effortOutcome = function() {
             // then player floats across 'low route' and collects coins
             this.time.addEvent({delay: pracFeedbackTime + 250, 
                 callback: function() {
+                    if (this.interruptionOccured) { return; }
+
                     feedbackMessage?.destroy();
                     this.player.sprite.anims.play('float', true);    
                     this.player.sprite.setVelocityX(playerVelocity/3);
@@ -644,7 +715,9 @@ var effortOutcome = function() {
         // then play powerup fail anim and progress via slow route
         this.time.addEvent({delay: pracFeedbackTime + 250, 
                             callback: function(){
-                                feedbackMessage.destroy();
+                                if (this.interruptionOccured) { return; }
+
+                                feedbackMessage?.destroy();
                                 // then play short 'powerup fail' anim:
                                 this.player.sprite.anims.play('powerupfail', true);
                                 // and progress via bridge route (with sad face)
@@ -665,6 +738,20 @@ var effortOutcome = function() {
 
 // 4. When player hits end of scene, save trial data and move on to the next trial (reload the scene)
 var pracTrialEnd = function () {
+    // if the interruption needs to be shown, just show that, no practice trial data will be sent off,
+    // no maxPressCount update, etc. The user will have to return to the start of the practice trials so
+    // they will go through the calibration rounds eventually
+
+    let isLastPracticeTrial = pracTrial == nPracTrials - 1;
+    // if we encountered an interruption, show the exit dialog but dont increment attempt count.
+    // theres no need to reset progress since since the game state isn't updated untill we complete all the practice rounds
+    if (this.interruptionExitTaskDialog == true && !isLastPracticeTrial) {
+        stopPlayer(this);
+        showExitTaskDialog(this);
+        this.interruptionExitTaskDialog = false;
+        return;
+    }
+
     // determine if pressCount exceeded previous practice trials,
     // we don't want to update the max press count if we've completed the calibration
     if (GameCache.cache?.calibrationComplete == true) {
@@ -692,19 +779,14 @@ var pracTrialEnd = function () {
     // savePracTaskData(pracTrial, this.registry.get(`pracTrial${pracTrial}`));    // [for firebase]
     //saveTrialDataPav(this.registry.get(`pracTrial${pracTrial}`));             // [for Pavlovia deployment]
 
-    let isLastPracticeTrial = pracTrial == nPracTrials - 1;
-    // if we encountered an interruption, show the exit dialog but dont increment atempt count.
-    // theres no need to reset progress since since the game state isn't updated untill we complete all the practice rounds
-    if (this.interruptionExitTaskDialog == true && !isLastPracticeTrial) {
-        stopPlayer(this);
-        showExitTaskDialog(this);
-        this.interruptionExitTaskDialog = false;
-    } else {
-        // iterate trial number
-        pracTrial++; 
-        // move to next trial
-        this.scene.restart();
-    }
+    // iterate trial number
+    pracTrial++; 
+
+    // clear any event listners still active so they aren't leaked
+    eventsCenter.removeAllListeners();
+
+    // move to next trial
+    this.scene.restart();
 };