Merge pull request #57 from a2i2/nick/interruption-text-changes

Update the various text based off if its the 1st or 2nd attempt [CON-2665]

Author: joostfunkekupper

EEFRT Demo Android/app/src/main/java/ai/a2i2/conductor/effrtdemoandroid/persistence/GameStorage.kt

@@ -1,5 +1,6 @@
 package ai.a2i2.conductor.effrtdemoandroid.persistence
 
+import ai.a2i2.conductor.effrtdemoandroid.util.GameConfigUtils
 import android.content.Context
 import hu.autsoft.krate.SimpleKrate
 import hu.autsoft.krate.booleanPref
@@ -18,9 +19,16 @@ data class GameCache(
     val randTrialsIdx: List<Int>? = null,
     val trialSeqFilename: String? = null,
     var calibrationComplete: Boolean = false,
-    var interruptionTimestamp: Long? = null
+    var interruptionTimestamp: Long? = null,
+    var attemptCount: Int = 1
 ) {
     fun isResumeTrialAvailable(context: Context): Boolean {
+        // Allow the user to resume from the beginning if triggering 2A interruption scenario
+        val gameStorage = GameStorage(context)
+        if (!practiceComplete && !gameStorage.gameMarkedAsComplete && gameStorage.eefrtAttemptCount == GameConfigUtils.MAX_EEFRT_ATTEMPTS) {
+            return true
+        }
+
         return (practiceComplete || trialNumber > 0) && !GameStorage(context).gameMarkedAsComplete
     }
 }

EEFRT Demo Android/app/src/main/java/ai/a2i2/conductor/effrtdemoandroid/ui/EefrtScreen.kt

@@ -6,6 +6,7 @@ import ai.a2i2.conductor.effrtdemoandroid.persistence.PracticeTaskAttempt
 import ai.a2i2.conductor.effrtdemoandroid.persistence.TaskAttempt
 import ai.a2i2.conductor.effrtdemoandroid.ui.data.CloseMessage
 import ai.a2i2.conductor.effrtdemoandroid.ui.data.EefrtScreenViewModel
+import ai.a2i2.conductor.effrtdemoandroid.util.GameConfigUtils
 import android.annotation.SuppressLint
 import android.content.Context
 import android.os.Handler
@@ -120,6 +121,7 @@ fun EefrtScreen(
                                 cache.calibrationComplete = true
                                 cache.maxPressCount = gameStorage.calibratedMaxPressCount!!
                             }
+                            cache.attemptCount = gameStorage.eefrtAttemptCount
 
                             val json = Json {
                                 encodeDefaults = true
@@ -261,6 +263,7 @@ private fun handleMessage(
                     )
                     val currentAttemptCount = GameStorage(context).eefrtAttemptCount
                     viewModel.updateEEFRTAttemptCount(context, currentAttemptCount + 1)
+                    GameStorage(context).cachedGameState?.attemptCount++
                 }
 
                 // ensure the game data is reset if we've actually closed the task, similar scenario to the shouldShowExitDialog
@@ -269,8 +272,22 @@ private fun handleMessage(
                         TAG,
                         "Task will be restarted on next load"
                     )
