added DialogueContext, #1116

AlmasB · AlmasB · commit deec0ec961fd · 2021-11-15T13:42:59.000Z
diff --git a/fxgl-gameplay/src/main/kotlin/com/almasb/fxgl/cutscene/CutsceneService.kt b/fxgl-gameplay/src/main/kotlin/com/almasb/fxgl/cutscene/CutsceneService.kt
@@ -10,6 +10,7 @@ import com.almasb.fxgl.core.EngineService
 import com.almasb.fxgl.core.asset.AssetLoaderService
 import com.almasb.fxgl.core.collection.PropertyMap
 import com.almasb.fxgl.core.util.EmptyRunnable
+import com.almasb.fxgl.cutscene.dialogue.DialogueContext
 import com.almasb.fxgl.cutscene.dialogue.DialogueGraph
 import com.almasb.fxgl.cutscene.dialogue.DialogueScene
 import com.almasb.fxgl.cutscene.dialogue.FunctionCallHandler
@@ -35,17 +36,26 @@ class CutsceneService : EngineService() {
         scene.start(cutscene)
     }
 
-    @JvmOverloads fun startDialogueScene(dialogueGraph: DialogueGraph, functionHandler: FunctionCallHandler = EmptyFunctionCallHandler, onFinished: Runnable = EmptyRunnable) {
+    @JvmOverloads fun startDialogueScene(
+            dialogueGraph: DialogueGraph,
+            context: DialogueContext = TemporaryContext(),
+            functionHandler: FunctionCallHandler = EmptyFunctionCallHandler,
+            onFinished: Runnable = EmptyRunnable) {
+
         dialogueScene.gameVars = gameVars ?: throw IllegalStateException("Cannot start dialogue scene. The game is not initialized yet.")
         dialogueScene.assetLoader = assetLoader
-        dialogueScene.start(dialogueGraph, functionHandler, onFinished)
+        dialogueScene.start(dialogueGraph, context, functionHandler, onFinished)
     }
 
     override fun onGameReady(vars: PropertyMap) {
         gameVars = vars
     }
 }
 
+private class TemporaryContext : DialogueContext {
+    override fun properties(): PropertyMap = PropertyMap()
+}
+
 private object EmptyFunctionCallHandler : FunctionCallHandler {
     private val log = Logger.get(javaClass)
 
diff --git a/fxgl-gameplay/src/main/kotlin/com/almasb/fxgl/cutscene/dialogue/DialogueGraph.kt b/fxgl-gameplay/src/main/kotlin/com/almasb/fxgl/cutscene/dialogue/DialogueGraph.kt
@@ -6,6 +6,7 @@
 
 package com.almasb.fxgl.cutscene.dialogue
 
+import com.almasb.fxgl.core.collection.PropertyMap
 import com.almasb.fxgl.cutscene.dialogue.DialogueNodeType.*
 import javafx.beans.property.SimpleStringProperty
 import javafx.beans.property.StringProperty
@@ -24,6 +25,18 @@ fun interface FunctionCallHandler {
     fun handle(functionName: String, args: Array<String>): Any
 }
 
+/**
+ * The context in which a dialogue is running.
+ * For example, a single NPC could be a context.
+ */
+fun interface DialogueContext {
+
+    /**
+     * @return property map that is local to the dialogue context
+     */
+    fun properties(): PropertyMap
+}
+
 /* NODES */
 
 sealed class DialogueNode(
diff --git a/fxgl-gameplay/src/main/kotlin/com/almasb/fxgl/cutscene/dialogue/DialogueScene.kt b/fxgl-gameplay/src/main/kotlin/com/almasb/fxgl/cutscene/dialogue/DialogueScene.kt
@@ -171,11 +171,11 @@ class DialogueScene(private val sceneService: SceneService) : SubScene() {
         animation2.startReverse()
     }
 
-    fun start(dialogueGraph: DialogueGraph, functionHandler: FunctionCallHandler, onFinished: Runnable) {
+    fun start(dialogueGraph: DialogueGraph, context: DialogueContext, functionHandler: FunctionCallHandler, onFinished: Runnable) {
         graph = dialogueGraph.copy()
         this.functionHandler = functionHandler
         this.onFinished = onFinished
-        dialogueScriptRunner = DialogueScriptRunner(gameVars, functionHandler)
+        dialogueScriptRunner = DialogueScriptRunner(gameVars, context.properties(), functionHandler)
 
         // while graph has subdialogue nodes, expand
         while (graph.nodes.any { it.value.type == SUBDIALOGUE }) {
diff --git a/fxgl-gameplay/src/main/kotlin/com/almasb/fxgl/cutscene/dialogue/DialogueScriptRunner.kt b/fxgl-gameplay/src/main/kotlin/com/almasb/fxgl/cutscene/dialogue/DialogueScriptRunner.kt
@@ -14,14 +14,21 @@ import com.almasb.fxgl.logging.Logger
  * @author Almas Baimagambetov (almaslvl@gmail.com)
  */
 internal class DialogueScriptRunner(
+
+        /**
+         * Variables global to the game.
+         */
         private val gameVars: PropertyMap,
+
+        /**
+         * Variables local to the dialogue context.
+         */
+        private val localVars: PropertyMap,
         private val functionHandler: FunctionCallHandler
 ) {
 
     private val log = Logger.get<DialogueScriptRunner>()
 
-    private val localVars = hashMapOf<String, Any>()
-
     /**
      * Given a [line], this function replaces all variables with their values.
      */
@@ -43,8 +50,8 @@ internal class DialogueScriptRunner(
         var result = line
 
         varNames.forEach {
-            if (it in localVars) {
-                val value = localVars[it]
+            if (localVars.exists(it)) {
+                val value = localVars.getValue<Any>(it)
                 result = result.replace("\$$it", value.toString())
 
             } else if (gameVars.exists(it)) {
@@ -112,8 +119,8 @@ internal class DialogueScriptRunner(
 
         if (tokens.size == 1) {
             // check if this is a boolean variable -- the only valid variable to use here
-            if (funcName in localVars) {
-                return localVars[funcName]!!
+            if (localVars.exists(funcName)) {
+                return localVars.getValue(funcName)
             }
 
             if (gameVars.exists(funcName)) {
@@ -131,12 +138,13 @@ internal class DialogueScriptRunner(
         val varName = line.substringBefore('=').trim()
         val varValue = line.substringAfter('=').trim().toTypedValue()
 
-        if (varName in localVars) {
-            localVars[varName] = varValue
+        if (localVars.exists(varName)) {
+            localVars.setValue(varName, varValue)
         } else if (gameVars.exists(varName)) {
             gameVars.setValue(varName, varValue)
         } else {
-            localVars[varName] = varValue
+            // does not exist anywhere, create locally
+            localVars.setValue(varName, varValue)
         }
     }
 }
diff --git a/fxgl-gameplay/src/test/kotlin/com/almasb/fxgl/cutscene/dialogue/DialogueScriptRunnerTest.kt b/fxgl-gameplay/src/test/kotlin/com/almasb/fxgl/cutscene/dialogue/DialogueScriptRunnerTest.kt
@@ -31,7 +31,7 @@ class DialogueScriptRunnerTest {
         map.setValue("isAlive", true)
         map.setValue("isSleeping", false)
 
-        runner = DialogueScriptRunner(map) { funcName, args ->
+        runner = DialogueScriptRunner(map, PropertyMap()) { funcName, args ->
 
             var result: Any = ""
 
