feat: allow selecting difficulty in the gameplay menu

Author: jamesmosey

fxgl-samples/src/main/java/intermediate/MenuSample.java

@@ -29,7 +29,7 @@ protected void initSettings(GameSettings settings) {
         settings.setMainMenuEnabled(true);
         settings.setGameMenuEnabled(true);
         settings.setFullScreenAllowed(true);
-        settings.setEnabledMenuItems(EnumSet.of(MenuItem.EXTRA));
+        settings.setEnabledMenuItems(EnumSet.of(MenuItem.DIFFICULTY, MenuItem.EXTRA));
         settings.getCredits().addAll(Arrays.asList(
                 "Short Name - Lead Programmer",
                 "LongLongLongLongLongLongLong Name - Programmer",

fxgl/src/main/kotlin/com/almasb/fxgl/app/Settings.kt

@@ -60,7 +60,12 @@ enum class MenuItem {
     /**
      * Enables ONLINE (multiplayer).
      */
-    ONLINE
+    ONLINE,
+
+    /**
+     * Enables DIFFICULTY -> EASY, MEDIUM, HARD, NIGHTMARE
+     */
+    DIFFICULTY,
 }
 
 /**

fxgl/src/main/kotlin/com/almasb/fxgl/app/scene/FXGLDefaultMenu.kt

@@ -16,6 +16,7 @@ import com.almasb.fxgl.dsl.*
 import com.almasb.fxgl.dsl.FXGL.Companion.animationBuilder
 import com.almasb.fxgl.dsl.FXGL.Companion.random
 import com.almasb.fxgl.dsl.FXGL.Companion.texture
+import com.almasb.fxgl.gameplay.GameDifficulty
 import com.almasb.fxgl.input.Input
 import com.almasb.fxgl.input.InputModifier
 import com.almasb.fxgl.input.Trigger
@@ -258,6 +259,12 @@ open class FXGLDefaultMenu(type: MenuType) : FXGLMenu(type) {
         itemOptions.setChild(createOptionsMenu())
         box.add(itemOptions)
 
+        if (enabledItems.contains(MenuItem.DIFFICULTY)) {
+            val itemDifficulty = MenuButton("menu.difficulty")
+            itemDifficulty.setMenuContent({ createDifficultyMenu() })
+            box.add(itemDifficulty)
+        }
+
         if (enabledItems.contains(MenuItem.EXTRA)) {
             val itemExtra = MenuButton("menu.extra")
             itemExtra.setChild(createExtraMenu())
@@ -297,6 +304,12 @@ open class FXGLDefaultMenu(type: MenuType) : FXGLMenu(type) {
         itemOptions.setChild(createOptionsMenu())
         box.add(itemOptions)
 
+        if (enabledItems.contains(MenuItem.DIFFICULTY)) {
+            val itemDifficulty = MenuButton("menu.difficulty")
+            itemDifficulty.setMenuContent({ createDifficultyMenu() })
+            box.add(itemDifficulty)
+        }
+
         if (enabledItems.contains(MenuItem.EXTRA)) {
             val itemExtra = MenuButton("menu.extra")
             itemExtra.setChild(createExtraMenu())
@@ -343,6 +356,30 @@ open class FXGLDefaultMenu(type: MenuType) : FXGLMenu(type) {
         return MenuBox(itemGameplay, itemControls, itemVideo, itemAudio, btnRestore)
     }
 
+    private fun createDifficultyMenu(): MenuContent {
+        val difficultyBox = getUIFactoryService().newChoiceBox(
+            FXCollections.observableArrayList(GameDifficulty.entries)
+        )
+
+        difficultyBox.styleClass.add("fxgl-difficulty-choice-box")
+
+        difficultyBox.value = getSettings().gameDifficulty
+        getSettings().gameDifficultyProperty().bindBidirectional(difficultyBox.valueProperty())
+
+        difficultyBox.valueProperty().addListener { _, _, _ ->
+            switchMenuContentTo(EMPTY)
+        }
+
+        val row = HBox(
+            25.0,
+            getUIFactoryService().newText(localizedStringProperty("menu.difficulty").concat(":")),
+            difficultyBox
+        )
+        row.alignment = Pos.CENTER
+
+        return MenuContent(row)
+    }
+
     private fun createExtraMenu(): MenuBox {
         log.debug("createExtraMenu()")
 

fxgl/src/main/resources/fxglassets/ui/css/fxgl_dark.css

@@ -309,6 +309,40 @@
 }
 
 
+/*
+ * Styling for the difficulty choice box
+ */
+.fxgl-difficulty-choice-box {
+    -fx-background-color: rgba(0, 0, 0, 0.35);
+    -fx-background-radius: 4;
+    -fx-background-insets: 0;
+    -fx-border-color: rgba(255, 255, 255, 0.25);
+    -fx-border-radius: 4;
+    -fx-font-size: 18px;
+}
+
+.fxgl-difficulty-choice-box:hover,
+.fxgl-difficulty-choice-box:focused,
+.fxgl-difficulty-choice-box:focused:hover,
+.fxgl-difficulty-choice-box:armed {
+    -fx-background-color: rgba(0, 0, 0, 0.45);
+    -fx-background-radius: 4;
+    -fx-background-insets: 0;
+    -fx-border-color: rgba(255, 255, 255, 0.35);
+}
+
+.fxgl-difficulty-choice-box .label {
+    -fx-text-fill: white;
+    -fx-background-color: transparent;
+}
+
+.fxgl-difficulty-choice-box .context-menu {
+    -fx-background-color: rgba(20, 20, 20, 0.9);
+}
+
+.fxgl-difficulty-choice-box .menu-item:focused {
+    -fx-background-color: rgba(255, 255, 255, 0.15);
+}
 
 
 /*