-                    viewModel.setCurrentGameState(context, null)
-                    viewModel.resumeTrialAvailable.value = false
+
+                    // Allow the resume button to appear if they trigger the 2A interruption
+                    // Need to check for the trialNumber >=2 since the trial number is already incremented before this check is done
+                    // The '2' value below being compared to the current trial number is generated due to the following:
+                    // 1 (index of trial 2) + 1 (above increment to trial number which occurs before the interruption dialog is shown)
+                    val gameStorage = GameStorage(context)
+                    val cache = gameStorage.cachedGameState
+                    if (cache != null && cache.practiceComplete && cache.trialNumber <= 2) {
+                        viewModel.setCurrentGameState(context, GameCache())
+
+                        // only show the resume button if its within the 2 attempts
+                        viewModel.resumeTrialAvailable.value = gameStorage.eefrtAttemptCount <= GameConfigUtils.MAX_EEFRT_ATTEMPTS
+                    } else {
+                        viewModel.setCurrentGameState(context, null)
+                        viewModel.resumeTrialAvailable.value = false
+                    }
                 }
 
                 if (closeMessage.shouldShowExitDialog) {

EEFRT Demo Android/app/src/main/java/ai/a2i2/conductor/effrtdemoandroid/ui/data/EefrtScreenViewModel.kt

@@ -141,6 +141,7 @@ class EefrtScreenViewModel(
                 )
                 val currentValue = GameStorage(context).eefrtAttemptCount
                 updateEEFRTAttemptCount(context, currentValue + 1)
+                GameStorage(context).cachedGameState?.attemptCount++
             }
 
             if (it.taskRequiresRestart) {

EEFRT Demo iOS/EEFRT Demo/EEFRTViewController.swift

@@ -145,6 +145,7 @@ class EEFRTViewController: UIViewController {
             cache.calibrationComplete = calibrationComplete
             cache.maxPressCount = calibratedMaxPressCount
         }
+        cache.attemptCount = Defaults.eefrtAttemptCount
 
         if let stringifiedGameCache = try? cache.stringify() {
             let gameCacheJsString = "window.setupGameWithCache(\(stringifiedGameCache));"
@@ -204,6 +205,7 @@ class EEFRTViewController: UIViewController {
                     // increment attempt count in the main app
                     os_log(.debug, "Incremented attempt count")
                     Defaults.eefrtAttemptCount += 1
+                    Defaults.gameCache?.attemptCount += 1
                 }
 
                 if closeMessage.taskRequiresRestart {
@@ -250,13 +252,23 @@ extension EEFRTViewController: WKScriptMessageHandler {
                     // increment attempt count - in main app
                     os_log(.debug, "Incremented attempt count")
                     Defaults.eefrtAttemptCount += 1
+                    Defaults.gameCache?.attemptCount += 1
                 }
 
                 // ensure the game data is reset if we've actually closed the task, similar scenario to the shouldShowExitDialog
                 if !closeMessage.shouldShowExitDialog, closeMessage.taskRequiresRestart {
                     // the task needs to be restarted
                     os_log(.debug, "Task will be restarted on next load")
-                    Defaults.gameCache = nil
+
+                    // Allow the resume button to appear if they trigger the 2A interruption
+                    // Need to check for the trialNumber >=2 since the trial number is already incremented before this check is done
+                    // The '2' value below being compared to the current trial number is generated due to the following:
+                    // 1 (index of trial 2) + 1 (above increment to trial number which occurs before the interruption dialog is shown)
+                    if let cache = Defaults.gameCache, cache.practiceComplete, cache.trialNumber <= 2 {
+                        Defaults.gameCache = GameCache()
+                    } else {
+                        Defaults.gameCache = nil
+                    }
                 }
 
                 if closeMessage.shouldShowExitDialog {

EEFRT Demo iOS/EEFRT Demo/Models/GameCache.swift

@@ -11,6 +11,7 @@ struct GameCache: Codable, DefaultsSerializable {
     var trialSeqFilename: String?
     var calibrationComplete: Bool
     var interruptionTimestamp: Int64?
+    var attemptCount: Int
 
     // Default initializer with default values
     init(
@@ -22,7 +23,8 @@ struct GameCache: Codable, DefaultsSerializable {
         randTrialsIdx: [Int]? = nil,
         trialSeqFilename: String? = nil,
         calibrationComplete: Bool = false,
-        interuptionTimestamp: Int64? = nil
+        interuptionTimestamp: Int64? = nil,
+        attemptCount: Int = 1
     ) {
         self.practiceComplete = practiceComplete
         self.trialNumber = trialNumber
@@ -33,6 +35,7 @@ struct GameCache: Codable, DefaultsSerializable {
         self.trialSeqFilename = trialSeqFilename
         self.calibrationComplete = calibrationComplete
         self.interruptionTimestamp = interuptionTimestamp
+        self.attemptCount = attemptCount
     }
 
     // Decoder initializer
@@ -47,6 +50,7 @@ struct GameCache: Codable, DefaultsSerializable {
         self.trialSeqFilename = try container.decodeIfPresent(String.self, forKey: .trialSeqFilename)
         self.calibrationComplete = try container.decode(Bool.self, forKey: .calibrationComplete)
         self.interruptionTimestamp = try container.decodeIfPresent(Int64.self, forKey: .interruptionTimestamp)
+        self.attemptCount = try container.decode(Int.self, forKey: .attemptCount)
     }
 
     func encode(to encoder: any Encoder) throws {
@@ -60,6 +64,7 @@ struct GameCache: Codable, DefaultsSerializable {
         try container.encodeIfPresent(trialSeqFilename, forKey: .trialSeqFilename)
         try container.encodeIfPresent(calibrationComplete, forKey: .calibrationComplete)
         try container.encodeIfPresent(interruptionTimestamp, forKey: .interruptionTimestamp)
+        try container.encode(attemptCount, forKey: .attemptCount)
     }
 
     private enum CodingKeys: String, CodingKey {
@@ -72,15 +77,21 @@ struct GameCache: Codable, DefaultsSerializable {
         case trialSeqFilename
         case calibrationComplete
         case interruptionTimestamp
+        case attemptCount
     }
 
     func stringify() throws -> String {
         let encoder = JSONEncoder()
         let data = try encoder.encode(self)
         return String(decoding: data, as: UTF8.self)
     }
-    
+
     func isResumeTrialAvailable() -> Bool {
-        (practiceComplete || trialNumber > 0) && !Defaults.gameMarkedAsComplete
+        // Allow the user to resume from the beginning if triggering 2A interruption scenario
+        if practiceComplete == false, !Defaults.gameMarkedAsComplete, Defaults.eefrtAttemptCount == GameConfigUtils.maxEefrtAttempts {
+            return true
+        }
+
+        return (practiceComplete || trialNumber > 0) && !Defaults.gameMarkedAsComplete
     }
 }

public/src/elements/BottomScreenPanel.js

@@ -7,6 +7,7 @@ export const TIMEOUT_TAG = 'bottomScreenTimeout';
 export const ARE_YOU_THERE_TAG = 'bottomScreenAreYouThere';
 export const EXIT_TASK_TAG = 'bottomScreenExitTask';
 export const GAME_COMPLETE_TAG = 'bottomScreenGameComplete';
+export const TASK_INTERRUPTED_TAG = 'bottomScreenTaskInterrupted';
 
 export default class BottomScreenPanel {
     constructor(scene, x, titleString, subtitleString, bottomButtonString, breakTimeMS, tag, onContinuePressed = () => {}, onTimeout = () => {}) {

public/src/embedContext/GameCache.js

@@ -1,7 +1,7 @@
 export default class GameCache {
     static cache = null;
 
-    constructor(practiceComplete, trialNumber, maxPressCount, coinRunningTotal, trialResults, randTrialsIdx, trialSeqFilename, calibrationComplete, interruptionTimestamp) {
+    constructor(practiceComplete, trialNumber, maxPressCount, coinRunningTotal, trialResults, randTrialsIdx, trialSeqFilename, calibrationComplete, interruptionTimestamp, attemptCount) {
         this.practiceComplete = practiceComplete;
         this.trialNumber = trialNumber;
         this.maxPressCount = maxPressCount;
@@ -11,6 +11,7 @@ export default class GameCache {
         this.trialSeqFilename = trialSeqFilename;
         this.calibrationComplete = calibrationComplete;
         this.interruptionTimestamp = interruptionTimestamp;
+        this.attemptCount = attemptCount;
     }
 
     stringify() {

public/src/scenes/mainTask.js

@@ -25,7 +25,7 @@ import { POWER_UP_COMPLETE_KEY } from "../elements/PowerPanel.js";
 import GameCache from "../embedContext/GameCache.js";
 import TaskAttempt from "../embedContext/TaskAttempt.js";
 import { POWER_COUNTDOWN_KEY } from "../elements/CountdownPanel.js";
-import { BREAK_TAG, TIMEOUT_TAG, ARE_YOU_THERE_TAG, EXIT_TASK_TAG, GAME_COMPLETE_TAG } from "../elements/BottomScreenPanel.js";
+import { BREAK_TAG, TIMEOUT_TAG, ARE_YOU_THERE_TAG, EXIT_TASK_TAG, GAME_COMPLETE_TAG, TASK_INTERRUPTED_TAG } from "../elements/BottomScreenPanel.js";
 import InteruptionsHandler from "../embedContext/InteruptionsHandler.js";
 import CloseMessage from "../embedContext/CloseMessage.js";
 
@@ -763,7 +763,7 @@ var trialEnd = function () {
     // if an interruption occured and we need to show the are you still there dialog, show it
     else if (this.interruptionShowAreYouThereDialog == true && !isLastTrial) {
         stopPlayer(this);
-        showMissedTrialDialog(this);
+        showTaskInterruptedDialog(this);
         this.interruptionShowAreYouThereDialog = false;
     }
     // if an interruption occured and we need to show the times up dialog, show it
@@ -822,7 +822,7 @@ var loadGameFromCache = function(context) {
     const cache = GameCache.cache;
     if (cache == null) {
         // if no cache to load from, create a new one with the default values
-        GameCache.cache = new GameCache(true, 0, undefined, 0, {}, [], context.trialSequenceFile, null);
+        GameCache.cache = new GameCache(true, 0, undefined, 0, {}, [], context.trialSequenceFile, false, null, 1);
         return;
     }
 
@@ -948,7 +948,7 @@ var showTimeUpDialog = function(context) {
         return;
     }
 
-    let timeoutMessage = "Unfortunately you've run out of time to continue the this task. Try again to recieve a bonus payment.";
+    let timeoutMessage = "Unfortunately you\'ve run out of time to continue the this task. Try again to recieve a bonus payment.";
     let showExitDialog = false;
     let incrementAttemptCount = true;
 
@@ -988,13 +988,16 @@ var showBreakDialog = function(context) {
 }
 
 var showExitTaskDialog = function(context) {
-    let retryTaskText = "You've been away too long, and may need to try again.";
+    let isSecondAttempt = GameCache.cache?.attemptCount == 2;
+    let retryTaskText = isSecondAttempt ? "You\'ve been away too long, and it was your second attempt. Unfortunately you wont be able to earn any more coins." : "You\'ve been away too long, try again for a chance to earn more coins."
+    let titleText = isSecondAttempt ? "Exit task" : "Try again"
+    
     let showExitDialog = false;
     let incrementAttemptCount = true;
 
     showBottomScreenPanel(
         context,
-        "Retry task",
+        titleText,
         retryTaskText,
         "EXIT",
         null,
@@ -1005,7 +1008,7 @@ var showExitTaskDialog = function(context) {
 }
 
 var showTaskCompleteDialog = function(context) {
-    let taskCompleteText = "You've reached the minimum required number of completed trials but due to an interruption you cannot progress through the rest of the trials. You will still recieve your bonus payment.";
+    let taskCompleteText = "You\'ve reached the minimum required number of completed rounds but due to an interruption you cannot progress through the rest of the rounds. You will still recieve your bonus payment.";
 
     showBottomScreenPanel(
         context,
@@ -1019,6 +1022,26 @@ var showTaskCompleteDialog = function(context) {
     );
 }
 
+var showTaskInterruptedDialog = function(context) {
+    // check to see if this is the first attempt and show a different message explaining that they cannot return if its the 2nd attempt
+    let cache = GameCache.cache;
+    var taskInterruptedText = "Ready to continue? Keep going in the next 2 mins to keep collecting coins.";
+    if (cache != null && cache.attemptCount > 1) {
+        taskInterruptedText = "Ready to continue? This is your last attempt to collect more coins.";
+    }
+
+    showBottomScreenPanel(
+        context,
+        "Task interrupted",
+        taskInterruptedText,
+        "CONTINUE",
+        breakTime,
+        TASK_INTERRUPTED_TAG,
+        () => { continueGameAfterBreak(context); },
+        () => { showTimeUpDialog(context); }
+    );
+}
+
 var showBottomScreenPanel = function(context, titleText, subtitleText, bottomButtonText, countdownTimerMS, tag, onContinuePressed, onTimeout) {
     let camera = context.cameras.main;
 
@@ -1157,9 +1180,10 @@ var saveData = function(context) {
 
     // if the user has reached at least 80% then we can mark the calibration as completed
     var calibrationComplete = GameCache.cache?.calibrationComplete == true || trialNo + 1 >= nTrials * taskRewardsPayoutThreshold;
+    let eefrtAttemptCount = GameCache.cache?.attemptCount ?? 1;
 
     // notify the native apps of what the current game state is so they can cache it
-    let currentGameState = new GameCache(true, trialNo + 1, thresholdMax, nCoins, coinChoices, randTrialsIdx, context.trialSequenceFile, calibrationComplete);
+    let currentGameState = new GameCache(true, trialNo + 1, thresholdMax, nCoins, coinChoices, randTrialsIdx, context.trialSequenceFile, calibrationComplete, null, eefrtAttemptCount);
     GameCache.cache = currentGameState;
     EmbedContext.sendMessage('currentGameCache', currentGameState.stringify());
 }

public/src/scenes/practiceTask.js

@@ -7,6 +7,7 @@ import Coins from "../elements/coins.js";
 import RouteSelectorPanel from "../elements/RouteSelectorPanel.js";
 import ProgressBar from "../elements/progressBar.js";
 import PowerPanel, { PRACTICE_POWER_UP_COMPLETE_KEY } from "../elements/PowerPanel.js";
+import { ENTRY_POINT_PRACTICE } from "../scenes/startTaskScene.js";
 
 // import our custom events center for passsing info between scenes annd relevant data saving function
 import eventsCenter from '../eventsCenter.js'
@@ -22,6 +23,7 @@ import InteruptionsHandler from "../embedContext/InteruptionsHandler.js";
 import CloseMessage from "../embedContext/CloseMessage.js";
 import BottomScreenPanel from "../elements/BottomScreenPanel.js";
 import { EXIT_TASK_TAG } from "../elements/BottomScreenPanel.js"
+import StartTaskScene from "./startTaskScene.js";
 
 // initialize some global vars
 var gameHeight;
@@ -302,6 +304,9 @@ export default class PracticeTask extends BaseScene {
             Once we complete all 4 practice trials we we want to save the maxPressCount to the cache and the registry so it can be used in the main trials.
         */
         if (pracTrial == nPracTrials) {
+            // let the start task scene know we arrived from the practice screens
+            StartTaskScene.entryPoint = ENTRY_POINT_PRACTICE;
+
             let calibrationComplete = false;
             if (GameCache.cache?.calibrationComplete == true) {
                 calibrationComplete = true;
@@ -310,7 +315,8 @@ export default class PracticeTask extends BaseScene {
 
             // signal to the cache that the practice is complete
             let trialSeqFilename = GameCache.cache?.trialSeqFilename || null;
-            let cache = new GameCache(true, 0, maxPressCount, 0, {}, null, trialSeqFilename, calibrationComplete, null)
+            let eefrtAttemptCount = GameCache.cache?.attemptCount ?? 1;
+            let cache = new GameCache(true, 0, maxPressCount, 0, {}, null, trialSeqFilename, calibrationComplete, null, eefrtAttemptCount)
             GameCache.cache = cache;
             EmbedContext.sendMessage('currentGameCache', cache.stringify());
 
@@ -331,9 +337,10 @@ export default class PracticeTask extends BaseScene {
             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;
+        let isLastPracticeTrial = pracTrial == nPracTrials - 1;
+        let routeOrPowerAnimationKeys = ['powerup', 'wait'];
 
-            if (this.player.sprite.x <= decisionPointX && this.player.sprite.anims.currentAnim.key == 'run' && !isLastPracticeTrial) {
+        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
@@ -356,7 +363,7 @@ export default class PracticeTask extends BaseScene {
             // 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) {
+        } else if (this.powerPanel != null && routeOrPowerAnimationKeys.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