feat: added EngineService onGameReset() to allow services to clean up and get ready for a new game

AlmasB · AlmasB · commit 7b85fe017add · 2024-03-17T19:05:35.000Z
diff --git a/fxgl-core/src/main/kotlin/com/almasb/fxgl/core/EngineService.kt b/fxgl-core/src/main/kotlin/com/almasb/fxgl/core/EngineService.kt
@@ -47,6 +47,12 @@ abstract class EngineService : Updatable, SerializableType {
      */
     open fun onGameUpdate(tpf: Double) { }
 
+    /**
+     * Called on the JavaFX thread after the game scene has been reset,
+     * when starting a new game or loading the game from a save file.
+     */
+    open fun onGameReset() { }
+
     /**
      * Called just before the engine exits and the application shuts down.
      */
diff --git a/fxgl/src/main/kotlin/com/almasb/fxgl/app/Engine.kt b/fxgl/src/main/kotlin/com/almasb/fxgl/app/Engine.kt
@@ -174,6 +174,10 @@ internal class Engine(val settings: ReadOnlyGameSettings) {
         services.forEach { it.onMainLoopResumed() }
     }
 
+    fun resetServices() {
+        services.forEach { it.onGameReset() }
+    }
+
     fun write(bundle: Bundle) {
         settings.write(bundle)
         services.forEach { it.write(bundle) }
diff --git a/fxgl/src/main/kotlin/com/almasb/fxgl/app/FXGLApplication.kt b/fxgl/src/main/kotlin/com/almasb/fxgl/app/FXGLApplication.kt
@@ -636,6 +636,7 @@ class FXGLApplication : Application() {
             log.debug("Clearing previous game")
 
             gameSceneRef.reset()
+            engine.resetServices()
         }
 
         fun saveGame(dataFile: DataFile) {

Original file line number	Diff line number	Diff line change
`@@ -636,6 +636,7 @@ class FXGLApplication : Application() {`
`636`	`636`	`log.debug("Clearing previous game")`
`637`	`637`
`638`	`638`	`gameSceneRef.reset()`
	`639`	`+ engine.resetServices()`
`639`	`640`	`}`
`640`	`641`
`641`	`642`	`fun saveGame(dataFile: DataFile) {`