feat: added DSL support for loading common assets from URL, closes #971

AlmasB · AlmasB · commit 5f12483c3731 · 2022-01-07T09:55:25.000Z
diff --git a/fxgl/src/main/kotlin/com/almasb/fxgl/dsl/FXGL.kt b/fxgl/src/main/kotlin/com/almasb/fxgl/dsl/FXGL.kt
@@ -69,6 +69,7 @@ import javafx.scene.input.MouseButton
 import javafx.scene.text.Text
 import javafx.stage.Stage
 import javafx.util.Duration
+import java.net.URL
 import java.util.*
 import java.util.concurrent.Callable
 import java.util.function.BiConsumer
@@ -331,10 +332,18 @@ class FXGL private constructor() { companion object {
 
     @JvmStatic fun image(assetName: String, width: Double, height: Double): Image = texture(assetName, width, height).image
 
+    @JvmStatic fun image(url: URL): Image = getAssetLoader().loadImage(url)
+
+    @JvmStatic fun image(url: URL, width: Double, height: Double): Image = texture(url, width, height).image
+
     @JvmStatic fun texture(assetName: String): Texture = getAssetLoader().loadTexture(assetName)
 
     @JvmStatic fun texture(assetName: String, width: Double, height: Double): Texture = getAssetLoader().loadTexture(assetName, width, height)
 
+    @JvmStatic fun texture(url: URL): Texture = getAssetLoader().loadTexture(url)
+
+    @JvmStatic fun texture(url: URL, width: Double, height: Double): Texture = getAssetLoader().loadTexture(url, width, height)
+
     @JvmStatic fun text(assetName: String) = getAssetLoader().loadText(assetName)
 
 /* AUDIO */
@@ -349,6 +358,16 @@ class FXGL private constructor() { companion object {
         return music
     }
 
+    /**
+     * @param url url to the background music file to loop
+     * @return the music object that is played in a loop
+     */
+    @JvmStatic fun loopBGM(url: URL): Music {
+        val music = getAssetLoader().loadMusic(url)
+        getAudioPlayer().loopMusic(music)
+        return music
+    }
+
     /**
      * Convenience method to play music/sound given its filename.
      *
@@ -370,6 +389,29 @@ class FXGL private constructor() { companion object {
         }
     }
 
+    /**
+     * Convenience method to play music/sound given its filename.
+     *
+     * @param url name of the music file
+     */
+    @JvmStatic fun play(url: URL) {
+        val assetName = url.toExternalForm()
+
+        when {
+            assetName.endsWith(".wav") -> {
+                val sound = getAssetLoader().loadSound(url)
+                getAudioPlayer().playSound(sound)
+            }
+            assetName.endsWith(".mp3") -> {
+                val music = getAssetLoader().loadMusic(url)
+                getAudioPlayer().playMusic(music)
+            }
+            else -> {
+                throw IllegalArgumentException("Unsupported audio format: $assetName")
+            }
+        }
+    }
+
 /* INPUT */
 
     private var actionCounter = 0
