feat: added EngineService onVarsInitialized() to notify services when game vars are ready to use

AlmasB · AlmasB · commit 75fc7f152638 · 2024-03-17T20:50:27.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
@@ -30,6 +30,12 @@ abstract class EngineService : Updatable, SerializableType {
      */
     open fun onMainLoopStarting() { }
 
+    /**
+     * Called after initGameVars() is completed.
+     * This is called on a background thread.
+     */
+    open fun onVarsInitialized(vars: PropertyMap) { }
+
     /**
      * Called when initGame(), initPhysics(), initUI() all completed and
      * the game is ready to be played.
diff --git a/fxgl/src/main/kotlin/com/almasb/fxgl/app/Engine.kt b/fxgl/src/main/kotlin/com/almasb/fxgl/app/Engine.kt
@@ -138,6 +138,10 @@ internal class Engine(val settings: ReadOnlyGameSettings) {
         services.forEach { it.onGameUpdate(tpf) }
     }
 
+    fun onVarsInitialized(vars: PropertyMap) {
+        services.forEach { it.onVarsInitialized(vars) }
+    }
+
     fun onGameReady(vars: PropertyMap) {
         services.forEach { it.onGameReady(vars) }
     }
diff --git a/fxgl/src/main/kotlin/com/almasb/fxgl/app/FXGLApplication.kt b/fxgl/src/main/kotlin/com/almasb/fxgl/app/FXGLApplication.kt
@@ -338,6 +338,8 @@ class FXGLApplication : Application() {
                 FXGL.getWorldProperties().setValue(name, value)
             }
 
+            engine.onVarsInitialized(FXGL.getWorldProperties())
+
             app.initGame();
         }
 

Original file line number	Diff line number	Diff line change
`@@ -138,6 +138,10 @@ internal class Engine(val settings: ReadOnlyGameSettings) {`
`138`	`138`	`services.forEach { it.onGameUpdate(tpf) }`
`139`	`139`	`}`
`140`	`140`
	`141`	`+ fun onVarsInitialized(vars: PropertyMap) {`
	`142`	`+ services.forEach { it.onVarsInitialized(vars) }`
	`143`	`+ }`
	`144`	`+`
`141`	`145`	`fun onGameReady(vars: PropertyMap) {`
`142`	`146`	`services.forEach { it.onGameReady(vars) }`
`143`	`147`	`}`
Original file line number	Diff line number	Diff line change
`@@ -338,6 +338,8 @@ class FXGLApplication : Application() {`
`338`	`338`	`FXGL.getWorldProperties().setValue(name, value)`
`339`	`339`	`}`
`340`	`340`
	`341`	`+ engine.onVarsInitialized(FXGL.getWorldProperties())`
	`342`	`+`
`341`	`343`	`app.initGame();`
`342`	`344`	`}`
`343`	`345`