feat: added asset loader loadCutscene shortcut

AlmasB · AlmasB · commit 13635223e9fa · 2023-12-28T12:29:40.000Z
diff --git a/fxgl-samples/src/main/java/intermediate/CutsceneSample.java b/fxgl-samples/src/main/java/intermediate/CutsceneSample.java
@@ -4,43 +4,34 @@
  * See LICENSE for details.
  */
 
-package sandbox.cutscene;
+package intermediate;
 
 import com.almasb.fxgl.app.GameApplication;
 import com.almasb.fxgl.app.GameSettings;
-import com.almasb.fxgl.cutscene.Cutscene;
 import javafx.scene.input.KeyCode;
-import javafx.scene.paint.Color;
 
 import static com.almasb.fxgl.dsl.FXGL.*;
 
 /**
+ * Shows how to load and start cutscenes.
+ * For cutscene format, see https://github.com/AlmasB/FXGL/wiki/Narrative-and-Dialogue-System-(FXGL-11)#cutscenes
+ *
  * @author Almas Baimagambetov (almaslvl@gmail.com)
  */
 public class CutsceneSample extends GameApplication {
     @Override
-    protected void initSettings(GameSettings settings) {
-        settings.setWidth(1280);
-        settings.setHeight(720);
-    }
+    protected void initSettings(GameSettings settings) { }
 
     @Override
     protected void initInput() {
-        onKeyDown(KeyCode.F, "test", () -> {
-            // TODO: loadCutscene shortcut?
-            var lines = getAssetLoader().loadText("example_cutscene1.txt");
-
-            var cutscene = new Cutscene(lines);
+        // press F to see the cutscene
+        onKeyDown(KeyCode.F, () -> {
+            var cutscene = getAssetLoader().loadCutscene("example_cutscene1.txt");
 
             getCutsceneService().startCutscene(cutscene);
         });
     }
 
-    @Override
-    protected void initGame() {
-        getGameScene().setBackgroundColor(Color.LIGHTGRAY);
-    }
-
     public static void main(String[] args) {
         launch(args);
     }
diff --git a/fxgl/src/main/kotlin/com/almasb/fxgl/app/services/FXGLAssetLoaderService.kt b/fxgl/src/main/kotlin/com/almasb/fxgl/app/services/FXGLAssetLoaderService.kt
@@ -12,6 +12,7 @@ import com.almasb.fxgl.core.asset.AssetLoaderService
 import com.almasb.fxgl.core.asset.AssetType
 import com.almasb.fxgl.core.asset.AssetType.*
 import com.almasb.fxgl.core.collection.PropertyMap
+import com.almasb.fxgl.cutscene.Cutscene
 import com.almasb.fxgl.cutscene.dialogue.DialogueGraph
 import com.almasb.fxgl.cutscene.dialogue.DialogueGraphSerializer
 import com.almasb.fxgl.cutscene.dialogue.SerializableGraph
@@ -288,6 +289,20 @@ class FXGLAssetLoaderService : AssetLoaderService() {
         return DialogueGraphSerializer.fromSerializable(graph)
     }
 
+    /**
+     * @return [Cutscene] with given [name] from "/assets/text", e.g. cutscene.txt
+     */
+    fun loadCutscene(name: String): Cutscene {
+        return Cutscene(loadText(name))
+    }
+
+    /**
+     * @return [Cutscene] with given [url]
+     */
+    fun loadCutscene(url: URL): Cutscene {
+        return Cutscene(loadText(url))
+    }
+
     /**
      * Loads text file with given [name] from /assets/text/
      * into List<String> where each element represents a line in the file.
